Kustomer API

Getting access, Developing, Testing

Back to Kustomer

Get Companies

Retrieves all companies. You can optionally filter this list by 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 external ID and filter query params are both present, the filter param is ignored.

Output

type: object properties: meta: type: object properties: pageSize: type: string page: type: string data: type: array items: type: object properties: type: type: string id: type: string attributes: type: object properties: name: type: string extenalId: type: string createdAt: type: string updatedAt: type: string modifiedAt: type: string tags: type: array items: type: string relationships: type: object properties: org: type: object properties: links: type: object properties: self: type: string data: type: object properties: type: type: string id: type: string createdBy: type: object properties: links: type: object properties: self: type: string data: type: object properties: type: type: string id: type: string modifiedBy: type: object properties: links: type: object properties: self: type: string data: type: object properties: type: type: string id: type: string links: type: object properties: self: type: string links: type: object properties: self: type: string first: type: string prev: type: string next: type: string