API Reference
Home

v1/evaluations

get
https://shyftplan.com/api/v1/evaluations

List all Evaluations

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[]
string
enum

Filter for a single employment status

Allowed:
emp_statuses[]
array of strings

Filter for an array of employment statuses

emp_statuses[]
date-time
ids[]
array of int32s

Filter an array of Evaluation ID

ids[]
boolean
Defaults to true

Include Payments in response

int32

Filter for single LocationsPosition ID

locations_position_ids[]
array of int32s

Filter an array of LocationsPosition ID

locations_position_ids[]
int32

Filter for single Location ID

location_ids[]
array of int32s

Filter an array of Location ID

location_ids[]
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 Position ID

position_ids[]
array of int32s

Filter an array of Position ID

position_ids[]
string
enum

Filter for deleted/undeleted positions

Allowed:
int32

Filter for single Shift ID

shift_ids[]
array of int32s

Filter an array of Shift ID

shift_ids[]
date-time
string
enum

State of the evaluation.

Allowed:
date-time

Return all records which are updated after

date-time

Return all records which are updated before

Response

Updated 3 days ago

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

Updated 3 days ago