Skip to content
Norbelys
Esc
↑↓navigate↵open⌘Jpreview

Retrieve an import: its status, counts, first problems and the link to its error report.

GET/v1/imports/{id}
Authorization
AuthorizationBearer token · headerrequired

An API key (nb_live_…, nb_test_…), a workspace token (nbs_…) or a CLI token (nbc_…).

Path parameters
idId_Importrequired

The import id (imp_…).

matches ^imp_[0-9a-f]{32}$
Responses
200

The import.

completed_atTimestamp | null
Show properties
One of:
Timestamp
string<date-time>
null
null
countsCountsrequired

An import's rows so far.

Show properties
importedinteger<int64>required

Rows that created a person or merged into one.

invalidinteger<int64>required

Rows that could not describe a person.

skippedinteger<int64>required

Rows whose address an earlier row of the file already imported.

totalinteger<int64>required

Rows read.

created_atTimestamprequired
errorsErrorsrequired

An import's problems: a first page and the report.

Show properties
dataRowProblem[]required

One problem per invalid row, the first 100.

max items 100
Show properties
Array of RowProblem
fieldstringrequired

The column or attribute at fault (email, fields.industry, …).

problemstringrequired
rowinteger<int64>required

The row: in a CSV file, its position as a spreadsheet numbers it (the header is row 1); in a JSON import, the person's position in people (from 1).

has_morebooleanrequired

True when more rows are invalid than data shows.

urlstring | null

A CSV of every problem of every invalid row (row,field,problem), once the import completed; the link works for 15 minutes from this read.

formatstringrequired

csv or json.

group_idstring | null

The group every imported person joins.

idId_Importrequired
matches ^imp_[0-9a-f]{32}$
job_idstring | null

The job doing the work.

last_errorLastError | null
Show properties
One of:
LastError
atTimestamprequired

When the job's row last changed: the moment of the error for a job that ended, and at or after it while the job is still waiting or running (the row keeps no separate time for its error).

codestringrequired

A short machine-readable code (error, lease_expired, unknown_kind, cancelled, …).

detailstringrequired

A human-readable explanation.

null
null
statusstringrequired

queued, processing, completed or failed. New values may be added.

updated_atTimestamprequired
401

No valid credential.

codestringrequired

The code from the closed registry; programs branch on it, never on the text. New codes may be added.

detailstringrequired

What went wrong, for a person; never an internal cause.

errorsFieldError[]

With validation_failed only: every invalid field.

Show properties
Array of FieldError
codestringrequired

What is wrong (required, range, length, format, invalid, …).

detailstringrequired

A safe, human-readable explanation.

pointerstringrequired

RFC 6901 pointer into the body, or ?name for a query parameter.

instancestringrequired

The request's path.

request_idstringrequired

The request's id, also in X-Request-Id: what support needs to find the request.

retry_afterinteger<int64> | null

With 429 and 503: the seconds to wait, as in Retry-After.

min 0
statusinteger<int32>required

The HTTP status.

min 0
titlestringrequired

Fixed per code.

typestringrequired

https://docs.norbelys.com/errors/<code>, a page that explains the code.

403

The credential lacks people:read.

codestringrequired

The code from the closed registry; programs branch on it, never on the text. New codes may be added.

detailstringrequired

What went wrong, for a person; never an internal cause.

errorsFieldError[]

With validation_failed only: every invalid field.

Show properties
Array of FieldError
codestringrequired

What is wrong (required, range, length, format, invalid, …).

detailstringrequired

A safe, human-readable explanation.

pointerstringrequired

RFC 6901 pointer into the body, or ?name for a query parameter.

instancestringrequired

The request's path.

request_idstringrequired

The request's id, also in X-Request-Id: what support needs to find the request.

retry_afterinteger<int64> | null

With 429 and 503: the seconds to wait, as in Retry-After.

min 0
statusinteger<int32>required

The HTTP status.

min 0
titlestringrequired

Fixed per code.

typestringrequired

https://docs.norbelys.com/errors/<code>, a page that explains the code.

404

No such import in this workspace.

codestringrequired

The code from the closed registry; programs branch on it, never on the text. New codes may be added.

detailstringrequired

What went wrong, for a person; never an internal cause.

errorsFieldError[]

With validation_failed only: every invalid field.

Show properties
Array of FieldError
codestringrequired

What is wrong (required, range, length, format, invalid, …).

detailstringrequired

A safe, human-readable explanation.

pointerstringrequired

RFC 6901 pointer into the body, or ?name for a query parameter.

instancestringrequired

The request's path.

request_idstringrequired

The request's id, also in X-Request-Id: what support needs to find the request.

retry_afterinteger<int64> | null

With 429 and 503: the seconds to wait, as in Retry-After.

min 0
statusinteger<int32>required

The HTTP status.

min 0
titlestringrequired

Fixed per code.

typestringrequired

https://docs.norbelys.com/errors/<code>, a page that explains the code.

Try it
Server
Authorization
Parameters
Request
curl -X GET 'https://api.norbelys.com/v1/imports/imp_0190f8a2b4c87a10b6d2e4f6a8c0e2f4' \
  -H 'Authorization: Bearer YOUR_TOKEN'
Response
{
  "completed_at": "2019-08-24T14:15:22Z",
  "counts": {
    "imported": 0,
    "invalid": 0,
    "skipped": 0,
    "total": 0
  },
  "created_at": "2019-08-24T14:15:22Z",
  "errors": {
    "data": [
      {
        "field": "string",
        "problem": "string",
        "row": 0
      }
    ],
    "has_more": true,
    "url": "string"
  },
  "format": "string",
  "group_id": "string",
  "id": "imp_0190f8a2b4c87a10b6d2e4f6a8c0e2f4",
  "job_id": "string",
  "last_error": {
    "at": "2019-08-24T14:15:22Z",
    "code": "string",
    "detail": "string"
  },
  "status": "string",
  "updated_at": "2019-08-24T14:15:22Z"
}