Get Report Jobs

get

https://api.zylo.com/v2/reports/jobs

Required Permissions

admin

Rate Limit

limited

Query Params

error_message

string

The error message associated with the report job, if any.

string

Stringified UUIDv4.

rows

string

The number of rows in the generated report.

status

string

enum

The current status of the report job. "E" - The job has errored and will be not be available for download. "P" - The job is currently processing. "C" - The job has completed and is available for download.

Allowed:

zylo_created_at

string

Date and time the record was created in Zylo.

zylo_modified_at

string

Date and time the record was last modified in Zylo.

sort

string

Defaults to +zylo_created_at

Sort by any non-object or array value. Use +/- to indicate direction.

limit

double

≤ 1000

Defaults to 50

Number of results to bring back.

skip

double

Defaults to 0

Offset the results by this number.

cursor

string

id value to use cursor based pagination. Can be used in place of skip.

string

Search the results by this string.

Response

Language

Credentials

Bearer

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

200Ok