Skip to main content
GET
List Location

Authorizations

Authorization
string
header
required

Basic authentication header of the form Basic <encoded-value>, where <encoded-value> is the base64-encoded string username:password.

Path Parameters

customerId
string
required

Query Parameters

pageIndex
integer<int32>

Specifies the pagination page index.
Pages are zero indexed, i.e. the first page has an index value of zero.

pageSize
integer<int32>

Specifies the number of items to include on a page.
Must be specified if pageIndex has been specified.

name
string

Location name search string. This is a case insensitive partial match. A location will match if the specified name is found anywhere in the location name.

address
string

Location address search string. This is a case insensitive partial match. A location will match if the specified address is found anywhere in formatedAddress.

category
string

A location category name. This is a case sensitive exact match search.

reference
string

Location reference search string. This is a case insensitive partial match. A location will match if the specified reference is found anywhere in reference.

phoneNumber
string

Location phone number search string. This is a partial match. A location will match if the specified number is found anywhere in phoneNumber. Do not include a “+” in the search value.

contact
string

Contact name search string.

Response

200 - application/json;charset=UTF-8

Successful operation

totalPages
integer<int32>

Total number of pages based on the pageSize.

totalCount
integer<int64>

Total number of items that matched the search parameters.

items
object[]

Array of items.