Pult Docs
ReferenceOffices

List offices

Beta

GET
/offices

Lists your organization's offices, sorted by id. Active offices by default; archived ones with status=archived.

Authorization

headerAuthorizationBearer <pult_<base62>>

An API key created by an admin of your organization in the Pult dashboard, sent as Authorization: Bearer <key>. Keys start with pult_.

Query Parameters

status?string

active (the default) or archived.

Default"active"
Value in"active""archived"
cursor?string

Opaque cursor from pagination.nextCursor of the previous page; omit it for the first page.

Length1 <= length
limit?integer

Page size, 1 to 500; default 100.

Range1 <= value <= 500
Default100

Response Body

OK

application/json
  1. response
data*array<>
pagination*

Cursor pagination: nextCursor is null on the last page.

meta*
Example Request
curl -X GET 'https://api.pult.com/v1beta/offices' \  -H 'Authorization: Bearer pult_<key>'
Example Response
{  "data": [    {      "id": "string",      "name": "string",      "status": "active"    }  ],  "pagination": {    "nextCursor": "string"  },  "meta": {    "status": "active"  }}