get https://api.kustomerapp.com/v1/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
andfilter
query params, the request ignores both query params.