A valid request URL is required to generate request examples{
"import": {
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"filename": "<string>",
"columns": [
"<string>"
],
"status": "pending",
"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>",
"status": "pending",
"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"
}
}Read an import and its lines
The report. ?outcome= narrows to one status, which is how the two lists that matter get read — failed and conflict — without paging through the successes.
A valid request URL is required to generate request examples{
"import": {
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"filename": "<string>",
"columns": [
"<string>"
],
"status": "pending",
"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>",
"status": "pending",
"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"
}
}Authorizations
A staff session token, uk_st_…. Minted by sign-up, sign-in or the two-factor exchange. Only a 401 means it is spent; not_a_member (403) is about the organization named in X-Organization-Id and leaves the token good for the others.
Headers
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: the answer is not_a_member (403), which does not mean the session is over. Absent, the session's default organization answers, or — if that membership was revoked while the session was open — any other one the caller still holds.
Path Parameters
Query Parameters
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.
live, test Only the lines with this outcome. Omit for every line.
pending, created, matched, conflict, failed Page size. Values outside 1–200 fall back to 50.
1 <= x <= 200x >= 0Response
The import and the lines behind it.