GET
/api/organizations/{organization_id}/membersAuthenticatedList 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_membersOrganizationsAuthentication & permissionsAuthenticated
Any authenticated user
- Accepted credentials
- Auth server session (refresh token cookie)
cookie "refresh_token_<auth_server_app_id>" - Access token (cookie)
cookie "access_token_<auth_server_app_id>" - Access token (Bearer)
Authorization: Bearer <JWT>
- Auth server session (refresh token cookie)
- Who may call
- Any authenticated user
- Notes
- The caller must be a member of the organization or a platform administrator.
Path parameters
| Name | Type | Description |
|---|---|---|
| organization_id* | string | Organization id (URL-safe slug) |
Responses
application/json
| Property | Type | Description |
|---|---|---|
| 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: |
| membership_created_at* | number | Unix epoch milliseconds the membership was created |
| email* | string (email) | |
| email_verified | boolean | |
| admin | boolean | Whether the member is a platform administrator |
| disabled | boolean | 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>'