ReferenceOffices
List offices
Beta
GET
Lists your organization's offices, sorted by id. Active offices by default; archived ones with status=archived.
header
AuthorizationBearer <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_.
status?stringactive (the default) or archived.
Default
"active"Value in
"active""archived"cursor?stringOpaque cursor from pagination.nextCursor of the previous page; omit it for the first page.
Length
1 <= lengthlimit?integerPage size, 1 to 500; default 100.
Range
1 <= value <= 500Default
100OK
application/json- response
data*array<>pagination*Cursor pagination: nextCursor is null on the last page.
meta*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" }}