Skip to content
/
Get Role

Get Role

Request

Gets details of a specific role used for shaping, planning, and reporting.

Security
ApiKey
Path
idstring, (uuid)required

ID of the resource

curl -i -X GET \
  'https://developer.getparallax.com/_mock/api-documentation/swagger/v1/roles/{id}' \
  -H 'X-API-KEY: YOUR_API_KEY_HERE'

Responses

OK

Bodyapplication/json
idstring, (uuid)

The unique identifier for the Role in Parallax.

namestring

The name of the Role, typically describing the job function or skill set (e.g. Designer, Developer).

department_idstring, (uuid)

The unique identifier of the Department that this Role belongs to for capacity and reporting segmentation.

capacitynumber, (double)

The full-time capacity for this Role, expressed as a decimal percentage (e.g. 1.0 = 100%).

billable_utilization_targetnumber, (double)

The target percentage of billable utilization expected for this Role, expressed as a decimal percentage (e.g. 1.0 = 100%).

archivedboolean

Indicates whether this Role has been archived and is no longer active for planning or reporting.

created_datestring, (date-time)

The date and time when the Role record was created in Parallax.

modified_datestring, (date-time)

The date and time when the Role record was last modified in Parallax.

Response
{
  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  "name": "string",
  "department_id": "094fb5f1-8160-46ea-8cec-010c4b44e054",
  "capacity": 0.1,
  "billable_utilization_target": 0.1,
  "archived": true,
  "created_date": "2019-08-24T14:15:22Z",
  "modified_date": "2019-08-24T14:15:22Z"
}