v4
latestSwagger 2.02026-08-0343714211.7 MBList Email Incoming Messages
List Email Incoming Messages
Query parameters
Used for pagination. When a list request has more records available, cursors are provided in the response headers X-Files-Cursor-Next and X-Files-Cursor-Prev. Send one of those cursor value here to resume an existing list from the next available record. Note: many of our SDKs have iterator methods that will automatically handle cursor-based pagination.
Number of records to show per page. (Max: 10000, 1,000 or less is recommended).
If set, sort records by the specified field in either asc or desc direction. Valid fields are created_at, sender, status or inbox_id.
If set, return records where the specified field is equal to the supplied value. Valid fields are created_at, inbox_id, sender or status. Valid field combinations are [ inbox_id, created_at ], [ sender, created_at ], [ status, created_at ], [ inbox_id, status ], [ status, sender ], [ inbox_id, status, created_at ], [ status, sender, created_at ], [ inbox_id, status, sender ] or [ inbox_id, status, sender, created_at ].
If set, return records where the specified field is greater than the supplied value. Valid fields are created_at.
If set, return records where the specified field is greater than or equal the supplied value. Valid fields are created_at.
If set, return records where the specified field is prefixed by the supplied value. Valid fields are sender.
If set, return records where the specified field is less than the supplied value. Valid fields are created_at.
If set, return records where the specified field is less than or equal the supplied value. Valid fields are created_at.
Response
A list of EmailIncomingMessages objects.
Example response
[
{
"id": 1,
"inbox_id": 1,
"sender": "example",
"sender_name": "example",
"status": "success",
"body": "example",
"message": "example",
"created_at": "2000-01-01T01:00:00Z",
"inbox_title": "Inbox Title"
}
]