Optional filter query parameters

Parameter

Type

Description

location_id

Integer

Only fetch departments that have this location ID.

Example request

https://api.7shifts.com/v1/departments?location_id=123

Example response

{
  "status": "success",
  "total": 30,
  "offset": 0,
  "limit": 20,
  "data": [
    {
      "department": {
        "id": 789,
        "name": "FOH",
        "location_id": 1,
        "default": 0,
        "created": "2021-06-15 17:24:38",
        "modified": "2021-06-15 17:24:38"
      }
    },
    {
      "department": {
        "id": 123,
        "name": "Kitchen",
        "location_id": 1,
        "default": 0,
        "created": "2021-06-15 17:24:38",
        "modified": "2021-06-15 17:24:38"
      }
    },
    {
      "department": {
        "id": 456,
        "name": "Back of house",
        "location_id": 1,
        "default": 0,
        "created": "2018-09-17 16:08:54",
        "modified": "2018-09-17 16:08:54"
      }
    }
  ]
}
Language
Authentication
Basic
base64
:
Response
Click Try It! to start a request and see the response here!