curl --request GET \
--url http://localhost:8888/v1/contacts/{id} \
--header 'Authorization: Bearer <token>'{
"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": "jsmith@example.com",
"mobile": "<string>",
"mobile_invalid": true,
"nationality": "<string>",
"phone": "<string>",
"phone_invalid": true,
"surname": "<string>",
"tags": [
{
"name": "<string>"
}
]
}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.
curl --request GET \
--url http://localhost:8888/v1/contacts/{id} \
--header 'Authorization: Bearer <token>'{
"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": "jsmith@example.com",
"mobile": "<string>",
"mobile_invalid": true,
"nationality": "<string>",
"phone": "<string>",
"phone_invalid": true,
"surname": "<string>",
"tags": [
{
"name": "<string>"
}
]
}Documentation Index
Fetch the complete documentation index at: https://qomon-86428773.mintlify.app/llms.txt
Use this file to discover all available pages before exploring further.
Authorizations
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
Contact ID.
x >= 042
Response
OK
Timestamp when the contact was created.
Unique identifier of the contact.
x >= 0Timestamp when the contact was last updated.
Postal address.
Show child attributes
Show child attributes
Age category.
x >= 0City of birth.
Country code of birth.
Date of birth.
Whether the contact has opted out of communications.
Organisation-defined custom fields.
Show child attributes
Show child attributes
First name.
"Jane"
Organisation-defined form data.
Show child attributes
Show child attributes
Gender. One of: M (Male), F (Female), O (Other). Empty if unknown.
M, F, O "female"
Primary email address.
"jane@example.com"
Mobile phone number.
Whether the mobile phone number is invalid.
Nationality.
Landline phone number.
Whether the landline phone number is invalid.
Last (family) name.
"Doe"
Tags attached to the contact.
Show child attributes
Show child attributes
Was this page helpful?