List users
Returns a paginated list of users in your workspace, sorted by creation date with the most recent first.
GET
https://api.acme.com/v1/users
Request
cURL
curl https://api.acme.com/v1/users?limit=20 \
-H "Authorization: Bearer sk_live_..." \
-H "Content-Type: application/json"Query parameters
| Parameter | Type | Description |
|---|---|---|
limit
|
integer | Number of users to return, 1–100. Defaults to 20. |
starting_after
|
string | Cursor for pagination — the ID of the last user on the previous page. |
email
|
string | Filter the list to users with this exact email address. |
status
|
enum | One of "active", "invited", or "suspended". |
Response
200 OK
application/json
{
"object": "list",
"has_more": true,
"data": [
{
"id": "usr_9f2b1c",
"object": "user",
"email": "maria@acme.com",
"name": "Maria Kim",
"status": "active",
"created_at": "2026-05-12T09:24:11Z"
},
{
"id": "usr_4e8a7d",
"object": "user",
"email": "tom@acme.com",
"name": "Tom Walker",
"status": "invited",
"created_at": "2026-06-02T14:03:45Z"
}
]
}Errors
401
Missing or invalid API key. Check the Authorization header.
403
The key is valid but lacks the users:read scope.
429
Rate limit exceeded — retry after the interval in Retry-After.