List members
The organization's users and its pending invites in one list, each limited to the ones the caller may see: every user and invite for an owner, otherwise the caller themselves, members below their role, and invites they created.
User API key (Bearer scp_u_...). Create in Platform > API Keys.
In: header
Query Parameters
Only members in one of these statuses. Repeat for several.
Only members with one of these roles. Repeat for several.
Only users assigned one of these sites. Repeat for several.
true also returns admins and owners, who reach every site. Set on its own it returns only
those.
Only users signing in one of these ways (<provider>, <provider>+password, password,
none). Repeat for several.
Only invites created by one of these users. Repeat for several.
Only users whose email is verified (true), unverified (false), or both (repeat it).
Sent empty, matches none.
Free-text search. Case-insensitive substring match against the email.
Primary ordering field (used for grouping). Always sorts ASC to keep groups together.
Secondary ordering field (sorting within groups or standalone sort).
Direction for order_by field (group_by always uses ASC).
Maximum number of results to return (1-1000, default: 50). Use 0 for no limit.
Number of results to skip. Default: 0.
Response Body
application/json
curl -X GET "https://example.com/api/v1/users/members"{
"data": [
{
"auth_method": "string",
"data": {
"created_at": "2019-08-24T14:15:22Z",
"email": "[email protected]",
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"organization_id": "7c60d51f-b44e-4682-87d6-449835ea4de6",
"permissions": "Owner",
"site_ids": [
"ab580781-02e2-4a18-ac1b-8fc9be2f4ad4"
],
"updated_at": "2019-08-24T14:15:22Z",
"display_settings": {
"clock": "browser_default",
"date_order": "browser_default",
"table_density": "comfortable",
"time_zone": null,
"timestamps": "relative",
"week_start": "monday"
},
"email_settings": {
"discovery_digest": true,
"daemon_alerts": true,
"product_onboarding": true,
"product_updates": true,
"trial_and_usage": true
},
"email_verification_required": true,
"email_verified": true,
"has_password": true,
"oidc_linked_at": "2019-08-24T14:15:22Z",
"oidc_provider": "string",
"terms_acceptance_required": true
},
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"status": "pending",
"type": "user"
}
],
"meta": {
"api_version": 1,
"pagination": {
"has_more": true,
"limit": 50,
"offset": 0,
"total_count": 142
},
"server_version": "0.19.6"
},
"success": true,
"error": "string"
}Product names and logos are trademarks of their respective owners. See credits.