This page documents the canonical HTTP contract for this endpoint.
Organization scope
The organization comes from the authenticated session or developer API key. There is no organization-ID parameter for reading another organization's users.
This endpoint requires users:read for developer API keys. Results exclude deleted users and users without an email, are sorted by email then user ID, and include total and nextOffset for paging. The API defaults to all matching users when limit is omitted.
Use exact user IDs
Match the intended teammate by name or email in the response, then copy users[].user_id into fields such as assignedToUserId or assignmentPlan[].assigneeUserId. Do not put current_user, me, a name, or an email address in an ID field. If multiple people match, ask which person is intended.
For direct sequence enrollment, omitting the assignee uses the resolved requesting actor; developer-key calls resolve that actor from the key owner unless a supported actor override is supplied. This is different from the Lead IDs being enrolled.
Users, leads, and sender accounts are different identities
- User IDs identify your teammates and task owners.
leadIdsidentify CRM people receiving the sequence.- Mailbox and LinkedIn sender account IDs come from List sender accounts, not this endpoint.
Reading this catalog does not invite users, change permissions, enroll leads, or authorize sending. The response includes user permissions, allowance, and access flags. Known exact IDs do not require another lookup.
Query parameters
query· optionalstring
Case-insensitive literal substring search across user_id, email, first_name, and last_name. Maximum length 200.
limit· optionalinteger
Maximum users to return, from 1 to 1000. Omitted means return all matching users.
offset· optionalinteger
Zero-based result offset; minimum 0. Default: 0.
| Name | Type | Description |
|---|---|---|
| query | string | Case-insensitive literal substring search across user_id, email, first_name, and last_name. Maximum length 200. |
| limit | integer | Maximum users to return, from 1 to 1000. Omitted means return all matching users. |
| offset | integer | Zero-based result offset; minimum 0. Default: 0. |
Errors
| Status | Meaning |
|---|---|
| 401 | Authentication failed or user/organization context is unavailable. |
| 403 | Developer API key lacks the users:read scope. |
| 422 | Invalid query, limit, or offset value. |
| 500 | Failed to fetch organization users. |
