Sign in

v1

latestOpenAPI 3.1.02026-07-24181585937.4 KB
User

user.listInterviewerPauses

Lists all active or scheduled interviewer pauses for a user.

Requires the organizationRead permission.

post/user.listInterviewerPauses

Request body

userIdstring uuid required

The id of the user to list pauses for.

Example request

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

Response

Responses from the user.listInterviewerPauses endpoint

OR

Example response

{
  "success": true,
  "results": [
    {
      "id": "e9ed20fd-d45f-4aad-8a00-a19bfba0083e",
      "userId": "3c5e1e9f-17b5-4c8e-8d1a-9f6e4b3a2c1d",
      "startsAt": "2024-01-15T00:00:00.000Z",
      "endsAt": "2024-02-15T00:00:00.000Z",
      "comment": "On vacation",
      "createdAt": "2024-01-14T10:30:00.000Z"
    }
  ]
}