Sign in

v1

latestOpenAPI 3.1.02026-07-24181585937.4 KB
Department & Team

department.info

Fetch department details by id.

Requires the organizationRead permission.

post/department.info

Request body

departmentIdstring uuid required

The unique id of the department whose details will be fetched

Example request

{
  "departmentId": "e9ed20fd-d45f-4aad-8a00-a19bfba0083e"
}

Response

Responses from the department.info endpoint

OR

Example response

{
  "success": true,
  "results": {
    "id": "3ae2b801-19f6-41ef-ad28-214bd731948f",
    "name": "Engineering Operations",
    "externalName": "Engineering",
    "isArchived": false,
    "parentId": null,
    "createdAt": "2024-01-01T00:00:00.000Z",
    "updatedAt": "2024-01-01T00:00:00.000Z",
    "extraData": null
  }
}