v1/shift_rotation_groups

get

https://shyftplan.com/api/v1/shift_rotation_groups

Get a collection of shift-system groups.

Query Params

user_email

string

required

This is a testing sandbox. We advise against using credentials for production accounts here.

E-mail address of the API user.

authentication_token

string

required

This is a testing sandbox. We advise against using credentials for production accounts here.

Authentication token - can be fetched by login action.

company_id

int32

required

≥ 1

ID of a shyftplan account.

ids[]

array of int32s

Filter for several shift-system group IDs.

ids[]

page

int32

≥ 1

Defaults to 1

Number of the page of responses to retrieve. First page: 1.

per_page

int32

1 to 1000

Defaults to 500

Number of responses on each page.

shift_ids[]

array of int32s

Filter for several Shift IDs

shift_ids[]

shift_rotation_ids[]

array of int32s

Filter for several shift-system IDs.

shift_rotation_ids[]

order_key

string

enum

Defaults to id

Sorting param

Allowed:

order_dir

string

Defaults to ASC

Sorting direction

Response

200

Get a collection of shift-system groups.

Language

Loading…

Response

Click Try It! to start a request and see the response here!