Skip to main content
GET
Get Job Status

Authorizations

Authorization
string
header
required

A valid API key generated in Topsort's UI. Use the TSE API key if calling auctions or events API, otherwise use the TSC API key.

Path Parameters

job-id
string<uuid>
required

The ID of the job to retrieve the status for.

Query Parameters

vendor_id
string | null

The ID of the vendor to retrieve the job status for.

Response

Successful Response

jobId
string<uuid>
required

The unique identifier for the queued job.

requestType
enum<string>
required

The type of operation the job represents.

Available options:
advertiser_creation,
campaign_creation,
campaign_update,
user_list_audience_creation
status
enum<string>
required

The current status of the job.

Available options:
not_started,
in_progress,
completed,
failed,
retrying
dsp
enum<string>[]
required

The DSP(s) associated with the job.

DSPs an offsite audience is synced to.

Available options:
google_ads,
meta,
tiktok_ads,
snapchat_ads
result
string | null

Optional result data in json format (e.g., {error: 'error message'}).