For AI agents: a documentation index is available at the root level at /llms.txt and /llms-full.txt. Append /llms.txt to any URL for a page-level index, or .md for the markdown version of any page.
Log inSign up
Support
  • Core
    • Overview
    • Authorization
    • Base URL
    • Data formats
    • Paging
    • Error codes
    • Permissions
  • Calling
  • Datasphere
  • Logs
  • Messaging
      • GETGet short code
      • GETList short codes
      • PUTUpdate short code
  • Phone Number Management
  • Platform
  • Resource Management
LogoLogoSignalWire Docs
Log inSign up
Support
MessagingShort Codes

List short codes

|View as Markdown|Open in Claude|
GET
https://{your_space_name}.signalwire.com/api/relay/rest/short_codes
GET
/api/relay/rest/short_codes
$curl https://{your_space_name}.signalwire.com/api/relay/rest/short_codes \
>     -u "<project_id>:<api_token>"
1{
2  "links": {
3    "self": "string",
4    "first": "string",
5    "next": "string",
6    "prev": "string"
7  },
8  "data": [
9    {
10      "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
11      "name": "My Short Code",
12      "number": "12345",
13      "capabilities": [
14        "sms"
15      ],
16      "number_type": "shortcode",
17      "code_type": "vanity",
18      "country_code": "US",
19      "created_at": "2023-01-15T10:30:00Z",
20      "updated_at": "2023-01-15T10:30:00Z",
21      "next_billed_at": "2024-01-15T10:30:00Z",
22      "lease_duration": "12 months",
23      "message_handler": "relay_context",
24      "message_request_url": "https://example.com/message",
25      "message_request_method": "GET",
26      "message_fallback_url": "https://example.com/fallback",
27      "message_fallback_method": "GET",
28      "message_laml_application_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
29      "message_relay_context": "my-context"
30    }
31  ]
32}
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](/docs/platform/your-signalwire-api-space).
Was this page helpful?
Previous

Update short code

Next
Built with

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.

Authentication

AuthorizationBasic
SignalWire Basic Authentication using Project ID and API Token. The client sends HTTP requests with the Authorization header containing the word Basic followed by a space and a base64-encoded string of project_id:token. The project ID will be used as the username and the API token as the password. Example: ``` Authorization: Basic base64(project_id:token) ```

Query parameters

filter_namestringOptional
Filter by name. Returns all short codes containing this value as a substring.
filter_numberstringOptional
Filter by number. Returns all short codes containing this value as a substring.
page_numberintegerOptionalDefaults to 0
The page number to retrieve.
page_sizeintegerOptional1-1000Defaults to 50
The number of results per page.
page_tokenstringOptional

Token for cursor-based pagination.

Response

The request has succeeded.
linksobject
Pagination links.
datalist of objects
List of short codes.

Errors

400
Bad Request Error
401
Unauthorized Error
500
Internal Server Error

SignalWire Basic Authentication using Project ID and API Token.

The client sends HTTP requests with the Authorization header containing the word Basic followed by a space and a base64-encoded string of project_id:token. The project ID will be used as the username and the API token as the password.

Example:

Authorization: Basic base64(project_id:token)