TextKitDocs

Retrieve a contact

Includes consent_status, each topic's subscription, and the saved segments the contact is in right now.

GET/v1/contacts/{id}

Path Parameters

  • idstringrequired

Details

id may also be the contact's phone number.

Responses

  • 200Contact

    The contact

  • 401Error

    Missing, malformed, or revoked API key

  • 402Error

    Billable live calls only: the prepaid credit balance cannot cover the call (insufficient_credits); nothing was done or charged

  • 404Error

    Not found

  • 429Error

    Rate limit or quota exceeded

Response Fields

  • idstring

    Example: ct_a1B2c3D4e5F6.

  • objectcontact
  • phone_numberstring

    Example: +14155550132.

  • namestring

    Nullable.

  • tagsarray of string

    Free-form labels; they double as broadcast audiences

  • fieldsobject
  • notesstring

    Nullable.

  • first_namestring

    Nullable.

  • last_namestring

    Nullable.

  • emailstring

    Nullable.

  • companystring

    Nullable.

  • statestring

    Nullable.

  • sourcestring

    Nullable.

  • import_idstring

    The last import that touched this contact Nullable.

  • opt_inobject

    Nullable.

  • opt_in.sourcestring

    Nullable.

  • opt_in.collected_atstring (date-time)

    Nullable.

  • created_atstring (date-time)
  • updated_atstring (date-time)
  • consent_statusopted_out, opted_in, no_record

    Only on retrieve

  • topicsarray of TopicSubscription

    Only on retrieve

  • segmentsarray of object

    Only on retrieve

  • segments[].idstring
  • segments[].namestring

Errors

Every error has the same JSON shape, and request_id matches the X-Request-Id response header. Errors lists every code and what to do about it.

  • 401

    Missing, malformed, or revoked API key

  • 402

    Billable live calls only: the prepaid credit balance cannot cover the call (insufficient_credits); nothing was done or charged

  • 404

    Not found

  • 429

    Rate limit or quota exceeded