Skip to content
Bottle

List shift patterns

GET
/shift-patterns
curl --request GET \
  --url https://example.com/shift-patterns \
  --cookie bottle.session_token=<bottle.session_token>

Authorizations

Section titled “Authorizations”

Responses

Section titled “Responses”

200

Section titled “200”

Patterns

Media typeapplication/json
object
items
required
Array<object>
object
id
required

UUID v7

string format: uuid
name
required
string
colour
required
string | null
cycleWeeks
required
integer
>= 1 <= 4
days
required
Array<object>
object
week
required
integer
<= 3
weekday
required
integer
>= 1 <= 7
start
required
string
/^([01]\d|2[0-3]):[0-5]\d$/
end
required
string
/^([01]\d|2[0-3]):[0-5]\d$/
breakMinutes
required
integer | null
<= 240
driverUserIds
required
Array<string>
createdAt
required
string format: date-time
updatedAt
required
string format: date-time
Example
{
  "items": [
    {
      "id": "019205d1-6e7a-7c3b-9f6e-3a2b1c0d9e8f",
      "days": [
        {
          "start": "07:30",
          "end": "07:30"
        }
      ]
    }
  ]
}

401

Section titled “401”

Not signed in

Media typeapplication/json
object
error
required
string
message
required
string
Example
{
  "error": "not_found",
  "message": "Customer not found"
}

403

Section titled “403”

Not a member, or without the permission this needs

Media typeapplication/json
object
error
required
string
message
required
string
Example
{
  "error": "not_found",
  "message": "Customer not found"
}

422

Section titled “422”

Validation failed

Media typeapplication/json
object
error
required
string
Allowed values: validation
message
required
string
issues
required
Array<object>
object
path
required
string
message
required
string
Example
{
  "error": "validation",
  "issues": [
    {
      "path": "email",
      "message": "Invalid email"
    }
  ]
}