API Reference
Log In
API Reference
Start typing to search…

List the job history

get https://app.modzy.com/api/jobs/history

This endpoint returns a list of jobs within a given set of parameters.

It can be sorted by identifier, submittedBy, submittedJobs, status, createdAt, updatedAt, submittedAt, total, completed, fail, and model. When no values are provided, it sorts by createdAt. It is case-sensitive. Defaults to key.

📘

This collection route supports filters and pagination.

👍

Roles

All the roles can access this route.

Query Params
string

Filters by the date that the job was created in ISO8601 format.

string

Filters by the date that the job ended in ISO8601 format.

string

Filters by the job’s status categories. Values can be ALL, PENDING, and TERMINATED. Defaults to ALL. It can also filter by the actual job’s status values. Values can be SUBMITTED, COMPLETED, CANCELED, IN_PROGRESS, TIMEDOUT, and ERROR.

string

Filters by the model name and returns similar matches.

string

Filters by the firstName, lastName, or email and returns similar matches.

string

Filters by the key’s nickname and returns similar matches.

string

Filters by the model's identifier.

string

Filters by the model's version number.

Responses

Updated over 3 years ago

What’s Next
Did this page help you?
Language
Credentials
Request
Choose an example:
application/json

Updated over 3 years ago

What’s Next
Did this page help you?