API endpoints

Return a list of shifts.

get
https://sandbox-api.kenjo.io/api/v1/shift-plan/shifts

Returns a paginated list of shift plan shifts (cards). The query params filter the results.

Date range and default behaviour:

  • from and to are optional and delimit the date range of the shifts to retrieve. Format YYYY-MM-DD.
  • The date range is applied only when both from and to are provided and valid; if either is missing or invalid, the range is ignored.
  • By default (no valid date range provided), the endpoint returns all the shifts of the current month.
  • When both are provided, the range between from and to cannot exceed 3 months, otherwise the API returns 400.

Single shift:

  • _id is an optional filter to retrieve a single shift by its id. When provided, the response contains only that shift (an empty list if no shift matches).

Requires the Shift plan feature to be active for the organization; otherwise the API returns 403.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Query Params
string

Optional. Start of the date range (inclusive). Format YYYY-MM-DD. The date range is applied only when both from and to are provided and valid; otherwise it is ignored and the current month is returned.

string

Optional. End of the date range (inclusive). Format YYYY-MM-DD. The date range is applied only when both from and to are provided and valid; otherwise it is ignored and the current month is returned. When both are provided, the range between from and to cannot exceed 3 months.

string

Optional filter. Retrieve only the shifts of an exact day. Format YYYY-MM-DD.

string
enum

Optional filter. The publication status of the shift.

Allowed:
string

Optional filter. The _id of a single shift to retrieve. When provided, the response contains only that shift (an empty list if no shift matches).

string

Optional filter. The Kenjo employee id assigned to the shift.

string

Optional filter. The shift plan role id of the shift.

string

Optional filter. The location (office) id of the shift.

string

Optional filter. The shift plan working area id of the shift.

string
enum

Optional filter. The assignment state of the shift: open when it has no assigned employee, scheduled when an employee is assigned.

Allowed:
number
enum

Optional filter for pagination proposals. The maximum number of rows to retrieve which determines the size of the page. If this value is not provided then the limit will be 50. The maximum value of the limit is 100 items per page. Only are valid the following limit values: 25, 50 and 100.

Allowed:
number

Optional filter for pagination proposals. Determines the number of pages to skip when pagination is being used. If this value is not provided, by default the offset will be 1.

Headers
string
required

A valid bearer token.

Responses

401

UNAUTHORIZED. The Authorization header is incorrect, not provided or the token expired.

403

FORBIDDEN. The Shift plan feature is not active for the organization.

Updated 13 days ago

Language
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json

Updated 13 days ago