GET /api/v2/users/search
Searches for users matching a specific criteria. It matches phone numbers, emails, or name. Optionally, it accepts filters to reduce the amount of final results.
- The
cursorvalue is provided in the response, and can be passed as a parameter to retrieve subsequent pages of results.
Rate limit: 1200 per minute.
Servers
- https://dialpad.com/
- https://sandbox.dialpad.com/
Query parameters
| Name | Type | Required | Description |
|---|---|---|---|
query |
String | Yes |
A string that will be matched against user information. For phone numbers in e164 format, it is recommended to URL-encode the model term. |
filter |
String | No |
Only supported filter: name_only (true/false). If true, query matches against name only. Format: filter=[name_only=true]. |
cursor |
String | No |
A token used to return the next page of a previous request. Use the cursor provided in the previous response. |
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.