Messages

List scheduled messages

No auth required

Lists scheduled messages scoped to the caller's organizations. Anonymous callers receive an empty list.

GET/api/messages

Parameters

Query

limitinteger

Number of results to return (1–100).

afterstring

Cursor for pagination — the ID of the last item from the previous page.

Responses

200A list of scheduled messages.

object"list"

dataScheduledMessage[]

idstring

Unique identifier for the scheduled message, prefixed with `msg_`.Example: "msg_xxxxxxxxxxxxxxxxxxxxxxxx"

object"scheduled_message"

organization_idstring | null

Owning organization ID, or null if the resource is public (created without an API key).

channel"http"

Delivery channel. Only `http` is supported today.

urlstring

Target URL the request is sent to.

method"GET" | "POST" | "PUT" | "PATCH" | "DELETE"

HTTP method used for delivery.

headersobject

Request headers. Defaults to {}.

bodystring | null

Request body, if any.

scheduled_atinteger | null

When the message will fire. Unix timestamp in seconds.

status"scheduled" | "delivering" | "delivered" | "failed" | "canceled"

Delivery state.

attemptsinteger

Number of delivery attempts made.

response_statusinteger | null

HTTP status returned by the target on the last attempt.

last_errorstring | null

Error from the last attempt, if it failed.

delivered_atinteger | null

When the last delivery attempt ran. Unix timestamp in seconds.

created_atinteger | null

When the message was created. Unix timestamp in seconds.

updated_atinteger | null

When the message was last updated. Unix timestamp in seconds.

has_moreboolean

next_cursorstring | null

ID to pass as ?after= for the next page, or null.

total_countinteger

401No valid API key was provided.

errorobject

codestring

Machine-readable error code.

messagestring

Human-readable error message.

paramstring | null

The offending parameter, when applicable.

Example request

curl

curl https://agtls.dev/api/messages