Command Palette

Search for a command to run...

Log In
Get help

Get a Contact

get/public/v1/contacts/{contact}

Authorization

  • Authorizationstringrequired

    Bearer authentication header of the form Bearer <token>, where <token> is your API key. See How to set up an API key.

Path parameters

  • contactstringrequired

    The contact UUID

Response

200application/json

ContactResource

  • dataobjectrequired
    ▶Show 14 child attributes
    • idstringrequired
      Example:c1o2n3t4-a5c6-47t8-9b0c-1d2e3f4a5b6c
    • full_namestringrequired
      Example:Jane Doe
    • first_namestring | nullrequired
      Example:John
    • last_namestring | nullrequired
      Example:Doe
    • dobstring | nullrequired
      Example:1985-03-22
    • emailstring | nullrequired
      Example:jane.doe@example.com
    • phonestring | nullrequired
      Example:02 9876 5432
    • mobilestring | nullrequired
      Example:0412 345 678
    • genderstring | nullrequired
      Example:male
    • occupationstring | nullrequired
      Example:Support Coordinator
    • descriptionstring | nullrequired
      Example:Primary point of contact for scheduling
    • archived_atstring | nullrequired
      Example:2025-01-01T00:00:00+00:00
    • preferred_contact_methodstring | nullrequired
      Example:mobile
    • created_atstringrequired
      Example:2024-01-15T10:30:00+00:00

Errors

  • 401Unauthenticated
  • 403Authorization error
  • 404Not found