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
  • Phone Number Management
      • POSTCreate E911 address
      • DELDelete E911 address
      • GETGet E911 address
      • GETList E911 addresses
  • Platform
  • Resource Management
LogoLogoSignalWire Docs
Log inSign up
Support
Phone Number ManagementE911 Addresses

List E911 addresses

|View as Markdown|Open in Claude|
GET
https://{your_space_name}.signalwire.com/api/relay/rest/addresses
GET
/api/relay/rest/addresses
$curl https://{your_space_name}.signalwire.com/api/relay/rest/addresses \
>     -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      "label": "My Address",
12      "country": "US",
13      "first_name": "Emmett",
14      "last_name": "Brown",
15      "street_number": "1640",
16      "street_name": "Riverside Drive",
17      "address_type": "Apartment",
18      "address_number": "42",
19      "city": "Alexandria",
20      "state": "CA",
21      "postal_code": "91905",
22      "zip_code": "91905"
23    }
24  ]
25}
Returns a list of your Addresses. The addresses 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

Create number group

Next
Built with

Returns a list of your Addresses. The addresses 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_labelstringOptional

Filter addresses by label (partial match).

page_numberintegerOptionalDefaults to 0

The page number to retrieve (0-indexed).

page_sizeintegerOptional1-1000Defaults to 50

The number of items per page (1-1000).

page_tokenstringOptional

Token for cursor-based pagination. Required when page_number > 0.

Response

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

Errors

401
Unauthorized Error
422
Unprocessable Entity 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)