Read an import and its lines

Error

A valid request URL is required to generate request examples

{
  "import": {
    "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "filename": "<string>",
    "columns": [
      "<string>"
    ],
    "total": 123,
    "pending": 123,
    "created": 123,
    "matched": 123,
    "conflicts": 123,
    "failed": 123,
    "created_at": "2023-11-07T05:31:56Z",
    "finished_at": "2023-11-07T05:31:56Z"
  },
  "rows": [
    {
      "line": 123,
      "email": "<string>",
      "external_id": "<string>",
      "name": "<string>",
      "customer": "<string>",
      "error_code": "<string>",
      "error": "<string>",
      "contact_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "conflicting_contact_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
    }
  ]
}

{
  "error": {
    "code": "forbidden",
    "message": "your role does not allow this action"
  }
}

{
  "error": {
    "code": "forbidden",
    "message": "your role does not allow this action"
  }
}

{
  "error": {
    "code": "forbidden",
    "message": "your role does not allow this action"
  }
}

{
  "error": {
    "code": "forbidden",
    "message": "your role does not allow this action"
  }
}

GET

organization

contact-imports

{id}

Error

A valid request URL is required to generate request examples

{
  "import": {
    "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "filename": "<string>",
    "columns": [
      "<string>"
    ],
    "total": 123,
    "pending": 123,
    "created": 123,
    "matched": 123,
    "conflicts": 123,
    "failed": 123,
    "created_at": "2023-11-07T05:31:56Z",
    "finished_at": "2023-11-07T05:31:56Z"
  },
  "rows": [
    {
      "line": 123,
      "email": "<string>",
      "external_id": "<string>",
      "name": "<string>",
      "customer": "<string>",
      "error_code": "<string>",
      "error": "<string>",
      "contact_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "conflicting_contact_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
    }
  ]
}

{
  "error": {
    "code": "forbidden",
    "message": "your role does not allow this action"
  }
}

{
  "error": {
    "code": "forbidden",
    "message": "your role does not allow this action"
  }
}

{
  "error": {
    "code": "forbidden",
    "message": "your role does not allow this action"
  }
}

{
  "error": {
    "code": "forbidden",
    "message": "your role does not allow this action"
  }
}

Autorizações

Authorization

string

header

obrigatório

A staff session token, uk_st_…. Minted by sign-up, sign-in or the two-factor exchange.

Cabeçalhos

X-Organization-Id

string

The organization the caller is acting on — the org_… code that appears in the panel URL. It identifies; the membership JOIN is what authorizes, so a forged code reads nothing. Absent, the session's default organization answers.

Parâmetros de caminho

string<uuid>

obrigatório

Parâmetros de consulta

environment

enum<string>

padrão:live

Which environment to act in. A view parameter, valid only on the staff surface — a machine credential never chooses its environment, it is resolved from the key.

Opções disponíveis:

live,

test

outcome

enum<string>

Only the lines with this outcome. Omit for every line.

Opções disponíveis:

pending,

created,

matched,

conflict,

failed

limit

integer

padrão:50

Page size. Values outside 1–200 fall back to 50.

Intervalo obrigatório: 1 <= x <= 200

offset

integer

padrão:0

Intervalo obrigatório: x >= 0

Resposta

The import and the lines behind it.

import

object

One CSV import. Progress is derived from its lines on every read rather than accumulated as the worker goes — the tallies are a query, never a counter, because a counter maintained by a job the queue may retry double-counts.

Show child attributes

rows

object[]