API Reference
Home

v1/shifts/{id}/available_employments

get
https://shyftplan.com/api/v1/shifts//available_employments

List available employments

Path Params
int32
required

Shift ID

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.

boolean

Show only employees who is fully available

boolean

Show only employees who has no information about availabilities

boolean

Show only employees who is partially available

boolean

Show only employees who is partially available and partially unavailable

boolean

Show only employees who is partially unavailable

boolean

Show only employees who is fully unavailable

filters[tag_ids][]
array of int32s

Filter by an array of Employee Attribute IDs

filters[tag_ids][]
boolean

Show only employees without absences at this time

boolean

Show only employees without other shifts at this time

boolean

Show only employees with join requests for this shift

boolean

Show only employees with master position same as shift position

filters[with_these_qualification_ids][]
array of int32s

Show only employees with passed qualification ids

filters[with_these_qualification_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.

string

Search employees by name

string
enum
Defaults to asc

Sorting order.
Available options:

  • asc: Ascending order
  • desc: Descending order
Allowed:
int32
≥ 1

When sort_name=time_accounts, this is the ID of the time-account absence reason to use for sorting.

string
enum
Defaults to name

Sorting parameter.

Responses

Updated 3 months ago

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

Updated 3 months ago

Did this page help you?