Skip to main content
POST
/
bulk_api
/
jobs
Create Batch Job
curl --request POST \
  --url https://data.apartmentiq.io/apartmentiq/api/v1/bulk_api/jobs \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "report_type": "floorplans",
  "output_format": "csv",
  "start_date": "2025-12-01",
  "end_date": "2025-12-31",
  "property_ids": [
    99001416,
    99001470
  ],
  "callback_url": "https://example.com/webhook"
}
'
{
  "report_type": "floorplans",
  "output_format": "csv",
  "property_ids": [
    123
  ],
  "start_date": "2023-12-25",
  "end_date": "2023-12-25",
  "job_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "status": "submitted",
  "callback_url": "<string>",
  "error_message": "<string>",
  "created_at": "2023-11-07T05:31:56Z",
  "updated_at": "2023-11-07T05:31:56Z"
}

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

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:
[99001416, 99001470]
​
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>