v1/paygrades

get

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

List Paygrades for a company, optionally filtered by employment IDs

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.

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

Between 1 and 1000

updated_after

date-time

Return all records which are updated after a certain date and time.

created_after

date-time

Return all records which are created after a certain date and time.

updated_before

date-time

Return all records which are updated before a certain date and time.

created_before

date-time

Return all records which are created before a certain date and time.

employment_ids[]

array of objects

Filter for a list of employment IDs. When provided, returns paygrades applicable to those employments — company-wide, position-wide, per employment, and per employment on particular positions. Enables single-call retrieval when computing costs for many employees.

employment_ids[]

Response

200