Skip to content
ThreadkiteThreadkite Docs

A contacts import

GET
/v1/contacts/imports/{id}
curl --request GET \
  --url https://api.threadkite.app/v1/contacts/imports/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0 \
  --header 'Authorization: Bearer <token>'

Where an import you started is (queued, running with how many rows are done, done with what it did, or failed with why). Imports are kept for 30 days; other people’s and other keys’ are not found.

Authorizations

Section titled “Authorizations”

Parameters

Section titled “Parameters”

Path Parameters

Section titled “Path Parameters”
id
required
string format: uuid

Responses

Section titled “Responses”

200

Section titled “200”
Media typeapplication/json
object
id
required

Pass to GET /v1/contacts/imports/{id} to follow it

string format: uuid
status
required

queued (waiting to start), running, done (see result) or failed (see error)

string
Allowed values: queued running done failed
rows
required

Data rows in the file

integer
>= -9007199254740991 <= 9007199254740991
rowsDone
required

Rows gone through so far

integer
>= -9007199254740991 <= 9007199254740991
result
required
One of:
object
rows
required

Data rows in the file

integer
>= -9007199254740991 <= 9007199254740991
contactsCreated
required

New contacts

integer
>= -9007199254740991 <= 9007199254740991
contactsUpdated
required

Contacts you already had, matched by email address then phone number, with blanks filled, a company linked or consent recorded (nothing is overwritten)

integer
>= -9007199254740991 <= 9007199254740991
contactsUnchanged
required

Contacts you already had that the file adds nothing to

integer
>= -9007199254740991 <= 9007199254740991
contactsSkipped
required

Rows matching a contact in an inbox you are not in: left as they are, and not shown

integer
>= -9007199254740991 <= 9007199254740991
companiesCreated
required

New companies

integer
>= -9007199254740991 <= 9007199254740991
companiesMatched
required

Companies you already had, matched by company number, then domain, then name

integer
>= -9007199254740991 <= 9007199254740991
rowsWithErrors
required

Rows that cannot be imported (see errors)

integer
>= -9007199254740991 <= 9007199254740991
errors
required

Rows that were skipped and why (the first 100), without the values they quote: “This is not an email address”

Array<object>
object
line
required

The line in the file (the header is 1)

integer
>= -9007199254740991 <= 9007199254740991
messages
required
Array<string>
error
required

Why it failed, when it did

string
nullable
createdAt
required
string format: date-time
startedAt
required
string format: date-time
nullable
finishedAt
required
string format: date-time
nullable

Example 

{
  "status": "queued",
  "rows": 10000,
  "rowsDone": 2400,
  "result": {
    "rows": 120,
    "contactsCreated": 80,
    "contactsUpdated": 25,
    "contactsUnchanged": 10,
    "contactsSkipped": 0,
    "companiesCreated": 12,
    "companiesMatched": 30,
    "rowsWithErrors": 5,
    "errors": [
      {
        "line": 7,
        "messages": [
          "No email address or phone number"
        ]
      }
    ]
  }
}

401

Section titled “401”

Missing or invalid API key

Media typeapplication/json
object
statusCode
required
number
code
required

Stable machine-readable reason

string
message
required
string
errors

With code invalid: every problem with the request, by field (message is the first)

Array<object>
object
path
required

Dotted path inside the item, e.g. attributes.price.amountMinor

string
message
required
string

Example 

{
  "statusCode": 403,
  "code": "forbidden",
  "message": "You do not have permission to do that.",
  "errors": [
    {
      "message": "Enter the make"
    }
  ]
}

402

Section titled “402”

The organisation is on the Free plan (code upgrade_required)

Media typeapplication/json
object
statusCode
required
number
code
required

Stable machine-readable reason

string
message
required
string
feature
required

The feature that needs Pro

string
nullable
Allowed values: extraSeats connections aiAssistant aiReplies rules fullReports api inboxes bulkMessages videoMessages
upgradePath
required

Where to upgrade or pay, in the web app

string

Example 

{
  "statusCode": 402,
  "code": "upgrade_required",
  "message": "Connections are part of Pro. Upgrade to connect texts, calls and more.",
  "feature": "extraSeats",
  "upgradePath": "/settings/billing"
}

403

Section titled “403”

The key does not have the scope (or the person the permission)

Media typeapplication/json
object
statusCode
required
number
code
required

Stable machine-readable reason

string
message
required
string
errors

With code invalid: every problem with the request, by field (message is the first)

Array<object>
object
path
required

Dotted path inside the item, e.g. attributes.price.amountMinor

string
message
required
string

Example 

{
  "statusCode": 403,
  "code": "forbidden",
  "message": "You do not have permission to do that.",
  "errors": [
    {
      "message": "Enter the make"
    }
  ]
}

404

Section titled “404”
Media typeapplication/json
object
statusCode
required
number
code
required

Stable machine-readable reason

string
message
required
string
errors

With code invalid: every problem with the request, by field (message is the first)

Array<object>
object
path
required

Dotted path inside the item, e.g. attributes.price.amountMinor

string
message
required
string

Example 

{
  "statusCode": 403,
  "code": "forbidden",
  "message": "You do not have permission to do that.",
  "errors": [
    {
      "message": "Enter the make"
    }
  ]
}

429

Section titled “429”

Rate limit reached

Media typeapplication/json
object
statusCode
required
number
code
required

Stable machine-readable reason

string
message
required
string
retryAfter
required

Seconds until another request will be accepted

number

Example 

{
  "statusCode": 429,
  "code": "rate_limited",
  "message": "Too many requests. Each key can make 120 requests a minute; try again in 12 seconds.",
  "retryAfter": 12
}