Skip to main content
GET
/
batch-lookups
/
{job_id}
/
items
Get Batch Job Items
curl --request GET \
  --url https://api.incentives.leap.energy/alpha/batch-lookups/{job_id}/items \
  --header 'x-api-key: <api-key>'
{
  "items": [
    {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "job_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "status": "pending",
      "reference_id": "<string>",
      "address": {
        "street_1": "123 Main Street",
        "city": "San Francisco",
        "state_or_province_code": "CA",
        "postal_code": "94102",
        "country_code": "US",
        "street_2": "Apt 4B"
      },
      "building_type": "RESIDENTIAL",
      "device_ids": [
        123
      ],
      "result": {},
      "error_message": "<string>",
      "retry_count": 123,
      "created_at": "2023-11-07T05:31:56Z",
      "processed_at": "2023-11-07T05:31:56Z"
    }
  ],
  "total": 123,
  "limit": 123,
  "offset": 123
}

Overview

List items (lookups) for a batch job. Filter by status (pending, processing, completed, failed) and use limit/offset for pagination. Completed items include the full incentive result; failed items include error_message and retry_count.

Authorizations

x-api-key
string
header
required

API key for authentication. Include your Leap API key in the x-api-key header: x-api-key: leap_live_...

Path Parameters

job_id
string<uuid>
required

Query Parameters

status
enum<string>
Available options:
pending,
processing,
completed,
failed
limit
integer
default:50
Required range: 1 <= x <= 500
offset
integer
default:0
Required range: x >= 0

Response

List of queue items

items
object[]
total
integer
limit
integer
offset
integer