Organizations
Search Organizations
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.
get/api/v2/organizations/search
Response
Success response