List record import rows

Allow integrations.ListRecordImportRows on your API key.

Workspace access by default. Private member data requires approved member delegation through Brigg-Act-As; the key supplies permissions while private ownership and project boundaries remain enforced.

Set up authentication · Choose permissions

Send a JSON object with the following fields. Required fields must be included; omit optional fields you do not need.

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.

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.

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.

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);

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 and safe retries and limits.

• Start record import
• Get record import
• Resume record import
• Cancel record import
• Upsert person
• Create upload

Download OpenAPI · Versioning & retirement

JSON schemas

Use the complete schemas for validation or client generation.

{
  "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
    }
  ]
}

{
  "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
    }
  ]
}