Skip to main content
GET
Error

Authorizations

Authorization
string
header
required

Prefix the value with "ApiKey" to indicate the custom authorization type

Query Parameters

page
integer<int32>

The page number to request (1 based)

Example:

1

size
integer<int32>

The number of results to return in a page

Example:

100

Response

Paginated list of offices

id
string<uuid>
required

Unique identifier for this office

Example:

"ed92d1a0-a8ee-4768-bbcb-26dd4bfdf8a4"

name
string
required

Display name of the office

Example:

"HQ Office"

address
object
required

Physical address of this office, used for equipment deliveries and returns

active
boolean
required

Whether this office is currently active. Inactive offices cannot receive new orders or returns

Example:

true

contactName
string

Name of the contact person at this office, used for shipping and logistics

Example:

"Jane Doe"