Skip to main content
POST
Create Batch Job

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.

Body

application/json
report_type
enum<string>
required

Type of report to generate.

Available options:
floorplans,
property,
units
output_format
enum<string>
required

Format for the output file.

Available options:
csv,
jsonl,
parquet
start_date
string<date>
required

Start date for bulk data export (YYYY-MM-DD).

Example:

"2025-12-01"

end_date
string<date>
required

End date for bulk data export (YYYY-MM-DD).

Example:

"2025-12-31"

property_ids
integer[]
required

Array of property IDs to include in the report.

Example:
callback_url
string<uri>

Optional webhook URL to notify when the job completes.

Example:

"https://example.com/webhook"

Response

Job created 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>