Sign in

v1

latestOpenAPI 3.1.02026-07-24317911.4 MB
Addresses

Get Address Endpoints for a Domain

Emergency Address Endpoints are different than Emergency Addresses. Endpoints contain the Emergency Caller ID Number and the address associated with it should be the billing address. Emergency Addresses are what is passed in to the PIDFLO object.

get/domains/{domain}/addresses/endpoints

Path parameters

domainstring required

This is the main organization name. This is used to link resource to its group/tenant/organization/enterprise. Then using in path for GET you can set to "~" to use the domain name linked to your token/key instead of the domain name itself when reading for your own domain.

Example:example.com

Query parameters

limitnumber

This is the limit of the number of objects that will be returned in the read/list API call. This can be used with pagination to help retrieve smaller chunks of data. Should be used in conjunction with Start.

Response

emergency-address-idstring required

This is an autogenerated ID for the Address.

domainstring required

This is the main organization name. This is used to link resource to its group/tenant/organization/enterprise. ~ and * can be used alone in special cases to mean My Domain (~) and All Domains (*).

userstring required

This is the main user extension for the user account.

address-namestring required

This is the name label for the address

caller-namestring required

This is the caller's name for the address

address-line-1string required

This is the address line 1 for the address

address-line-2string nullable

This is the address line 2 for the address

address-citystring required

This is the city for the address

address-state-province-abbreviationstring required

This is the state or province (Canadian) abbreviation for the address

address-postal-codestring required

This is the postal code for the address

address-country-abbreviationstring required

This is the country appreviation for the address

address-location-descriptionstring nullable

This is an optional location description for the address

ip-address-publicstring nullable

This is the public IP of the client window creating the address.

address-formatted-pidflostring required

This is a return value of the formatted PIDFLO standardized value for the address

carrierstring nullable

This is the carrier name for the address

count-users-configuredinteger nullable

This is the count of how many users are using the particular address

address-formatted-prettystring nullable

This is a human readable format of the address

address-is-default-for-siteboolean nullable

This is whether the address is a default for the site

Example response

[
  {
    "domain": "example.com",
    "user": "1000"
  }
]