Filter all Jobs

post

https://api.bridgeft.com/v2/jobs/filter

Return a filtered list of all Jobs

Query Params

pager.limit

integer

Number of items to return per page

pager.page

integer

Current page number

Body Params

integer

Unique ID for this background job object

firm_id

integer

ID of the owning firm

job_type

string

enum

The type of this job. Currently either b for a billing report, pdfrp for a PDF report, or bd for a bulk download

Allowed:

created_dt_utc

date-time

Create timestamp in UTC

last_updated_dt_utc

date-time

The last date and time this Background Job was updated

queued_dt_utc

date-time

The last date and time this Background Job was queued

started_dt_utc

date-time

The last date and time this Background Job was started

finished_dt_utc

date-time

The last date and time this Background Job was finished

failed_dt_utc

date-time

The last date and time this Background Job was failed

created_by_id

integer

The user id for the user who created this Background Job

is_finished

boolean

Returns true if the job is finished

is_running

boolean

Returns true if the job has been dequeued and is running

is_failed

boolean

Returns true if the job failed due to an exception

is_revoked

boolean

Returns true if the job was cancelled by the user

num_steps

integer

The progress of a job. Note that the number of steps might not be known until the job is dequeued.

current_step

integer

Zero corresponds to the job waiting to be processed

email_notification

date-time

If true, this sends an email notification to the user who created the job

email_notification_dt_utc

date-time

The timestamp at which the email notification was sent. Only applies when email_notification is enabled

Responses

Language

Credentials

Bearer

Response

Choose an example:

application/json

200An enveloped list of Jobs

400Bad Request