v1/employments_positions

get

https://shyftplan.com/api/v1/employments_positions

List all EmploymentsPositions.

Query Params

user_email

string

required

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

E-mail address of the API user.

authentication_token

string

required

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

Authentication token - can be fetched by login action.

company_id

int32

required

≥ 1

ID of a shyftplan account.

company_ids[]

array of int32s

Filter an array of Company ID

company_ids[]

created_after

date-time

Return all records which are created after

created_before

date-time

Return all records which are created before

employment_id

int32

Filter for single Employment ID

employment_ids[]

array of int32s

Filter an array of Employment ID

employment_ids[]

int32

≥ 1

Filter for single EmploymentsPosition ID

ids[]

array of int32s

Filter an array of EmploymentsPosition ID

ids[]

location_id

int32

Filter for single Location ID

locations_position_id

int32

≥ 1

Filter for ID of a single locations position

locations_position_ids[]

array of int32s

Filter for a list of IDs of locations positions.

locations_position_ids[]

page

int32

≥ 1

Defaults to 1

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

per_page

int32

1 to 1000

Defaults to 500

Number of responses on each page.

response_format

string

enum

Defaults to plain

Set to nested if result should look like {items: [...], total: x}

Allowed:

updated_after

date-time

Return all records which are updated after

updated_before

date-time

Return all records which are updated before

search_string

string

Search for position by name

Responses

200Successfully listed

401Unauthorized

422Invalid request