GET /v1/bulk/{job_id}/results

Family: Bulk and observability · Operation ID: v1_get_bulk_job_results

Access

Workspace API key: Authorization: Bearer <key>. The key is scoped to its workspace; the backend checks operation permissions and quota.

Open bulk jobs

Required scope: bulk

Create a key in Developer settings. Set API_BASE_URL to the current app origin.

Request example

curl --fail-with-body -X GET "$API_BASE_URL/v1/bulk/{job_id}/results" \
  -H "Authorization: Bearer $API_KEY"

Replace each {parameter} segment in the path with its URL-encoded value.

Parameters

[
  {
    "description": "V1 bulk job identifier",
    "in": "path",
    "name": "job_id",
    "required": true,
    "schema": {
      "format": "int32",
      "type": "integer"
    }
  },
  {
    "description": "Supported values: `json`, `csv`",
    "in": "query",
    "name": "format",
    "required": false,
    "schema": {
      "type": "string"
    }
  },
  {
    "in": "query",
    "name": "limit",
    "required": false,
    "schema": {
      "format": "int64",
      "minimum": 0,
      "type": "integer"
    }
  },
  {
    "in": "query",
    "name": "offset",
    "required": false,
    "schema": {
      "format": "int64",
      "minimum": 0,
      "type": "integer"
    }
  }
]

Responses

{
  "content": {
    "application/json": {
      "schema": {
        "$ref": "#/components/schemas/BulkJobResultsResponse"
      }
    },
    "text/csv": {
      "schema": {
        "format": "binary",
        "type": "string"
      }
    }
  },
  "description": "Bulk job results"
}

{
  "content": {
    "application/json": {
      "schema": {
        "$ref": "#/components/schemas/ErrorEnvelope"
      }
    }
  },
  "description": "Request error"
}

Download the full OpenAPI contract