GET /api/v2/organizations/search
Returns an array of organizations matching the criteria. You may search by an organization's external_id or name, but not both:
Searching by external_id
If you set the external_id value of an organization to associate it to an external record, you can use it to search for the organization.
For an organization to be returned, its external_id must exactly match the value provided (case insensitive).
Searching by name
For an organization to be returned, its name must exactly match the value provided (case insensitive).
Allowed For:
- Admins
- Agents assigned to a custom role with permissions to add or modify organizations (Enterprise only)
See Creating custom agent roles in the Support Help Center.
Servers
- https://{subdomain}.{domain}.com
Query parameters
| Name | Type | Required | Description |
|---|---|---|---|
external_id |
Integer | No |
The external id of an organization |
name |
String | No |
The name of an organization |
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.