Retrieve a position's roles and tasks

Operation ID: getPositionPermissions

Group: People Management › Positions

Open in the interactive reference

GET /people/positions/{id}/permissions

Read-only: Reads and returns; changes nothing.

Retrieves a position's roles and tasks.

Parameters

Name In Type Required Description
Api-Version header string · v1 yes The API version this request targets, named by its public identifier. Required on every request; omitting it, or naming a version this company does not have, is answered with 400. This document describes version v1.
id path string yes The unique identifier for the position.

Response

200 Success

Under data (getPositionPermissionsOutput):

Field Type Required Description
roleUUIDs array<string> yes The uuids of the permission roles assigned to the position.
taskUUIDs array<string> yes The uuids of the permission tasks assigned to the position. 
{
  "data": {
    "roleUUIDs": [
      "<roleUUIDs>"
    ],
    "taskUUIDs": [
      "<taskUUIDs>"
    ]
  },
  "diagnostics": [
    {
      "code": "<code>",
      "message": "<message>",
      "severity": "error",
      "path": [
        "<path>"
      ],
      "details": "<details>"
    }
  ]
}

Errors

Code Status
NOT_FOUND 400

Statuses