curl --request GET \
  --url https://integration.getmateo.com/api/v1/contact_details \
  --header 'Authorization: Bearer <token>'
[
  {
    "id": "random uuid",
    "created_at": "now()",
    "updated_at": "now()",
    "organisation_id": "random uuid",
    "full_name": "<string>",
    "fts": "<string>",
    "is_blocked": false,
    "external_id": "<string>",
    "birthday": "2023-12-25",
    "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": "DEUTSCHLAND",
    "postal": "<string>",
    "number_of_marketing_opt_in_requests": 123,
    "latest_marketing_opt_in_request_sent_at": "<string>",
    "campaign_messages_this_month": 123,
    "whatsapp_marketing_opt_in": false,
    "sms_marketing_opt_in": false,
    "email_marketing_opt_in": false,
    "facebook_marketing_opt_in": false,
    "instagram_marketing_opt_in": false,
    "google_business_messaging_marketing_opt_in": false,
    "postal_marketing_opt_in": false,
    "whatsapp_transactional_opt_in": "legitimate_interest",
    "sms_transactional_opt_in": "legitimate_interest",
    "email_transactional_opt_in": "legitimate_interest",
    "facebook_transactional_opt_in": "legitimate_interest",
    "instagram_transactional_opt_in": "legitimate_interest",
    "google_business_messaging_transactional_opt_in": "legitimate_interest",
    "postal_transactional_opt_in": "legitimate_interest"
  }
]

Authorizations

​
Authorization
string
header
required

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

Headers

​
Range
string

Limiting and Pagination

​
Range-Unit
string
default:items

Limiting and Pagination

Query Parameters

​
id
string

Contact ID

​
created_at
string

Contact creation date

​
updated_at
string

Latest update

​
organisation_id
string

Organisation ID

​
full_name
string

Name of contact

​
fts
string

Handle of contact

​
is_blocked
string

Is the contact blocked?

​
external_id
string

External ID

​
birthday
string

Birthday of the contact

​
salutation
string

Salutation

​
email
string

Email of contact

​
sms
string

SMS of contact

​
whatsapp
string

Whatsapp Number

​
instagram
string

Instagram

​
facebook
string

Facebook

​
display_name
string

Displayed name of contact in the Mateo app

​
google_business_messaging
string

Google business messaging account of contact

​
address_line1
string

First line of the postal address

​
address_line2
string

Second line of the postal address

​
city
string

City of the postal address

​
zipcode
string

Postal code or ZIP code of the address

​
country
string

Country of the postal address

​
postal
string

Postal handle or identifier for the contact

​
number_of_marketing_opt_in_requests
string

Number of marketing opt in requests

​
latest_marketing_opt_in_request_sent_at
string

Latest marketing opt in request sent at

​
campaign_messages_this_month
string

Campaign Messages this month

​
whatsapp_marketing_opt_in
string

WhatsApp marketign opt in

​
sms_marketing_opt_in
string

SMS marketing opt in

​
email_marketing_opt_in
string

Email marketing opt in of contact

​
facebook_marketing_opt_in
string

Facebook marketing opt in

​
instagram_marketing_opt_in
string

Instagram marketing opt in

​
google_business_messaging_marketing_opt_in
string

Google business messaging marketing opt in

​
postal_marketing_opt_in
string

Postal marketing opt in status

​
whatsapp_transactional_opt_in
string

WhatsApp transactional opt in

​
sms_transactional_opt_in
string

SMS transactional opt in

​
email_transactional_opt_in
string

Email transactional opt in

​
facebook_transactional_opt_in
string

Facebook transactional opt in

​
instagram_transactional_opt_in
string

Instagram transactional opt in

​
google_business_messaging_transactional_opt_in
string

Google business messaging transactional opt in

​
postal_transactional_opt_in
string

Postal transactional opt in status

​
select
string

Filtering Columns

​
order
string

Ordering

​
offset
string

Limiting and Pagination

​
limit
string

Limiting and Pagination

Response

200 - application/json
OK

The response is of type object[].