Get Office

Get office details

Path Parameters

companyID companyID required

The id of the company

officeID officeID required

The id of the office

Responses

• 200
• 404

---

An office object

application/json

Schema

Example (from schema)

---

Schema

id string

Unique ID of the the office

name string

Name of the office

emoji string

Emoji of the office

createdAt date-time

Date the office was created

updatedAt date-time

Date the office was last updated

deletedAt date nullable

Date the office was deleted

managers string[]

List of managers of the team

{
  "id": "2e8f9915-fda0-450c-95a3-d61f93c66fa9",
  "name": "New York HQ",
  "emoji": "🏢",
  "createdAt": "2021-01-01T00:00:00.000Z",
  "updatedAt": "2021-01-01T00:00:00.000Z",
  "deletedAt": "2021-01-01",
  "managers": [
    "2e8f9915-fda0-450c-95a3-d61f93c66fa9"
  ]
}

An error when the office is not found

application/json

Schema

Example (from schema)

---

Schema

message string

Error message

{
  "message": "User not found"
}

Loading...