Skip to main content
GET
/
marketing_subscription
List Marketing Subscriptions
curl --request GET \
  --url https://integration.getmateo.com/api/v1/marketing_subscription \
  --header 'Authorization: Bearer <token>'
[
  {
    "contact_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "marketing_channel_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "organisation_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "created_at": "now()",
    "updated_at": "now()",
    "key": "<string>",
    "status": "requested",
    "channel_type": "email"
  }
]

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

​
contact_id
string

Contact ID

​
marketing_channel_id
string

Marketing channel ID

​
organisation_id
string

Organisation ID

​
created_at
string

Marketing subscription creation date

​
updated_at
string

Latest update

​
key
string

Marketing subscription key

​
status
string

Status of Marketing subscription

​
channel_type
string

Channel Type of Conversation

​
select
string

Filtering Columns

​
offset
string

Limiting and Pagination

​
limit
string

Limiting and Pagination

Response

200 - application/json

OK

​
contact_id
string<uuid>

Contact ID

​
marketing_channel_id
string<uuid>

Marketing channel ID

​
organisation_id
string<uuid>

Organisation ID

​
created_at
string<timestamp with time zone>
default:now()

Marketing subscription creation date

​
updated_at
string<timestamp with time zone>
default:now()

Latest update

​
key
string<text>

Marketing subscription key

​
status
enum<string>

Status of Marketing subscription

Available options:
requested,
accepted,
declined
​
channel_type
enum<string>

Channel Type of Conversation

Available options:
email,
sms,
whatsapp,
instagram,
facebook,
google_business_messaging,
postal