Get contact import job

Read the progress, counts and per-row errors of a contact import job.

GEThttps://api.tried.com.au/get-contact-import-job/{id}

Returns one import job created with Create contact import job. Poll it until status is complete or failed. Progress is saved after every 200 rows.

Request#

Field	Type	Required	Description
`id`	string	Yes	Path parameter. The `job_id`.

Example request#

curl https://api.tried.com.au/get-contact-import-job/contact_import_6d5c4b3a2f1e0d9c8b7a6f5e \
  -H "Authorization: Bearer $TRIED_API_KEY"

const id = "contact_import_6d5c4b3a2f1e0d9c8b7a6f5e";
const res = await fetch(`https://api.tried.com.au/get-contact-import-job/${id}`, {
  headers: { Authorization: `Bearer ${process.env.TRIED_API_KEY}` },
});
const job = await res.json();

import os, requests

job_id = "contact_import_6d5c4b3a2f1e0d9c8b7a6f5e"
res = requests.get(
    f"https://api.tried.com.au/get-contact-import-job/{job_id}",
    headers={"Authorization": f"Bearer {os.environ['TRIED_API_KEY']}"},
)
job = res.json()

Response#

200 OK

{
  "job_id": "contact_import_6d5c4b3a2f1e0d9c8b7a6f5e",
  "status": "complete",
  "source": "csv",
  "total": 1200,
  "processed": 1200,
  "created": 1150,
  "updated": 47,
  "errors": [
    { "row": 18, "message": "phone_number: phone_number must be E.164, e.g. +61412345678" },
    { "row": 402, "message": "email: Invalid email" },
    { "row": 977, "message": "phone_number: Required" }
  ],
  "error": null,
  "progress": 100,
  "created_timestamp": 1760850000000,
  "completed_timestamp": 1760850042000
}

Field	Type	Description
`job_id`	string	Job ID, prefix `contact_import_`.
`status`	string	`pending`, `running`, `complete` or `failed`.
`source`	string	`csv` or `json`.
`total`	integer	Rows in the upload.
`processed`	integer	Rows handled so far, including rejected rows.
`created`	integer	New contacts.
`updated`	integer	Existing contacts merged.
`errors`	array	Rejected rows: `row` is 1-based (the first data row of a CSV is row 1) and `message` lists the validation issues. At most 1000 items are kept.
`error`	string or null	Why the whole job failed, when `status` is `failed`.
`progress`	number	Percent of rows processed, one decimal place.
`completed_timestamp`	integer or null	Unix ms when the job finished.

Errors#

Status	When
`401`	Missing or invalid API key.
`403`	The key's IP allowlist or scopes reject the request. This route needs the `calls` scope.
`404`	`Import job <id> not found`.
`429`	Rate limit exceeded. See Rate limits.

See Errors for the body format.