v1/requests

List all Request

Query Params
string
required

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

E-mail address of the API user.

string
required

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

Authentication token - can be fetched by login action.

int32
required
≥ 1

ID of a shyftplan account.

date-time

Return all records which are created after

date-time

Return all records which are created before

int32

Filter for single Employment ID

employment_ids[]
array of int32s

Filter an array of Employment ID

employment_ids[]
int32

Filter for single Request ID

ids[]
array of int32s

Filter an array of Request ID

ids[]
boolean
Defaults to false

Filter for open shifts

int32
≥ 1
Defaults to 1

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

int32
1 to 1000
Defaults to 500

Number of responses on each page.

int32

Filter for single Shiftplan ID

shiftplan_ids[]
array of int32s

Filter an array of Shiftplan ID

shiftplan_ids[]
int32

Filter for single Shift ID

shift_ids[]
array of int32s

Filter an array of Shift ID

shift_ids[]
string
enum

Filter for single Request type

Allowed:
types[]
array of strings

Filter an array of Request type

types[]
date-time

Return all records which are updated after

date-time

Return all records which are updated before

Response
200

List all Request

Language
LoadingLoading…
Response
Click Try It! to start a request and see the response here!