Skip to main content
GET
Every message that arrived, what it became, and what to do about the ones that became nothing.

Headers

Range
string

Limiting and Pagination

Range-Unit
string
default:items

Limiting and Pagination

Prefer
enum<string>

Preference

Available options:
count=none

Query Parameters

id
string
received_at
string
provider
string
from_address
string
to_address
string
subject
string
body_excerpt
string
status
string
refusal_reason
string
authentication
string
automation
string
attachment_count
string
sender_user_id
string
sender_name
string
mailbox_name
string
entity_type
string
entity_id
string
entity_label
string
entity_reference
string
entity_title
string
remedy
string
select
string

Filtering Columns

order
string

Ordering

offset
string

Limiting and Pagination

limit
string

Limiting and Pagination

Response

OK

attachment_count
integer<integer>
authentication
string<character varying>
Maximum string length: 20
automation
string<character varying>
Maximum string length: 20
body_excerpt
string<text>
entity_id
string<uuid>
entity_label
string<text>
entity_reference
string<text>
entity_title
string<text>
entity_type
string<character varying>

Note: This is a Foreign Key to custom_field_entities.entity.

Maximum string length: 80
from_address
string<public.citext>
id
string<uuid>

Note: This is a Primary Key.

mailbox_name
string<character varying>
Maximum string length: 150
provider
string<character varying>
Maximum string length: 30
received_at
string<timestamp with time zone>
refusal_reason
string<character varying>
Maximum string length: 40
remedy
string<text>
sender_name
string<character varying>
Maximum string length: 200
sender_user_id
string<uuid>

Note: This is a Foreign Key to capex_invite_candidates.id.

status
string<character varying>
Maximum string length: 20
subject
string<text>
to_address
string<public.citext>