v1/assignment_groups

get

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

List all assignment 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.

created_after

date-time

Return all records which are created after this date-time.

created_before

date-time

Return all records which are created before this date-time.

int32

≥ 1

Filter for a single assignment group ID.

ids[]

array of int32s

Filter for a list of assignment 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.

shiftplan_id

int32

≥ 1

Filter for a single shift schedule ID.

shiftplan_ids[]

array of int32s

Filter for a list of shift schedule IDs.

shiftplan_ids[]

updated_after

date-time

Return all records which are updated after this date-time.

updated_before

date-time

Return all records which are updated before this date-time.

Response

200Assignment groups successfully listed.