Get an import batch
Platform module
GET/import-batches/{id}importBatches.get
A committed import batch. It can be undone within 7 days unless later edits depend on it. Returns one import batch with its `ETag`. A import batch the caller may not see returns 404.
- Requires the capability org.settings.read.
- OAuth scopes: org.
- Error statuses: 400, 401, 404, 429. Errors are RFC 9457 problem details.
Path and query parameters
| Field | Type | Required | Description |
|---|---|---|---|
| id | string (uuid) | Yes | Identifier of the import batch. |
| fields | Fields | No | Sparse fieldset: a comma-separated list of top-level fields to return. `id` is always returned.Constraints: pattern ^[a-z_][a-z0-9_]*(,[a-z_][a-z0-9_]*)*$ |
Response 200: ImportBatch
| Field | Type | Required | Description |
|---|---|---|---|
| id | string (uuid) | Yes | Identifier of the import batch. |
| org_id | string (uuid) | Yes | Identifier of the owning organization, derived from the parent row and never accepted from the caller. |
| created_at | string (date-time) | Yes | When the row was created. |
| created_by | string (uuid) | null | Yes | Identifier of the person who created the row; null when a seed, platform or system process created it. |
| updated_at | string (date-time) | Yes | When the row was last updated. |
| updated_by | string (uuid) | null | Yes | Identifier of the person who last updated the row; null when a seed, platform or system process updated it. |
| import_job_id | string (uuid) | Yes | Identifier of the import job. |
| committed_at | string (date-time) | null | Yes | When the batch was committed. |
| undone_at | string (date-time) | null | Yes | When the batch was undone. |
| undo_reason | string | null | Yes | Why the batch was undone.Constraints: length 1 to 2000 |
{
"id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
"org_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
"created_at": "2026-10-08T14:30:00Z",
"created_by": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
"updated_at": "2026-10-08T14:30:00Z",
"updated_by": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
"import_job_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
"committed_at": "2026-10-08T14:30:00Z",
"undone_at": "2026-10-08T14:30:00Z",
"undo_reason": "Wrong sheet imported."
}Code samples
curl -X GET "$XOS_BASE_URL/import-batches/0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f" \
-H "Authorization: Bearer $XOS_API_KEY"const { data, etag } = await xos.importBatches.get("0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f");response = xos.import_batches.get("0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f")xos import-batches get 0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f