Get roles

GET {{baseUrl}}/roles

This endpoint can retrieve roles from NERM. Optionally you can provide parameters to filter results.

Request Params

KeyDatatypeRequiredDescription
query[limit]numberAllows for pagination and sorting.
query[offset]numberAllows for pagination and sorting.
query[order]stringAllows for pagination and sorting.
metadatabooleanReturns batching metadata in the response

HEADERS

KeyDatatypeRequiredDescription
Acceptstring

RESPONSES

status: OK

{"roles":[{"id":"urn:uuid:87881799-18a9-aed5-9ceb-e9e7ac5220c9","uid":"magna ullamcominim cupidatat qui","name":"Sponsors","groups":["ad_group_name","ad_group_name"]},{"id":"urn:uuid:63056e2a-a3a6-a94d-42ba-fe03152ce8e0","uid":"aute commodo culpa temporculpa l","name":"Sponsors","groups":["ad_group_name","ad_group_name"]}],"_metadata":{"limit":-47970164,"offset":-11680312,"total":17697568,"next":"/endpoint?limit=10\u0026offset=60","previous":"/endpoint?limit=10\u0026offset=40"}}