As an Organization Admin, list the users in your organization.
| Time | Status | User Agent | |
|---|---|---|---|
Retrieving recent requests… | |||
Authenticate with an Organization Admin User API key, sent in the skyfire-api-key header. Keys belonging to callers whose organization role is ADMIN are accepted; a MEMBER key, or any Agent API key, is rejected with 401.
Only users in your own organization are returned. The organization is derived from the API key, so there is no organization parameter.
Each user is returned with the agents they own and, for each agent, its accounts.
Pagination
Results are ordered by email ascending and paginated by cursor, not by offset.
When more results exist, the response includes a nextPageCursor and the response carries a Link header pointing at the next page:
Link: <https://api.skyfire.xyz/api/v1/organizations/users?pageCursor=ada%40example.com>; rel="next"Pass that value back as pageCursor to fetch the following page. When nextPageCursor is absent, you have reached the last page.
pageSize defaults to 100 and may not exceed 1000. A value below 1 or above 1000 returns 400.
Filtering
filter is a JSON object encoded as a string in the query, so it must be URL-encoded. For example, filter={"active":true} is sent as:
GET /api/v1/organizations/users?filter=%7B%22active%22%3Atrue%7D| Field | Type | Behaviour |
|---|---|---|
id | string | Exact match on user ID. A value that is not a valid UUID returns an empty list rather than an error. |
email | string | Substring match on email address. |
identifier | string | Substring match on email, unless the value is a valid UUID, in which case it matches on user ID. |
active | boolean | Filter by whether the user is active. |
admin | boolean | true returns Organization Admins; false returns standard members. |
orgMemberRole | string | Exact match on organization role. |
Filters combine with AND. filter must be valid JSON.