Companies
Get companies
Retrieves all companies. You can optionally filter this list by the company name or the unique external company ID.
Any one of the following roles is required for this endpoint:
| Legacy Role | Equivalent Permission Set Role |
|---|---|
| org.user.company.read | org.permission.company.read |
Note
If you use both the externalId and filter query params, the request ignores both query params.
get/companies
Request
- Base URL: https://api.kustomerapp.com/v1
- URL: https://api.kustomerapp.com/v1/companies
- Auth: httpBearer (a scheme the document does not define)
Query parameters
externalIdstring
Example:foobar
Unique external ID of the company
filterstring
Example:foucault
Company name to use as a filter
Response
OK
Changes
No recorded changes to this operation across all 1 revision of this API.