Skip to main content
GET
/
api
/
v1
/
contacts
/
{id}
Get a contact by ID with all related data (channels, addresses, dates, tags, affiliations).
curl --request GET \
  --url https://api.backside.app/api/v1/contacts/{id} \
  --header 'Authorization: Bearer <token>'
{
  "created_at": "2023-11-07T05:31:56Z",
  "display_name": "<string>",
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "kind": "<string>",
  "metadata": "<unknown>",
  "tenant_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "updated_at": "2023-11-07T05:31:56Z",
  "addresses": [
    {
      "contact_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "created_at": "2023-11-07T05:31:56Z",
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "is_primary": true,
      "metadata": "<unknown>",
      "tenant_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "updated_at": "2023-11-07T05:31:56Z",
      "city": "<string>",
      "country": "<string>",
      "country_code": "<string>",
      "extended": "<string>",
      "key_version": 123,
      "label": "<string>",
      "latitude": 123,
      "longitude": 123,
      "po_box": "<string>",
      "postal_code": "<string>",
      "region": "<string>",
      "street": "<string>"
    }
  ],
  "affiliations": [
    {
      "contact_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "created_at": "2023-11-07T05:31:56Z",
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "is_current": true,
      "metadata": "<unknown>",
      "organization_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "tenant_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "updated_at": "2023-11-07T05:31:56Z",
      "department": "<string>",
      "description": "<string>",
      "end_date": "2023-12-25",
      "role": "<string>",
      "start_date": "2023-12-25",
      "title": "<string>"
    }
  ],
  "channels": [
    {
      "contact_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "created_at": "2023-11-07T05:31:56Z",
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "is_primary": true,
      "is_verified": true,
      "metadata": "<unknown>",
      "preference_order": 123,
      "tenant_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "type": "<string>",
      "updated_at": "2023-11-07T05:31:56Z",
      "value": "<string>",
      "canonical_value": "<string>",
      "key_version": 123,
      "label": "<string>"
    }
  ],
  "dates": [
    {
      "contact_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "created_at": "2023-11-07T05:31:56Z",
      "date_type": "<string>",
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "metadata": "<unknown>",
      "tenant_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "updated_at": "2023-11-07T05:31:56Z",
      "date_day": 123,
      "date_label": "<string>",
      "date_month": 123,
      "date_year": 123
    }
  ],
  "tags": [
    {
      "created_at": "2023-11-07T05:31:56Z",
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "metadata": "<unknown>",
      "name": "<string>",
      "tenant_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "updated_at": "2023-11-07T05:31:56Z",
      "color": "<string>",
      "description": "<string>"
    }
  ],
  "avatar_url": "<string>",
  "bio": "<string>",
  "deleted_at": "2023-11-07T05:31:56Z",
  "family_name": "<string>",
  "given_name": "<string>",
  "language": "<string>",
  "middle_name": "<string>",
  "nickname": "<string>",
  "prefix": "<string>",
  "suffix": "<string>",
  "timezone": "<string>",
  "vcard_uid": "<string>"
}

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

id
string<uuid>
required

Contact ID

Response

Contact with related data

created_at
string<date-time>
required
display_name
string
required
id
string<uuid>
required
kind
string
required
metadata
any
required
tenant_id
string<uuid>
required
updated_at
string<date-time>
required
addresses
object[]
required
affiliations
object[]
required
channels
object[]
required
dates
object[]
required
tags
object[]
required
avatar_url
string | null
bio
string | null
deleted_at
string<date-time> | null
family_name
string | null
given_name
string | null
language
string | null
middle_name
string | null
nickname
string | null
prefix
string | null
suffix
string | null
timezone
string | null
vcard_uid
string | null