---
title: "List Contact Details"
method: GET
path: "/contact_details"
tags: ["Contact Details"]
---

# List Contact Details

`GET /contact_details`

Retrieve a list of contact data with marketing channels and custom fields

## Query parameters

- `id` string
- `created_at` string
- `updated_at` string
- `organisation_id` string
- `full_name` string
- `fts` string
- `is_blocked` string
- `external_id` string
- `secondary_external_id` string
- `birthday` string
- `salutation` string
- `email` string
- `sms` string
- `whatsapp` string
- `instagram` string
- `facebook` string
- `display_name` string
- `google_business_messaging` string
- `address_line1` string
- `address_line2` string
- `city` string
- `zipcode` string
- `country` string
- `postal` string
- `number_of_marketing_opt_in_requests` string
- `latest_marketing_opt_in_request_sent_at` string
- `campaign_messages_this_month` string
- `whatsapp_marketing_opt_in` string
- `sms_marketing_opt_in` string
- `email_marketing_opt_in` string
- `facebook_marketing_opt_in` string
- `instagram_marketing_opt_in` string
- `google_business_messaging_marketing_opt_in` string
- `postal_marketing_opt_in` string
- `whatsapp_transactional_opt_in` string
- `sms_transactional_opt_in` string
- `email_transactional_opt_in` string
- `facebook_transactional_opt_in` string
- `instagram_transactional_opt_in` string
- `google_business_messaging_transactional_opt_in` string
- `postal_transactional_opt_in` string
- `select` string
- `order` string
- `offset` string
- `limit` string

## Headers

- `Range` string
- `Range-Unit` string

## Response `200`

OK

- ContactDetails[]
  - `id` string, uuid — Contact ID
  - `created_at` string, timestamp with time zone — Contact creation date
  - `updated_at` string, timestamp with time zone — Latest update
  - `organisation_id` string, uuid — Organisation ID
  - `full_name` string, text, nullable — Name of contact
  - `fts` string, tsvector, nullable — Handle of contact
  - `is_blocked` boolean — Is the contact blocked?
  - `external_id` string, text, nullable — External ID
  - `secondary_external_id` string, text, nullable — Secondary External ID
  - `birthday` string, date, nullable — Birthday of the contact
  - `salutation` string, text, nullable — Salutation
  - `email` string, text, nullable — Email of contact
  - `sms` string, text, nullable — SMS of contact
  - `whatsapp` string, text, nullable — Whatsapp Number
  - `instagram` string, text, nullable — Instagram
  - `facebook` string, text, nullable — Facebook
  - `display_name` string, text, nullable — Displayed name of contact in the Mateo app
  - `google_business_messaging` string, text, nullable — Google business messaging account of contact
  - `address_line1` string, text, nullable — First line of the postal address
  - `address_line2` string, text, nullable — Second line of the postal address
  - `city` string, text, nullable — City of the postal address
  - `zipcode` string, text, nullable — Postal code or ZIP code of the address
  - `country` string, text, nullable — Country of the postal address
  - `postal` string, text, nullable — Postal handle or identifier for the contact
  - `number_of_marketing_opt_in_requests` integer — Number of marketing opt in requests
  - `latest_marketing_opt_in_request_sent_at` string, timestamp with time zone, nullable — Latest marketing opt in request sent at
  - `campaign_messages_this_month` integer — Campaign Messages this month
  - `whatsapp_marketing_opt_in` boolean — WhatsApp marketign opt in
  - `sms_marketing_opt_in` boolean — SMS marketing opt in
  - `email_marketing_opt_in` boolean — Email marketing opt in of contact
  - `facebook_marketing_opt_in` boolean — Facebook marketing opt in
  - `instagram_marketing_opt_in` boolean — Instagram marketing opt in
  - `google_business_messaging_marketing_opt_in` boolean — Google business messaging marketing opt in
  - `postal_marketing_opt_in` boolean — Postal marketing opt in status
  - `whatsapp_transactional_opt_in` 'legitimate_interest' | 'contract_fulfillment' | 'consent_granted', public.opt_in_reason, nullable — WhatsApp transactional opt in
  - `sms_transactional_opt_in` 'legitimate_interest' | 'contract_fulfillment' | 'consent_granted', public.opt_in_reason, nullable — SMS transactional opt in
  - `email_transactional_opt_in` 'legitimate_interest' | 'contract_fulfillment' | 'consent_granted', public.opt_in_reason, nullable — Email transactional opt in
  - `facebook_transactional_opt_in` 'legitimate_interest' | 'contract_fulfillment' | 'consent_granted', public.opt_in_reason, nullable — Facebook transactional opt in
  - `instagram_transactional_opt_in` 'legitimate_interest' | 'contract_fulfillment' | 'consent_granted', public.opt_in_reason, nullable — Instagram transactional opt in
  - `google_business_messaging_transactional_opt_in` 'legitimate_interest' | 'contract_fulfillment' | 'consent_granted', public.opt_in_reason, nullable — Google business messaging transactional opt in
  - `postal_transactional_opt_in` 'legitimate_interest' | 'contract_fulfillment' | 'consent_granted', public.opt_in_reason, nullable — Postal transactional opt in status

---

[API](https://skmtc.net/getmateo/apis/mateo-api.md) · [All operations](https://skmtc.net/getmateo/apis/mateo-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/getmateo/mateo-api/versions/96e99eb80199/schema)