GET/desk/api/v2/customers.json
Get a paginated list of customers.
The following values are allowed in the filter query parameter:
- addMethod
- address
- avatarURL
- createdAt
- createdBy
- deletedAt
- externalId
- facebookURL
- firstName
- id
- jobTitle
- lastName
- linkedinURL
- mobile
- organization
- password
- permission
- phone
- state
- trusted
- twitterHandle
- updatedAt
- updatedBy
- verifiedEmail
- welcomeEmailSent
The following values are allowed in the orderBy query parameter:
-
addMethod
-
address
-
avatarURL
-
companies.name
-
contacts.value
-
createdAt
-
createdBy
-
deletedAt
-
email
-
externalId
-
facebookURL
-
firstName
-
id
-
jobTitle
-
lastName
-
linkedinURL
-
mobile
-
organization
-
password
-
permission
-
phone
-
state
-
trusted
-
twitterHandle
-
updatedAt
-
updatedBy
-
verifiedEmail
-
welcomeEmailSent
The following values are allowed in the [includes](https://apidocs.teamwork.com/guides/desk/relationships-and-includes) query parameter: -
companies
-
contacts
-
customerwelcomeemails
-
users
-
all
Responses
- Code
- 200
- Type
- object
- Schema
- Description
- 200 OK
CustomersAPIBody 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
CustomersAPIBody
{ "customers": [ { "addMethod": "string", "address": "string", "avatarURL": "string", "company": { "delete": true, "id": 0, "meta": { "additionalProp": "Unknown Type: any" }, "type": 0 }, "contacts": [ { "delete": true, "id": 0,