GET/api/organizations/{organization_id}/membersAuthenticated

List an organization's members

Lists every member of the organization with their role and account data. Members of the organization and platform administrators may call it.

operationId get_api_organizations_organization_id_membersOrganizations

Authentication & permissionsAuthenticated

Any authenticated user

Accepted credentials
Who may call
Any authenticated user
Notes
The caller must be a member of the organization or a platform administrator.

Path parameters

NameTypeDescription
organization_id*string

Organization id (URL-safe slug)

Responses

application/json
PropertyTypeDescription
success*true
message*string
data*object
members*OrganizationMember[]
membership_declaration_id*string

Id of the membership row

organization_id*string

minLength: 4maxLength: 32pattern: ^[a-z][a-z0-9_-]+$

uid*string (uuid)

The member's user id

role*string

Membership role in the organization: owner, member, or admin (the virtual role platform administrators hold in the owner organization).

membership_created_at*number

Unix epoch milliseconds the membership was created

email*string (email)
email_verifiedboolean
adminboolean

Whether the member is a platform administrator

disabledboolean

Whether the member's account is disabled

JSONExample
"success"true
"message""string"
"data"
"members"

Example request

bashcurl
curl -X GET 'https://auth.schemavaults.com/api/organizations/<organization_id>/members' \
  -b 'refresh_token_<auth_server_app_id>=<value>'
GET /api/organizations/{organization_id}/members | SchemaVaults Auth API