GuidesAPI ReferenceChangelogDiscussions
Back to 7shifts.comBecome a Partner
API Reference
These docs are for v2.2022.0501. Click to read the latest docs for v2.2023.0501.

List Roles

Sample Response

{
    "data": [
        {
            "id": 4320,
            "company_id": 1234,
            "location_id": 9876,
            "department_id": 4567,
            "color": "76a939",
            "num_stations": 2,
            "name": "Host",
            "job_code": "",
            "sort": 1,
            "stations": [
                {
                    "id": 1,
                    "role_id": 4320,
                    "station_number": 1,
                    "name": "Station 1"
                },
                {
                    "id": 2,
                    "role_id": 4320,
                    "station_number": 2,
                    "name": "Station 2"
                }
            ],
            "created": "2021-10-28T16:52:27+0000",
            "modified": "2022-06-16T20:55:20+0000"
        },
        {
            "id": 4321,
            "company_id": 1234,
            "location_id": 9876,
            "department_id": 4567,
            "color": "ff9800",
            "num_stations": 0,
            "name": "Bartender",
            "job_code": "",
            "sort": 2,
            "stations": [],
            "created": "2021-10-28T16:52:49+0000",
            "modified": "2021-10-28T16:58:17+0000"
        }
    ],
    "meta": {
        "cursor": {
            "current": "",
            "prev": null,
            "next": null,
            "count": 2
        }
    },
    "object": "roles"
}
Language
Authorization
Click Try It! to start a request and see the response here!