v1

latestOpenAPI 3.1.02026-08-0612447737.4 KB

Recipient

List Recipients

Retrieve a list of recipients

get/recipient

Query parameters

idstring

Recipient ID

created_atstring

Recipient creation date

updated_atstring

Latest update

organisation_idstring

Organisation ID

conversation_idstring

Conversation ID

message_idstring

Message ID

contact_idstring

Contact ID

handlestring

Handle of recipient

full_namestring

Name of recipient

rolestring

Role of recipient

is_organisationstring

Is recipient the organisation?

statusstring

Status of recipient

selectstring

Filtering Columns

orderstring

Ordering. Allowed Fields: created_at

offsetstring

Limiting and Pagination

limitstring

Limiting and Pagination

Headers

Rangestring

Limiting and Pagination

Range-Unitstring

Limiting and Pagination

Response

idstring uuid

Recipient ID

created_atstring timestamp with time zone

Recipient creation date

updated_atstring timestamp with time zone

Latest update

organisation_idstring uuid

Organisation ID

conversation_idstring uuid

Conversation ID

message_idstring uuid

Message ID

contact_idstring uuid nullable

Contact ID

handlestring text

Handle of recipient

full_namestring text nullable

Name of recipient

role'from' | 'to' | 'cc' | 'bcc' | 'reply_to' public.recipient_role nullable

Role of recipient

is_organisationboolean nullable

Is recipient the organisation?

Status of recipient