List users
Returns the workspace’s users as a paginated JSON:API list. Each user includes their roles.
API key authentication. Send your key in the Authorization header as: api-key <your-api-key>.
In: header
Path Parameters
The workspace slug — the {slug} segment of your Clarify workspace URL.
Query Parameters
Offset pagination, e.g. page[offset]=0&page[limit]=100.
Default
{ "offset": 0, "limit": 500}Sort order, e.g. sortOrder[column]=_created_at&sortOrder[dir]=DESC.
Response Body
application/json
curl -X GET "https://example.com/workspaces/string/users"{ "links": { "next": null, "prev": null }, "meta": { "total_records": 1, "total_pages": 1, "offset": 0, "limit": 500 }, "data": [ { "type": "user", "id": "7d4e2f9a-1b3c-4d5e-8f6a-9c0b2d4e6f81", "attributes": { "_id": "7d4e2f9a-1b3c-4d5e-8f6a-9c0b2d4e6f81", "name": { "first_name": "Alex", "last_name": "Rivera" }, "roles": { "items": [ "member" ] }, "email": "alex@acme.com", "profile_picture": "https://storage.clarify.ai/avatars/acme/alex-rivera.png", "last_active_at": "2026-02-01T17:45:00.000Z", "_created_at": "2026-01-15T09:30:00.000Z", "_updated_at": "2026-02-01T17:45:00.000Z" } } ]}Get a user
Returns a single workspace user as a JSON:API resource, including their roles and the time they were last active.
Remove a user
Removes a user from the workspace: they lose access, their campaigns stop, and their connected mailboxes disconnect. Their records stay in the workspace. The last user and the last admin cannot be removed.