Skip to main content
GET
Retrieve job role assignments

Authorizations

X-Session-Token
string
header
required

Session token for authentication.

Query Parameters

limit
integer<int64>
default:100

Limit the number of resources returned by the API

Required range: x >= 1
offset
integer<int64>
default:0

Offset the resources returned by the API

Required range: x >= 0
page
object

JSON:API pagination, as page[limit] and page[offset]. The same as the top-level limit and offset parameters; when both forms are sent, page[...] wins.

include
enum<string>[]

A comma separated list of related resources to include.

Available options:
organisation,
role,
user
filter
string
default:""

Filters the response data based on the value provided.

Available filters:

  • user: Filter assignments by user ID(s)
  • role: Filter assignments by job role ID(s)
  • type: Filter assignments by type (e.g., main_layer)
  • member_status: Filter assignments by the holder's membership status in the assignment's organisation, as eq(member_status,any). One of active or any, with eq only and not inside or(...). Defaults to active when omitted, so a holder who has been deactivated or removed is left out, and their assignment is kept for when they are reactivated. any lists every holder, as a member's own record does.

For more information on using named filters, see the docs

Response

Get a list of job role assignments.

JSON API response object

data
A list of job role assignments · object[]
required
meta
object
required
jsonapi
object
required
included
object[]

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

An internal job role