Sign in

Messages: List

GET https://{organization}.myguper.com/api/sender/messages

Paginated view of message_process_queue (admin mode excluded) with a per-row dispatcher summary. Drives the message log screen in the admin.

To find which message started a conversation from a phone number, filter by cellphone (exact) and ask for the body with include=rendered_body — one call returns the recent messages to that number with the rendered text, no detail round-trip and no customer lookup needed.

Try-it values populated from environment ACME (Demo)


Authentication

Token

Send your user token in the x-guper-authorization header.

Headers

Name Type Description
x-guper-authorization * string User token issued by Guper.
Content-Type * string Always `application/json` for endpoints that accept a JSON body.

Query parameters

Name Type Description
q[column][operator] string Filter using the `q[column][operator]=value` grammar. See [List query parameters](/docs/{lang}/guides/list-query-parameters) for the full operator table.
o[column] string Sort by column. Direction: `ASC`, `DESC`, `1` or `0`.
e integer Items per page. Max `1000`. `0` for unlimited.
default: 20
p integer Page number (≥ 1).
default: 1
mode string Filter by queue mode.
slug string Filter by message slug.
sequence integer Filter by sequence id.
template integer Filter by template id: messages that have at least one dispatcher sent with this template. Also accepted by `/messages/count`.
status string Filter by processing status.
startDate string `Y-m-d` (inclusive, 00:00:00).
endDate string `Y-m-d` (inclusive, 23:59:59).
person_id integer Filter by register person id (exact).
cellphone string Filter by recipient cellphone (exact match on the snapshot stored at send time). Skips resolving phone->person in register.
search string Substring match on person name/email/cellphone.
include string Comma list; adds rendered fields to each dispatcher in the list (opt-in, off by default). Allowed: `rendered_body`, `rendered_subject`, `rendered_text`, `rendered_meta`.
entries integer
default: 20
page integer
default: 1

Responses

Related

Copied to clipboard