Sign in

Message type: List

GET https://{organization}.myguper.com/api/sender/message-type

Lists every message type registered in the platform. A message type is a transactional event slug (e.g. welcome, order.confirmed, password.reset) plus its declared variables and a mockup payload. The admin uses this to render the variable picker when authoring a template.

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

Responses

{
    "list": [
        { "id": 1, "slug": "order.confirmed", "name": "Order confirmed", "description": "Sent after every paid order." }
    ]
}

Related

Copied to clipboard