API Reference
Home

v1/hour_accounts/employments

get
https://shyftplan.com/api/v1/hour_accounts/employments

List of all employments with/without an hour account.

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.

string

Search for employments (by name or staff number) using this string.

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.

employment_ids[]
array of objects

Filter for a list of employment IDs.

employment_ids[]
Responses

Updated 6 months ago

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

Updated 6 months ago