GET /api/v2/users/search
Returns an array of users who meet the search criteria.
Returns up to 100 records per page to a maximum of 10,000 records per query. See Using offset pagination.
Pagination
- Offset pagination only
See Using Offset Pagination.
Allowed For
- Agents
Servers
- https://{subdomain}.{domain}.com
Query parameters
| Name | Type | Required | Description |
|---|---|---|---|
page |
Integer | No |
Page number for offset-based pagination (non-negative integer). |
external_id |
String | No |
The |
query |
String | No |
The |
include |
String | No |
A comma-separated list of sideloads to include in the response. |
per_page |
Integer | No |
Number of records to return per page. Note: Default and maximum values vary by endpoint. Check endpoint-specific documentation for limits. |
How to start integrating
- Add HTTP Task to your workflow definition.
- Search for the API you want to integrate with and click on the name.
- This loads the API reference documentation and prepares the Http request settings.
- Click Test request to test run your request to the API and see the API's response.