Skip to main content
GET
Get Batch Job Status

Authorizations

Authorization
string
header
required

Enter a Bearer token obtained via the OAuth client credentials flow or from the Access Tokens tab in your account settings.

Path Parameters

job_id
string<uuid>
required

UUID of the batch job to retrieve.

Response

Job details retrieved successfully

report_type
enum<string>
required
Available options:
floorplans,
property,
units
output_format
enum<string>
required
Available options:
csv,
jsonl,
parquet
property_ids
integer[]
required
start_date
string<date>
required
end_date
string<date>
required
job_id
string<uuid>
status
enum<string>
Available options:
submitted,
cancelled,
failed,
succeeded
callback_url
string
error_message
string
created_at
string<date-time>
updated_at
string<date-time>