List Account Jobs

get

https://api.authvia.com/v3/accounts/{account-id}/jobs

scope `jobs:read`

Lists the jobs from the last 30 days record for an Account. Allows for filtering and pagination to make for easier processing and focusing on results. There is also a webhook event that will fire for each job if you do not want to engage in polling.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Path Params

account-id

string

required

The unique identifier (AVID) of the Account/business for which the jobs will be listed for.

Query Params

pageKey

string

Used to go to the next page of results. Its best to use the x-link header and use the 'next' definition, as we've assembled it for you.

pageSize

integer

1 to 500

Defaults to 100

Specifies the maximum number of Job Lines to be returned in a single page of pagination, ensuring data retrieval remains manageable. Max 500.

status

string

enum

Filters the results down to only those that match the status provided.

Allowed:

createdAfter

int64

≥ 0

Only returns jobs created after the provided time (in epoch format, milliseconds). Useful when polling for newly created jobs.

Headers

string

enum

You can change the response type from JSON to CSV by indicating you want the response in text/csv.

Allowed:

Responses

Language

Credentials

Header

Loading…

Response

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

application/json

200Successfully retrieved account jobs. Returns a list of jobs from the last 30 days with processing status and statistics.

401The request is valid, but server authentication failed to verify the identity. The user's access token has either expired or is not valid. Creating a new token might resolve the issue.