Find a contact by ID

Returns a single contact by ID.

In the response, advanced fields (consents, surveys, level of support, etc.) are formatted as formdatas with form_id and form_ref_id references. Use the /forms/{id} endpoint to decode these references and interpret their values.

GET /v1/contacts/{id}

Find a contact by ID

cURL

curl --request GET \
  --url http://localhost:8888/v1/contacts/{id} \
  --header 'Authorization: Bearer <token>'

200

{
  "created_at": "2023-11-07T05:31:56Z",
  "id": 1,
  "updated_at": "2023-11-07T05:31:56Z",
  "address": {
    "addition": "<string>",
    "building": "<string>",
    "city": "<string>",
    "country": "<string>",
    "county": "<string>",
    "door": "<string>",
    "floor": "<string>",
    "house_number": "<string>",
    "id": 1,
    "infos": "<string>",
    "latitude": "<string>",
    "longitude": "<string>",
    "postal_code": "<string>",
    "state": "<string>",
    "street": "<string>"
  },
  "age_category": 1,
  "birth_city": "<string>",
  "birth_country": "<string>",
  "birthdate": "2023-11-07T05:31:56Z",
  "black_list": true,
  "custom_fields": [
    {
      "data": "<string>",
      "form_id": 1,
      "form_ref_id": 1,
      "id": 1
    }
  ],
  "firstname": "<string>",
  "formdatas": [
    {
      "data": "<string>",
      "form_id": 1,
      "form_ref_id": 1,
      "id": 1,
      "date": "2023-11-07T05:31:56Z",
      "survey_id": 1
    }
  ],
  "mail": "[e-mail]",
  "mobile": "<string>",
  "mobile_invalid": true,
  "nationality": "<string>",
  "phone": "<string>",
  "phone_invalid": true,
  "surname": "<string>",
  "tags": [
    {
      "name": "<string>"
    }
  ]
}

Authorizations

Authorization · string · header · required

OAuth2 access token. Pass the token in the Authorization header as Bearer <token>. The token is looked up in Redis to resolve the caller identity.

Path Parameters

id · integer<int64> · required

Contact ID.

Required range: x >= 0

Example:

42

Response

200

application/json

OK

created_at · string<date-time> · required · read-only

Timestamp when the contact was created.

id · integer<int64> · required · read-only

Unique identifier of the contact.

Required range: x >= 0

updated_at · string<date-time> · required · read-only

Timestamp when the contact was last updated.

address · object

Postal address.

Show child attributes

age_category · integer<int64>

Age category.

Required range: x >= 0

birth_city · string

City of birth.

birth_country · string

Country code of birth.

birthdate · string<date-time>

Date of birth.

black_list · boolean

Whether the contact has opted out of communications.

custom_fields · object[] | null

Organisation-defined custom fields.

Show child attributes

firstname · string

First name.

Example:

"Jane"

formdatas · object[] | null

Organisation-defined form data.

Show child attributes

gender · enum<string>

Gender. One of: M (Male), F (Female), O (Other). Empty if unknown.

Available options: M, F, O

Example:

"female"

mail · string<email>

Primary email address.

Example:

"[e-mail]"

mobile · string

Mobile phone number.

mobile_invalid · boolean

Whether the mobile phone number is invalid.

nationality · string

Nationality.

phone · string

Landline phone number.

phone_invalid · boolean

Whether the landline phone number is invalid.

surname · string

Last (family) name.

Example:

"Doe"

tags · object[] | null

Tags attached to the contact.

Show child attributes