API · Contact imports

Retrieve Contact Import

Retrieve a contact import’s status and row counts (requires full access).

GET/contacts/imports/{id}Full access

Request parameters

Parameter	Type	Description
`id` path · required	`string`	The Contact Import ID.

Request example

Set OPENSEND_BASE_URL=https://api.example.com and OPENSEND_API_KEY=os_replace_me on your server.

bash

curl -X GET "$OPENSEND_BASE_URL/contacts/imports/YOUR_id" \
  -H "Authorization: Bearer $OPENSEND_API_KEY"

Response

200 · application/json. Example IDs stand for IDs returned by your installation.

json

{
  "object": "contact_import",
  "id": "479e3145-dd38-476b-932c-529ceb705947",
  "status": "completed",
  "created_at": "2023-10-06 23:47:56.678+00",
  "completed_at": "2023-10-06 23:50:56.678+00",
  "counts": {
    "total": 100,
    "created": 80,
    "updated": 10,
    "skipped": 5,
    "failed": 5
  }
}

Behavior and errors

Counts report processed rows so far. Private diagnostics and CSV contents are not returned. Completed or failed jobs expire after seven days.

Use a full-access credential. Unknown or foreign resources return 404. See authentication, errors, rate limits, and pagination.