Offices: GetOffices

This method returns a list of offices associated with an account.

Request

HTTP request

GET /v2/accounts/{accountId}/offices

Parameters

Parameter NameValueDescription
Path Parameters
accountIdstring

(Required) The id of the account.

Optional Query Parameters
countinteger

(Optional) The number of results to return. This value must be a number between 1 and 100 (default).

startPositioninteger

(Optional) The starting zero-based index position of the results set from which to begin returning values. The default value is 0.

onlyAccessibleboolean

(Optional) When set to true, the response only includes the offices that are accessible to the current user.

searchstring

(Optional) Filters returned records by the specified string. The response only includes records containing this string in the office name field.

Responses

CodeDescriptionReference
200

Offices successfully retrieved.

OfficeSummaryList
400

Bad request. See ErrorCode and Message for details

ApiError
401

Not authorized to make this request.

ApiError

SDK Method

Offices::GetOffices

Definitions

ApiError

This object describes errors that occur. It is valid only for responses and ignored in requests.

errorCodestring

The code associated with the error condition.

messagestring

A brief message describing the error condition.

OfficeSummary

A complex element containing summary information on an office; the elements of this object are identical to those of the Offices object.

officeIdinteger

The id of the office. This is the id that the system generated when you created the office.

namestring

The name of the office.

regionIdinteger

The id of the region. This is the id that the system generated when you created the region.

address1string

First line of the office street address.

address2string

Second line of the office street address.

citystring

City name or metropolitan area of the office address.

stateIdstring

A concatenation of the two-letter country code with the state/province/region of the office address.

Example: US-OH (for Ohio)

postalCodestring

Postal code or ZIP code of the office address.

countryIdstring

The two-letter country code of the office address (for example, "UK" for United Kingdom).

timeZoneIdstring

The id of the time zone for the office address.

Example: eastern (for the Eastern US Time Zone)

phonestring

Phone number of the office.

createdDatestring

UTC datetime that the office was created (for example, "2019-07-17T17:45:42.783"). Note that the service assigns this value, so it is read-only.

OfficeSummaryList

Object that contains a summary of information about a requested group of offices in the Rooms account.

officeSummaries[OfficeSummary]

A list of OfficeSummary objects containing summary information about an office.

resultSetSizeinteger

The number of results returned in this response.

startPositioninteger

The index position within the total result set from which returned values start.

endPositioninteger

The index position within the total result set at which returned values end.

nextUristring

The URI for the next chunk of records based on the search request. This property is null for the last set of search results.

priorUristring

The URI for the previous chunk of records based on the search request. This property is null for the first set of search results.

}} />