# List record import rows

Read paged outcomes for an import: physical row number, created or updated record ID, or a safe error code. Source row contents are not returned.

POST https://api.brigg.app/v1/operations/integrations.ListRecordImportRows

## Access & visibility

Allow `integrations.ListRecordImportRows` on your API key.

**Workspace access by default.** Private member data requires [approved member delegation](https://developer.brigg.app/authentication#member-delegation) through `Brigg-Act-As`; the key supplies permissions while private ownership and project boundaries remain enforced.

[Set up authentication](https://developer.brigg.app/authentication) · [Choose permissions](https://developer.brigg.app/permissions)

## Request fields

Send a JSON object with the following fields. Required fields must be included; omit optional fields you do not need.
| Field | Type | Required | Description |
| --- | --- | --- | --- |
| `job_id` | string | Yes | Import job ID returned by StartRecordImport. At least 1 character. |
| `limit` | integer | No | Maximum number of results to return in this page. Continue with next_cursor when returned. Default: `100`. Greater than 0. |
| `cursor` | string | No | Copy next_cursor from the preceding response. Keep the same filters, sort and credential. At least 1 character. |

## Track progress and recover

Poll Get record import and page through List record import rows. Row numbers refer to physical input lines, starting at 1. A completed job can include failed rows: inspect the failed count. Validation failures are recorded and skipped; source access, key revocation, quota and service failures pause the job before the unfinished row.

Each successful record and its resume position commit together. After addressing a pause, call Resume record import with a **new** idempotency key. A lost response to a particular control request uses that request's original key. A stopped worker can be resumed after its lease expires; a queued job can be safely dispatched again. Cancellation stops subsequent commits and retains previously saved records; cancelled jobs cannot resume.

Use the same credential and member context to inspect or control this job. Work never acquires permissions added after it started: every row intersects the original approved grant with current access. If you replace the credential, start a new job with the same external references. The permanent reference matches already imported records even after request receipts expire. Correct invalid rows in a new file, keeping those references; Brigg does not guess a match from email or name.

## Response

Returns **200 OK** with a JSON body.

An empty `items` array means this page contains no matching visible results. Follow `next_cursor` when present.

Results contain row numbers, saved record IDs and error codes, never the original source data. Newly finished rows can appear on later pages; keep polling progress until the job settles.
| Field | Type | Required | Description |
| --- | --- | --- | --- |
| `items` | array of [Import row](#import-row-response-items) | Yes | Completed row outcomes for this import, ordered by physical input row number. Source contents are never returned. Pass next_cursor as cursor to continue when a next cursor is returned. |
| `has_more` | boolean | Yes | More completed row outcomes are currently available. |
| `next_cursor` | string or null | Yes | Pass this value as cursor to continue with the same filters, sort and credential. Null when there are no more results. |

### Import row · response.items[]

| Field | Type | Required | Description |
| --- | --- | --- | --- |
| `row` | integer | Yes | One-based physical line number in the source file. Minimum: 1. |
| `status` | string | Yes | Current state reported for this item. Treat values as extensible unless an enum is declared. Allowed: `"created"`, `"updated"`, `"failed"`. |
| `record_id` | string or null | Yes | Saved record ID, or null for a failed row. |
| `error_code` | string or null | Yes | Safe refusal code for a failed row, or null. |

## Pagination

Pass `next_cursor` as `cursor` on the next request, keeping the same query and acting identity. Stop when `next_cursor` is null. Treat the cursor as opaque; never construct or edit it.

```typescript
const query = {
  "job_id": "job_customer_sync",
  "limit": 100
};
let cursor;
do {
  const response = await fetch("https://api.brigg.app/v1/operations/integrations.ListRecordImportRows", {
    method: "POST",
    headers: {
      Authorization: `Bearer ${process.env.BRIGG_API_KEY}`,
      "Content-Type": "application/json",
    },
    body: JSON.stringify({ ...query, ...(cursor ? { cursor } : {}) }),
  });
  const page = await response.json();
  if (!response.ok) throw new Error(`${response.status}: ${page.message}`);
  for (const item of page.items) {
    console.log(item); // Process or upsert each result.
  }
  cursor = page.next_cursor;
} while (cursor);
```


## Errors & retries

This operation reads data. It needs no idempotency key and can be retried after a transient failure.

For rate limits, follow the server’s retry guidance and back off. See [HTTP errors](https://developer.brigg.app/http#errors) and [safe retries and limits](https://developer.brigg.app/reliability).

| HTTP status | Code | What to do |
| --- | --- | --- |
| 400 | `invalid_json` | Send a JSON object with Content-Type: application/json. |
| 400 | `invalid_input` | Check the request fields and types. |
| 401 | `invalid_key` | The workspace API key is missing, invalid or revoked. |
| 403 | `forbidden` | Check the key’s operation and resource grants. If Brigg-Act-As is supplied, the key must be authorized to delegate to that member. |
| 404 | `not_found` | The requested operation or resource is not available to this credential. |
| 429 | `rate_limited` | Wait for Retry-After before retrying. |

## Next steps

- [Start record import](https://developer.brigg.app/reference/integrations/StartRecordImport)
- [Get record import](https://developer.brigg.app/reference/integrations/GetRecordImport)
- [Resume record import](https://developer.brigg.app/reference/integrations/ResumeRecordImport)
- [Cancel record import](https://developer.brigg.app/reference/integrations/CancelRecordImport)
- [Upsert person](https://developer.brigg.app/reference/customers/UpsertPerson)
- [Create upload](https://developer.brigg.app/reference/documents/CreateUpload)

[Download OpenAPI](https://developer.brigg.app/openapi.json) · [Versioning & retirement](https://developer.brigg.app/versioning)

## Examples

### Customer synchronization

Fictional source and job IDs. Use the IDs and exact operation returned for your workspace.
#### cURL


```sh
curl 'https://api.brigg.app/v1/operations/integrations.ListRecordImportRows' \
  -H "Authorization: Bearer $BRIGG_API_KEY" \
  -H 'Content-Type: application/json' \
  --data-raw '{
  "job_id": "job_customer_sync",
  "limit": 100
}'
```

#### TypeScript


```typescript
const response = await fetch("https://api.brigg.app/v1/operations/integrations.ListRecordImportRows", {
  method: "POST",
  headers: {
    Authorization: `Bearer ${process.env.BRIGG_API_KEY}`,
    "Content-Type": "application/json",
  },
  body: JSON.stringify({
    "job_id": "job_customer_sync",
    "limit": 100
  }),
});
const result = await response.json();
if (!response.ok) throw new Error(`${response.status}: ${result.error} — ${result.message}`);
console.log(result);
```

#### Python


```python
import json
import os
from urllib.request import Request, urlopen
from urllib.error import HTTPError

payload = {
  "job_id": "job_customer_sync",
  "limit": 100
}
request = Request(
    "https://api.brigg.app/v1/operations/integrations.ListRecordImportRows",
    data=json.dumps(payload).encode("utf-8"),
    headers={
        "Authorization": f"Bearer {os.environ['BRIGG_API_KEY']}",
        "Content-Type": "application/json",
    },
    method="POST",
)
try:
    with urlopen(request) as response:
        print(json.load(response))
except HTTPError as error:
    print(error.code, json.load(error))
    raise
```

#### Response example


```json
{
  "items": [
    {
      "row": 1,
      "status": "created",
      "record_id": "e_alex",
      "error_code": null
    },
    {
      "row": 2,
      "status": "failed",
      "record_id": null,
      "error_code": "validation"
    }
  ],
  "has_more": false,
  "next_cursor": null
}
```

## JSON schemas


```json-schema-request
{
  "type": "object",
  "properties": {
    "job_id": {
      "type": "string",
      "minLength": 1,
      "description": "Import job ID returned by StartRecordImport."
    },
    "limit": {
      "type": "integer",
      "exclusiveMinimum": 0,
      "default": 100,
      "description": "Maximum number of results to return in this page. Continue with next_cursor when returned."
    },
    "cursor": {
      "type": "string",
      "minLength": 1,
      "description": "Copy next_cursor from the preceding response. Keep the same filters, sort and credential."
    }
  },
  "required": [
    "job_id"
  ],
  "additionalProperties": false,
  "examples": [
    {
      "job_id": "job_customer_sync",
      "limit": 100
    }
  ]
}
```


```json-schema-response
{
  "type": "object",
  "properties": {
    "items": {
      "type": "array",
      "items": {
        "type": "object",
        "title": "Import row",
        "properties": {
          "row": {
            "type": "integer",
            "minimum": 1,
            "description": "One-based physical line number in the source file."
          },
          "status": {
            "type": "string",
            "enum": [
              "created",
              "updated",
              "failed"
            ],
            "description": "Current state reported for this item. Treat values as extensible unless an enum is declared."
          },
          "record_id": {
            "type": [
              "string",
              "null"
            ],
            "description": "Saved record ID, or null for a failed row."
          },
          "error_code": {
            "type": [
              "string",
              "null"
            ],
            "description": "Safe refusal code for a failed row, or null."
          }
        },
        "required": [
          "row",
          "status",
          "record_id",
          "error_code"
        ],
        "additionalProperties": false
      },
      "description": "Completed row outcomes for this import, ordered by physical input row number. Source contents are never returned. Pass next_cursor as cursor to continue when a next cursor is returned."
    },
    "has_more": {
      "type": "boolean",
      "description": "More completed row outcomes are currently available."
    },
    "next_cursor": {
      "type": [
        "string",
        "null"
      ],
      "description": "Pass this value as cursor to continue with the same filters, sort and credential. Null when there are no more results."
    }
  },
  "required": [
    "items",
    "has_more",
    "next_cursor"
  ],
  "additionalProperties": false,
  "examples": [
    {
      "items": [
        {
          "row": 1,
          "status": "created",
          "record_id": "e_alex",
          "error_code": null
        },
        {
          "row": 2,
          "status": "failed",
          "record_id": null,
          "error_code": "validation"
        }
      ],
      "has_more": false,
      "next_cursor": null
    }
  ]
}
```