Skip to main content
GET
/
v3
/
job-role-assignments
/
{job_role_assignment_id}
Retrieve a job role assignment
curl --request GET \
  --url https://api.ctrl-hub.com/v3/job-role-assignments/{job_role_assignment_id} \
  --header 'X-Session-Token: <api-key>'
{
  "data": {
    "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "type": "<string>",
    "meta": {
      "created_at": "2023-11-07T05:31:56Z",
      "type": "<string>"
    },
    "relationships": {
      "user": {
        "data": {
          "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
          "type": "<string>"
        }
      },
      "role": {
        "data": {
          "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
          "type": "<string>"
        }
      }
    }
  },
  "jsonapi": {
    "version": "<string>"
  },
  "included": [
    {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "type": "<string>",
      "attributes": {
        "name": "<string>",
        "description": "<string>",
        "shared": false
      },
      "meta": {
        "created_at": "2023-11-07T05:31:56Z",
        "updated_at": "2023-11-07T05:31:56Z",
        "deleted_at": "2023-11-07T05:31:56Z"
      },
      "relationships": {
        "organisation": {
          "data": {
            "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
            "type": "<string>"
          }
        },
        "competency_requirement_specification": {
          "data": {
            "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
            "type": "<string>"
          }
        },
        "optional_competency_requirement_specification": {
          "data": {
            "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
            "type": "<string>"
          }
        }
      }
    }
  ]
}

Authorizations

​
X-Session-Token
string
header
required

Session token for authentication.

Path Parameters

​
job_role_assignment_id
string<uuid>
required

The unique identifier for the job role assignment.

Query Parameters

​
include
enum<string>[]

A comma separated list of related resources to include.

Available options:
organisation,
role,
user

Response

Get a job role assignment.

JSON API response object

​
data
object
required

A job role assignment linking a user to a job role

​
jsonapi
object
required
​
included
object[]

Related resources that can be included when a job role assignment is returned

An internal job role