List sender registrations

get

https://api.transmitmessage.com/v2/senders/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 the registrations it created, for its own account and for its child accounts. Registrations a child account created itself aren't included.

Every registration carries account_id, the account it belongs to. Use the account_id
query parameter to narrow the list to some of those accounts.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Query Params

page

integer

≥ 1

Defaults to 1

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

limit

integer

1 to 100

Defaults to 25

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

child_account_id

string

deprecated

Deprecated: use account_id, which accepts more than one account. Returns only the registrations of this account: your own account or one of your child accounts. The API returns 404 Not Found for an account that isn't visible to you, and 403 Forbidden for one that's visible but you don't manage. Before these responses were added, an account you couldn't use returned an empty list. Can't be combined with account_id.

account_id

array of strings

length ≤ 100

Returns only registrations whose account_id is one of these accounts. Accepts one or
more comma-separated account IDs: your own account and any of your child accounts. The
API returns 404 Not Found for an account that isn't visible to you, and
403 Forbidden for one that's visible but you don't manage. Up to 100 values.

The list holds the registrations you created, for your own account or for a child
account; registrations a child account created itself aren't included. Can't be combined
with account_scope or child_account_id.

account_id

account_scope

string

enum

Set to all to return the registrations you created, for your own account and for any of
your child accounts; registrations a child account created itself aren't included. This
is also what the API returns when you omit it; the parameter is accepted so you can send
the same one as on GET /v2/senders. Combined with child_account_id, it returns that
account's registrations only.

Allowed:

string

Returns registrations whose sender, or the company name of the child account they belong to, contains this text. The match ignores case.

sender

string

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

status

string

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

registry_status

array of objects

Returns alphanumeric registrations whose details.alphanumeric.status is one of these values. Accepts one or more comma-separated values. Personal mobile number registrations have no registry status, so they're left out when you set it.

registry_status

registry

string

enum

Returns alphanumeric registrations submitted to this registry. Personal mobile number registrations are left out when you set it.

Allowed:

sort

string

enum

Defaults to created_at

The field to sort by. Default created_at. Ties are broken by registration_id, so paging through a sorted list doesn't repeat or skip registrations.

Allowed:

order

string

enum

Defaults to desc

The sort direction. Default desc.

Allowed:

Responses

200Successful response containing a paginated list of sender registrations.

400Input Validation Error

401Unauthorized. The credential is missing or was rejected by the authentication check. For API keys, other 4xx codes from the key check are returned with the same body, and a failure inside the authentication check returns 500 with it.

403Forbidden

404Not Found

500Internal Server Error

503Service Unavailable. The API returns one of two bodies: a status body when the API gateway can't reach the authentication service, or a problem body when the sender service can't reach a service it depends on. Both are safe to retry.