GET/desk/api/v2/customers.json

Get a paginated list of customers.

The following values are allowed in the filter query parameter:

  • id
  • firstName
  • lastName
  • organization
  • verifiedEmail
  • permission
  • addMethod
  • linkedinURL
  • facebookURL
  • twitterHandle
  • numTickets
  • jobTitle
  • phone
  • mobile
  • address
  • externalId
  • avatarURL
  • trusted
  • welcomeEmailSent
  • password
  • createdAt
  • updatedAt
  • deletedAt
  • createdBy
  • updatedBy
  • state

The following values are allowed in the orderBy query parameter:

  • companies.name
  • email
  • contacts.value
  • id
  • firstName
  • lastName
  • organization
  • verifiedEmail
  • permission
  • addMethod
  • linkedinURL
  • facebookURL
  • twitterHandle
  • numTickets
  • jobTitle
  • phone
  • mobile
  • address
  • externalId
  • avatarURL
  • trusted
  • welcomeEmailSent
  • password
  • createdAt
  • updatedAt
  • deletedAt
  • createdBy
  • updatedBy
  • state

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.

Examples

200 OK

CustomersAPIBody
{  "customers": [    {      "addMethod": "string",      "address": "string",      "avatarURL": "string",      "company": {        "delete": true,        "id": 0,        "meta": {},        "type": 0      },      "contacts": [        {          "delete": true,          "id": 0,          "meta": {},          "type": 0