Get Addresses for User

Request

Authorization

Provide your bearer token in the

Authorization

header when making requests to protected resources.

Example:

Authorization: Bearer ********************

Path Params

domain

string

required

user

string

required

Query Params

limit

integer

optional

Example:

show_all_personal

string

optional

Set to "yes" and do not set user in order to show all addresses in domain regardless of user identity. Requires Office Manager or above

show_only_personal

string

optional

Set to "yes" to show only the personal addresses. Default to "no" which would also showing all the domain-level addreses

Example:

yes/no

Responses

🟢200OK

application/json

Body

array of:

emergency-address-id

string

required

This is an autogenerated ID for the Address.

domain

string

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 (*).

<= 64 characters

Examples:

example.commyDomaintest.12123

Match pattern:

^[A-Za-z0-9._-]+|\*

user

string

required

This is the main user extension for the user account.

Examples:

1000200

address-name

string

required

This is the name label for the address

caller-name

string

required

This is the caller's name for the address

address-line-1

string

required

This is the address line 1 for the address

address-line-2

string | null

optional

This is the address line 2 for the address

address-city

string

required

This is the city for the address

address-state-province-abbreviation

string

required

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

address-postal-code

string

required

This is the postal code for the address

address-country-abbreviation

string

required

This is the country appreviation for the address

address-location-description

string | null

optional

This is an optional location description for the address

ip-address-public

string | null

optional

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

address-formatted-pidflo

string

required

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

carrier

string | null

optional

This is the carrier name for the address

count-users-configured

integer | null

read-onlyoptional

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

address-formatted-pretty

string | null

read-onlyoptional

This is a human readable format of the address

address-is-default-for-site

boolean | null

read-onlyoptional

This is whether the address is a default for the site

Example

[
  {
    "emergency-address-id": "string",
    "domain": "example.com",
    "user": "1000",
    "address-name": "string",
    "caller-name": "string",
    "address-line-1": "string",
    "address-line-2": "string",
    "address-city": "string",
    "address-state-province-abbreviation": "string",
    "address-postal-code": "string",
    "address-country-abbreviation": "string",
    "address-location-description": "string",
    "ip-address-public": "string",
    "address-formatted-pidflo": "string",
    "carrier": "string",
    "count-users-configured": 0,
    "address-formatted-pretty": "string",
    "address-is-default-for-site": true
  }
]

🟠404Record not found

🟠400Bad Request

🟠401Authentication Required

Request

Request samples

Responses