API Reference

Filter all Jobs

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

Return a filtered list of all Jobs

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Query Params
integer

Number of items to return per page

integer

Current page number

Body Params
integer

Unique ID for this background job object

integer

ID of the owning firm

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:
date-time

Create timestamp in UTC

date-time

The last date and time this Background Job was updated

date-time

The last date and time this Background Job was queued

date-time

The last date and time this Background Job was started

date-time

The last date and time this Background Job was finished

date-time

The last date and time this Background Job was failed

integer

The user id for the user who created this Background Job

boolean

Returns true if the job is finished

boolean

Returns true if the job has been dequeued and is running

boolean

Returns true if the job failed due to an exception

boolean

Returns true if the job was cancelled by the user

integer

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

integer

Zero corresponds to the job waiting to be processed

date-time

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

date-time

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

Responses

Updated 13 days ago

Language
Credentials
Bearer
Bearer
LoadingLoading…
Response
Choose an example:
application/json

Updated 13 days ago