Skip to main content
List Recipients
curl --request GET \
  --url https://integration.getmateo.com/api/v1/recipient \
  --header 'Authorization: Bearer <token>'
[
  {
    "id": "random uuid",
    "created_at": "now()",
    "updated_at": "now()",
    "organisation_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "conversation_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "message_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "contact_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "handle": "<string>",
    "full_name": "<string>",
    "role": "from",
    "is_organisation": true,
    "status": "sent"
  }
]

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

Recipient ID

​
created_at
string

Recipient creation date

​
updated_at
string

Latest update

​
organisation_id
string

Organisation ID

​
conversation_id
string

Conversation ID

​
message_id
string

Message ID

​
contact_id
string

Contact ID

​
handle
string

Handle of recipient

​
full_name
string

Name of recipient

​
role
string

Role of recipient

​
is_organisation
string

Is recipient the organisation?

​
status
string

Status of recipient

​
select
string

Filtering Columns

​
order
string

Ordering. Allowed Fields: created_at

​
offset
string

Limiting and Pagination

​
limit
string

Limiting and Pagination

Response

200 - application/json

OK

​
id
string<uuid>
default:random uuid

Recipient ID

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

Recipient creation date

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

Latest update

​
organisation_id
string<uuid>

Organisation ID

​
conversation_id
string<uuid>

Conversation ID

​
message_id
string<uuid>

Message ID

​
contact_id
string<uuid> | null

Contact ID

​
handle
string<text>

Handle of recipient

​
full_name
string<text> | null

Name of recipient

​
role
enum<string> | null

Role of recipient

Available options:
from,
to,
cc,
bcc,
reply_to
​
is_organisation
boolean<boolean> | null

Is recipient the organisation?

​
status
enum<string> | null

Status of recipient

Available options:
sent,
sending_error,
bounce_error,
submission_error,
submitted,
sending,
read,
draft,
scheduled,
interacted,
answered