Sign in

v1

latestOpenAPI 3.0.22026-07-24154101.1 MB
Roles

List Roles

get/v2/company/{company_id}/roles

Path parameters

company_idinteger required

Company ID

Query parameters

location_idinteger

Location ID - if provided all roles from this location will be included in the response

department_idinteger

Department ID - if provided all roles from this Department will be included in the response

idsinteger[]

Role IDs

modified_sincestring

A date with YYYY-MM-DD format

Example:2020-01-01

Return roles that have been modified since the specified date. Format YYYY-MM-DD

cursorstring

Cursor for the next or previous page of results.

limitinteger

The number of results desired per page.

Headers

x-api-versionstring

An API version

Example:2022-05-01

7shifts API version

x-company-guidstring uuid

Company GUID

Response

OK

object'roles' required

Example response

{
  "data": [
    {
      "created": "2021-01-01T00:00:00.000Z",
      "modified": "2021-01-01T00:00:00.000Z"
    }
  ]
}