Sign in
Contact

Lookup contact

Find a contact by phone number or email.

get/contacts/lookup

Query parameters

phonestring

Phone number in E.164 format to lookup.

emailstring

Email address to lookup.

Response

Contact found.

idstring uuid

Unique identifier for the contact.

customer_idstring uuid

Unique identifier of the associated customer.

first_namestring

First name of the contact.

last_namestring

Last name of the contact.

display_namestring

Display name of the contact.

companystring

Company name associated with the contact.

job_titlestring

Job title of the contact.

source'manual' | 'import' | 'api' | 'sync'

Source of the contact.

external_idstring

External identifier for the contact.

notesstring

Free-form notes about the contact. May include call summaries, preferences, or special instructions.

tag_idsstring[]

List of tag IDs associated with the contact.

tm_createstring date-time

Timestamp when the contact was created.

tm_updatestring date-time

Timestamp when the contact was last updated.

tm_deletestring date-time

Timestamp when the contact was deleted.

Example response

{
  "id": "550e8400-e29b-41d4-a716-446655440000",
  "customer_id": "7c4d2f3a-1b8e-4f5c-9a6d-3e2f1a0b4c5d",
  "first_name": "John",
  "last_name": "Smith",
  "display_name": "John Smith",
  "company": "Acme Corporation",
  "job_title": "Software Engineer",
  "source": "manual",
  "external_id": "CRM-12345",
  "notes": "Prefers morning calls. VIP account - escalate to senior support immediately.",
  "addresses": [
    {
      "type": "tel",
      "target": "+14155551234",
      "target_name": "John Smith",
      "name": "Main Office",
      "detail": "Primary contact number",
      "id": "550e8400-e29b-41d4-a716-446655440000",
      "contact_id": "7c4d2f3a-1b8e-4f5c-9a6d-3e2f1a0b4c5d",
      "customer_id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
      "is_primary": true,
      "tm_create": "2026-01-15T09:30:00.000000Z"
    }
  ],
  "tag_ids": [
    "b1a2c3d4-e5f6-7890-abcd-ef1234567890"
  ],
  "tm_create": "2026-01-15T09:30:00.000000Z",
  "tm_update": "2026-01-15T09:30:00.000000Z",
  "tm_delete": "2026-01-15T09:30:00.000000Z"
}

Changes

Changed in 6 of the 54 revisions of this API.1115

  • d5569b3154111See the full diff
    • ●

      added the new web_session enum value to the addresses/items/allOf[CommonAddress]/type response property for the response status 200

      response-property-enum-value-added

  • 53ddbce73e461See the full diff
    • ○

      added the optional property notes to the response with the 200 status

      response-optional-property-added

  • 2ad05734434b151See the full diff
    • ▲

      the addresses/items/ response's property type/format changed from object/ to / for status 200

      response-property-type-changed

    • ●

      removed the optional property addresses/items/id from the response with the 200 status

      response-optional-property-removed

    • ●

      removed the optional property addresses/items/is_primary from the response with the 200 status

      response-optional-property-removed

    • ●

      removed the optional property addresses/items/target from the response with the 200 status

      response-optional-property-removed

    • ●

      removed the optional property addresses/items/tm_create from the response with the 200 status

      response-optional-property-removed

    • ●

      removed the optional property addresses/items/type from the response with the 200 status

      response-optional-property-removed

    • ○

      added CommonAddress subschema #2 to the addresses/items/ response property allOf list for the response status 200

      response-property-all-of-added

    This revision also has 1 change that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog

  • a689a640736021See the full diff
    • ●

      removed the optional property emails from the response with the 200 status

      response-optional-property-removed

    • ●

      removed the optional property phone_numbers from the response with the 200 status

      response-optional-property-removed

    • ○

      added the optional property addresses to the response with the 200 status

      response-optional-property-added

    This revision also has 4 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog

  • 30dd625c75151See the full diff
    • ●

      removed the optional property phone_numbers/items/number_e164 from the response with the 200 status

      response-optional-property-removed

  • 995c56ba921922See the full diff
    • ●

      removed the optional property addresses from the response with the 200 status

      response-optional-property-removed

    • ●

      removed the optional property notes from the response with the 200 status

      response-optional-property-removed

    • ○

      added the optional property emails to the response with the 200 status

      response-optional-property-added

    • ○

      added the optional property phone_numbers to the response with the 200 status

      response-optional-property-added

    This revision also has 20 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog