GET/desk/api/v2/companies.json
Get a paginated list of companies.
The following values are allowed in the filter query parameter:
- id
- name
- details
- industry
- website
- avatarPath
- permission
- kind
- customersCount
- createdAt
- updatedAt
- deletedAt
- createdBy
- updatedBy
- deletedBy
- state
The following values are allowed in the orderBy query parameter:
- id
- name
- details
- industry
- website
- avatarPath
- permission
- kind
- customersCount
- createdAt
- updatedAt
- deletedAt
- createdBy
- updatedBy
- deletedBy
- state
- domains.id
- domains.name
- inboxes.id
- website
- address
- address.country
- customersCount
- phones
- name
Responses
- Code
- 200
- Type
- object
- Schema
- Description
- 200 OK
CompaniesAPIBody is the request/response format for bulk company API calls
- Code
- 400
- Type
- object
- Schema
- Description
- 400 Bad Request
Validator hold the validation errors. Typically you shouldn't create this directly but use the New() function.
200 OK
CompaniesAPIBody
{ "companies": [ { "address": { "delete": true, "id": 0, "meta": {}, "type": 0 }, "avatarPath": "string", "createdAt": "2024-07-26T20:26:26.473Z", "createdBy": { "delete": true, "id": 0, "meta": {}, "type": 0 }, "customers": [