Get Import Job

Get the status and progress of a specific import job.

GET/api/v1/import-jobs/{id}

Import jobs are retained for 30 days after completion.

Authorization

Parameter Type Description

Parameter	Type	Description
`x-api-key`required	`string`	Your API key Example: `dk_...`

x-api-keyrequired

string

Your API key

Example: dk_...

Path Parameters

Parameter Type Description

Parameter	Type	Description
`id`required	`string`	The import job ID Example: `job_xyz789`

idrequired

string

The import job ID

Example: job_xyz789

Responses

{
  "id": "job_xyz789",
  "contactListId": "cl_abc123",
  "status": "processing",
  "progress": {
    "total": 1000,
    "processed": 450,
    "successful": 445,
    "failed": 5
  },
  "errors": [
    {
      "row": 23,
      "field": "phoneNumber",
      "message": "Invalid phone number format"
    }
  ],
  "createdAt": "2024-01-15T10:30:00Z",
  "updatedAt": "2024-01-15T10:31:30Z"
}

GET /api/v1/import-jobs/{id}

curl -X GET "https://voice.evryhealth.com/api/v1/import-jobs/{id}" \
  -H "x-api-key: YOUR_API_KEY"

Response200

{
  "id": "job_xyz789",
  "contactListId": "cl_abc123",
  "status": "processing",
  "progress": {
    "total": 1000,
    "processed": 450,
    "successful": 445,
    "failed": 5
  },
  "errors": [
    {
      "row": 23,
      "field": "phoneNumber",
      "message": "Invalid phone number format"
    }
  ],
  "createdAt": "2024-01-15T10:30:00Z",
  "updatedAt": "2024-01-15T10:31:30Z"
}

Job Status Values

Status	Description
`pending`	Job created, waiting to start processing
`processing`	Job is actively processing contacts
`completed`	Job finished successfully (may have some failed rows)
`failed`	Job failed due to a critical error
`cancelled`	Job was cancelled by the user

List Import Jobs

GET/api/v1/import-jobs

Get a list of all import jobs in your account.

Query Parameters

Parameter	Type	Description
`contactListId`	string	Filter by contact list ID
`status`	string	Filter by status
`page`	number	Page number (default: 1)
`limit`	number	Items per page (default: 20)

Cancel Import Job

POST/api/v1/import-jobs/{id}/cancel

Cancel a running import job. Only jobs with status pending or processing can be cancelled.

// Response
{
  "id": "job_xyz789",
  "status": "cancelled",
  "message": "Import job cancelled successfully"
}

Partial imports

Contacts that were already processed before cancellation will remain in the contact list.