API · Contact imports

List Contact Imports

List contact imports, optionally filtered by status (requires full access).

GET/contacts/importsFull access

Request parameters

Parameter	Type	Description
`status` query · optional	`"queued" \| "in_progress" \| "completed" \| "failed"`	Filter contact imports by status.
`limit` query · optional	`integer` 1–100 Default: 20	Number of results to return. See Pagination.
`after` query · optional	`string`	Resource ID for the next page. Cannot be combined with before. See Pagination.
`before` query · optional	`string`	Resource ID for the previous page. Cannot be combined with after. See Pagination.

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" \
  -H "Authorization: Bearer $OPENSEND_API_KEY"

Response

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

json

{
  "object": "list",
  "has_more": false,
  "data": [
    {
      "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

Filter by queued, in_progress, completed, or failed. New jobs enter in_progress immediately. Bounded scans can return shorter pages; follow has_more.

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