Get E911 address

GET

https://{your_space_name}.signalwire.com/api/relay/rest/addresses/:id

Retrieves one physical E911 service address from your SignalWire project. Use List E911 addresses to find address IDs, or Get phone number to inspect the address currently assigned to a number.

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.

Retrieves one physical E911 service address from your SignalWire project. Use [List E911 addresses](/docs/apis/rest/e-911-addresses/list-addresses) to find address IDs, or [Get phone number](/docs/apis/rest/phone-numbers/retrieve-phone-number) to inspect the address currently assigned to a number. #### 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).

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)

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) ```

Path parameters

idstringRequiredformat: "uuid"

Unique ID of the address.

Response

The request has succeeded.

idstringformat: "uuid"

The unique identifier of the Address on SignalWire.

labelstring

A friendly name given to the address to help distinguish and search for different addresses within your project.

countrystring

The ISO 3166 Alpha 2 country code.

first_namestring

First name of the occupant associated with this address.

last_namestring

Last name of the occupant associated with this address.

street_numberstring

The number portion of the street address.

street_namestring

The name portion of the street address.

address_typeenum or null

If the address is divided into multiple sub-addresses, this identifies how the address is divided.

address_numberstring or null

If the address is divided into multiple sub-addresses, this identifies the particular sub-address.

citystring

The city portion of the street address.

statestring

The state/province/region of the street address. In the USA and Canada, use the two-letter abbreviated form.

postal_codestring

The postal code of the street address.

zip_codestring

The postal code of the street address. Alias for postal_code for backwards compatibility.

emergency_enabledboolean

Whether E911 emergency calling is enabled for this address (carrier-validated when created/updated with emergency_enabled=true for a US address).

validatedboolean

Whether the address was validated by the carrier (true when the carrier returned a valid or auto-corrected match).

validated_atstring or null

The RFC 3339 / ISO 8601 timestamp of the last successful carrier validation, or null if never validated.

Errors

401

Unauthorized Error

404

Not Found Error

422

Unprocessable Entity Error

500

Internal Server Error