Short Codes
List short codes
Returns a list of your short codes. The short codes are returned sorted by creation date, with the most recent appearing first.
Permissions
The API token used to authenticate must have the following scope(s) enabled to make a successful request: Numbers.
Learn more about API scopes.
get/api/relay/rest/short_codes
Query parameters
filter_namestring
Filter by name. Returns all short codes containing this value as a substring.
filter_numberstring
Filter by number. Returns all short codes containing this value as a substring.
page_numberinteger
The page number to retrieve.
page_sizeinteger
The number of results per page.
page_tokenstring
Token for cursor-based pagination.
Response
The request has succeeded.
Example response
{
"data": [
{
"name": "My Short Code",
"number": "12345",
"number_type": "shortcode",
"country_code": "US",
"created_at": "2023-01-15T10:30:00Z",
"updated_at": "2023-01-15T10:30:00Z",
"next_billed_at": "2024-01-15T10:30:00Z",
"lease_duration": "12 months",
"message_request_url": "https://example.com/message",
"message_fallback_url": "https://example.com/fallback",
"message_relay_context": "my-context"
}
]
}