GET/desk/api/v2/customers/{id}.json

Get a single customer by id.

The following values are allowed in the includes query parameter:

  • companies
  • contacts
  • customerwelcomeemails
  • users
  • all

Path Params

  • Name
    id
    Type
    integer
    required
    Description

Responses

  • Code
    200
    Type
    object
    Schema
    Description
    200 OK
    CustomerAPIBody is the request/response format for the API
  • 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.
  • Code
    404
    Type
    object
    Schema
    Description
    404 Not Found
    Error represents an occurrence of an error in the API.

Examples

200 OK

CustomerAPIBody
{  "customer": {    "addMethod": "string",    "address": "string",    "avatarURL": "string",    "company": {      "delete": true,      "id": 0,      "meta": {        "additionalProp": "Unknown Type: any"      },      "type": 0    },    "contacts": [      {        "delete": true,        "id": 0,        "meta": {
Download Swagger