Get Users
GET {{baseUrl}}/1/users/?ids=nostrud cillum sed in&sort_by=asc&sort_order=asc
Bulk variant of the Get User endpoint. Returns an object with the passed in user IDs or emails as properties and user objects as values. If a user ID or email is not found, then its value will be an error message instead.
Request Params
Key | Datatype | Required | Description |
---|---|---|---|
ids | string | (Required) A comma-separated list of either emails or user IDs. Must not | |
exceed 1000 emails or user IDs. Note: Email-based lookups return | |||
information about a user from only the same company as the caller. | |||
That’s the company of the person who created the API key | |||
associated with your provided access token. | |||
sort_by | string | Determines which field to sort the shared_folder_ids | |
and group_folder_ids lists by, if they're included in the | |||
response. | |||
sort_order | string | Determines what order to sort the shared_folder_ids | |
and group_folder_ids lists by, if they're included in the | |||
response. asc sorts the lists in ascending order while desc | |||
sorts the lists in descending order. | |||
RESPONSES
status: OK
{"UTUAEAiZl6B":{"name":"John Doe","emails":["john.doe@example.com"],"created_usec":1631916773945747,"is_robot":false,"affinity":0,"disabled":false},"jane.doe@example.com":{"name":"Jane Doe","is_robot":false,"affinity":0.36}}