v1/background_jobs

get

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

Return list of background jobs. Background jobs are deleted after 14 days.

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.

created_after

date-time

Filter to retrieve only those background jobs that were created after this date-time (ISO 8601).

ids[]

array of objects

Filter for a list of IDs of background jobs.

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.

updated_after

date-time

Filter to retrieve only background jobs that were updatet after this date-time (ISO 8601).

Responses

200Background jobs successfully listed.