API Reference
Home

v1/hour_accounts

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

Retrieve a list of hour accounts.

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.

employment_ids[]
array of objects

Filter for a list of employment IDs.

employment_ids[]
tag_ids[]
array of objects

Filter for a list of employment tag IDs.

tag_ids[]
employment_statuses[]
array of objects

Filter for a list of employment statuses.

employment_statuses[]
int32

Filter to retrieve only hour accounts with this minimum balance.

int32

Filter to retrieve only hour accounts with this maximum balance.

location_ids[]
array of objects

Filter for a list of location IDs.

location_ids[]
locations_position_ids[]
array of objects

Filter for a list of IDs of locations positions.

locations_position_ids[]
string
enum
Defaults to last_name

Sorting parameter, required if you submit a value for order_dir.

Allowed:
string
enum
Defaults to asc

Sorting order.
Available options:

  • asc: Ascending order
  • desc: Descending order
Allowed:
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.

Responses

Updated 6 months ago

Language
Response 
Click Try It! to start a request and see the response here! Or choose an example:
application/json
Updated 6 months ago