Skip to main content
GET
/
bulk_api
/
jobs
List Batch Jobs
curl --request GET \
  --url https://data.apartmentiq.io/apartmentiq/api/v1/bulk_api/jobs \
  --header 'Authorization: Bearer <token>'
{
  "jobs": [
    {
      "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"
    }
  ],
  "pagination": {
    "current_page": 1,
    "total_pages": 1,
    "total_count": 2,
    "per_page": 50
  }
}

Authorizations

Authorization
string
header
required

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

Query Parameters

page
integer
default:1

Page number for pagination (starts at 1).

Required range: x >= 1
per_page
integer
default:50

Number of results per page.

Required range: 1 <= x <= 100

Response

List of jobs retrieved successfully

jobs
Job · object[]
required

Array of batch jobs ordered by creation date (newest first).

pagination
object
required