latestOpenAPI 3.0.02026-08-1284111344.5 KB

14666f4db0f8

Clients

Get a client by ID

Returns a single client including full contact details, service and billing addresses, tags, ad group, notes, additional contacts, and custom field values.

get/v2/clients/{id}

Path parameters

idstring required

Example:CL-OvmDp2yvv1yqMwRl

The client ID (prefix CL-).

Headers

Authorizationstring required

Example:Bearer <token>

Bearer Token

Response

The requested client.

idstring

The ID of the client (prefix CL-).

serialIdnumber

The serial ID of the client.

firstNamestring

The first name of the client.

lastNamestring

The last name of the client.

fullNamestring

The full name of the client.

companyNamestring

The company name of the client.

emailstring

The email address of the client.

primaryExtstring

The primary phone extension of the client.

primaryPhonestring

The primary phone of the client.

secondaryExtstring

The secondary phone extension of the client.

secondaryPhonestring

The secondary phone of the client.

countrystring

The country of the client.

statestring

The state of the client.

citystring

The city of the client.

zipcodestring

The zipcode of the client.

unitstring

The unit of the client.

addressstring

The address of the client.

serviceAddressstring

The service address of the client.

billingAddressstring

The billing address of the client.

allowBillingboolean

Whether the client allows billing.

createdstring

The creation date of the client.

Example response

{
  "id": "CL-OvmDp2yvv1yqMwRl",
  "serialId": 1023,
  "firstName": "John",
  "lastName": "Doe",
  "fullName": "John Doe",
  "companyName": "John Doe Inc.",
  "email": "john.doe@example.com",
  "primaryExt": "123",
  "primaryPhone": "1234567890",
  "secondaryExt": "456",
  "secondaryPhone": "1234567890",
  "country": "USA",
  "state": "NY",
  "city": "New York",
  "zipcode": "10001",
  "unit": "100",
  "address": "123 Main St",
  "serviceAddress": "123 Main St, New York, NY 10001",
  "billingAddress": "123 Main St, New York, NY 10001",
  "allowBilling": true,
  "adGroup": {
    "id": "AG-71b8d7310acbf8cc",
    "name": "Ad Group 1"
  },
  "tags": [
    {
      "id": "TAG-211d1676f4b90c40",
      "name": "Tag 1",
      "color": "#edce4c"
    }
  ],
  "parentClient": {
    "id": "CL-OvmDp2yvv1yqMwRl",
    "serialId": 1023,
    "firstName": "John",
    "lastName": "Doe",
    "fullName": "John Doe",
    "companyName": "John Doe Inc.",
    "email": "john.doe@example.com",
    "primaryExt": "123",
    "primaryPhone": "1234567890",
    "secondaryExt": "456",
    "secondaryPhone": "1234567890",
    "country": "USA",
    "state": "NY",
    "city": "New York",
    "zipcode": "10001",
    "unit": "100",
    "address": "123 Main St",
    "serviceAddress": "123 Main St, New York, NY 10001",
    "billingAddress": "123 Main St, New York, NY 10001",
    "allowBilling": true
  },
  "clientContacts": [
    {
      "id": "CLC-211d1676f4b90c40",
      "firstName": "John",
      "lastName": "Doe",
      "fullName": "John Doe",
      "email": "john.doe@example.com",
      "primaryPhone": "1234567890",
      "secondaryPhone": "1234567890",
      "country": "USA",
      "state": "NY",
      "city": "New York",
      "zipcode": "10001",
      "address": "123 Main St",
      "role": "Property Manager",
      "note": "Prefers contact by email."
    }
  ],
  "notes": [
    {
      "id": "CLN-211d1676f4b90c40",
      "note": "Customer requested a follow-up call.",
      "techName": "John Doe",
      "createdAt": "2021-01-01 00:00:00"
    }
  ],
  "customFields": [
    {
      "id": "CF-eYLPK7198xVp6Z8q",
      "fieldName": "Custom Field 1",
      "value": "John Doe"
    }
  ],
  "created": "2026-01-01 00:00:00"
}