GET/desk/api/v2/companies.json
Get a paginated list of companies.
The following values are allowed in the filter query parameter:
- avatarPath
- createdAt
- createdBy
- customersCount
- deletedAt
- deletedBy
- details
- id
- industry
- kind
- name
- permission
- state
- updatedAt
- updatedBy
- website
The following values are allowed in the orderBy query parameter:
-
address
-
address.country
-
avatarPath
-
createdAt
-
createdBy
-
customersCount
-
customersCount
-
deletedAt
-
deletedBy
-
details
-
domains.id
-
domains.name
-
email
-
email
-
id
-
inboxes.id
-
industry
-
kind
-
name
-
name
-
permission
-
phones
-
state
-
updatedAt
-
updatedBy
-
website
-
website
The following values are allowed in the [includes](https://apidocs.teamwork.com/guides/desk/relationships-and-includes) query parameter: -
addresses
-
customers
-
domains
-
phones
-
sociallinks
-
all
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": { "additionalProp": "Unknown Type: any" }, "type": 0 }, "avatarPath": "string", "createdAt": "2024-12-30T11:52:06.614Z", "createdBy": { "delete": true, "id": 0, "meta": { "additionalProp": "Unknown Type: any"