API Reference

Get all shifts

get
https://api.joinplanbase.com/api/v1/shifts

Retrieve shifts for the current user's organization.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Query Params
date-time
required

Return shifts from this date eg. 2024-05-09T08:00:00. Can't request more than 1 week at a time.

date-time
required

Return shifts up until this date e.g 2024-05-09T08:00:00. Can't request more than 1 week at a time.

string | null

Filter shifts by person ids (e.g. '4,6,7,8')

string | null

Filter shifts by e-mail addresses (e.g. '[email protected],[email protected]').

string | null

Object detail to be included with each shift (e.g. 'activities,teams,roles,people,license_types')

boolean | null
Defaults to false

Whether to exclude unpublished shifts

Responses

Updated 8 months ago

Did this page help you?
Language
Credentials
Bearer
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json

Updated 8 months ago

Did this page help you?