Retrieve an Office

There are a couple of different ways to get office information.

Endpoints

Get all offices in an organization

  • GET /offices
    • Permissions: office:read
    • Roles: owner

Response: Paginated Array

  • id - string: Office Id
  • name - string: Office name
  • total_desks - number: Sum of all desks currently in the office
  • total_meeting_rooms - number: Sum of all meeting rooms currently in the office

Example

$ http GET 'http://localhost:5000/offices' 'X-Tactic-Orgz: ORGANIZATION_SLUG' 'Authorization: Bearer ACCESS_TOKEN'
HTTP/1.1 200 OK
{
"cursor": "offi_444c6631-0968-4797-a123-8c75b3393f56",
"elements": [
{
"id": "offi_444c6631-0968-4797-a123-8c75b3393f56",
"name": "Parma Heights",
"total_desks": 0,
"total_meeting_rooms": 0
}
]
}

Get information about a specific office

  • GET /offices/:id
    • Permissions: office:read
    • Roles: owner

Response: Paginated Array

  • id - string: Office Id
  • name - string: Office name
  • total_desks - number: Sum of all desks currently in the office
  • total_meeting_rooms - number: Sum of all meeting rooms currently in the office

Example

$ http GET 'http://localhost:5000/offices/offi_444c6631-0968-4797-a123-8c75b3393f56' 'X-Tactic-Orgz: ORGANIZATION_SLUG' 'Authorization: Bearer ACCESS_TOKEN'
HTTP/1.1 200 OK
{
"id": "offi_444c6631-0968-4797-a123-8c75b3393f56",
"name": "Parma Heights",
"total_desks": 55,
"total_meeting_rooms": 0
}
Was this page helpful?