Sign in

v77

latestOpenAPI 3.1.0MITraw.githubusercontent.com2026-08-012528701.8 MB
E911 Addresses

Get E911 address

Retrieves the details of an Address that has been previously created. Use the unique ID that was returned from your previous request to identify the specific instance.

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/addresses/{id}

Path parameters

idstring uuid required

Universal Unique Identifier.

Unique ID of the address.

Response

The request has succeeded.

idstring uuid required

Universal Unique Identifier.

labelstring required

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

countrystring required

The ISO 3166 Alpha 2 country code.

first_namestring required

First name of the occupant associated with this address.

last_namestring required

Last name of the occupant associated with this address.

street_numberstring required

The number portion of the street address.

street_namestring required

The name portion of the street address.

address_type'Apartment' | 'Basement' | 'Building' | 'Department' | 'Floor' | 'Office' | 'Penthouse' | 'Suite' | 'Trailer' | 'Unit' required

Address type for sub-addresses.

address_numberstring nullable required

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

citystring required

The city portion of the street address.

statestring required

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

postal_codestring required

The postal code of the street address.

zip_codestring required

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

emergency_enabledboolean required

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

validatedboolean required

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

validated_atstring nullable required

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

Example response

{
  "label": "My Address",
  "country": "US",
  "first_name": "Emmett",
  "last_name": "Brown",
  "street_number": "1640",
  "street_name": "Riverside Drive",
  "address_number": "42",
  "city": "Alexandria",
  "state": "CA",
  "postal_code": "91905",
  "zip_code": "91905"
}