Sign in

v1

latestOpenAPI 3.0.02026-07-244771176.5 KB
Senders

List sender registrations

Returns a paginated list of sender registrations for the authenticated account.

  • If the account does not use parent/child accounts, the API returns registrations for the authenticated account.
  • If the account is a parent account, the API returns registrations for the parent account and all child accounts.
get/v2/senders/registrations

Query parameters

pageinteger

Page number to return (1-based). Default 1.

limitinteger

Maximum number of results per page. Default 25, maximum 100.

child_account_idstring

Filter registrations by child account ID. Returns only registrations belonging to the specified child account.

senderstring

Filter registrations by sender phone number in E.164 format (e.g., 61412312312).

statusstring

Filter registrations by status. Accepts one or more comma-separated values. Valid values: PENDING_APPROVAL, VERIFIED, REJECTED, CANCELLED.

Response

Successful response containing a paginated list of sender registrations.

requestobject

Optional metadata (e.g. requestId, traceId)

Example response

{
  "data": {
    "registrations": [
      {
        "details": {
          "alphanumeric": {
            "status": "PENDING_CUSTOMER",
            "status_reason": "Customer has not taken any actions"
          }
        }
      }
    ]
  },
  "meta": {
    "pagination": {
      "type": "page",
      "page": 1,
      "limit": 25,
      "total_count": 123
    }
  }
}