Read an export job

GET

/v1/exports/{export_id}

curl --request GET \
  --url https://api.vocapable.com/v1/exports/example \
  --header 'Authorization: Bearer <token>'

Authorizations

• HTTPBearer

Parameters

Path Parameters

export_id

required

Export Id

string

Responses

200

Successful Response

Media typeapplication/json

ExportJob

A job as POST /v1/exports and GET /v1/exports/{id} return it.

columns is always the resolved list, never the empty request default: the set a job was accepted with is frozen at submission so a later change to a resource’s defaults cannot silently reshape a queued extraction.

object

id

required

Id

string

resource

required

Resource

string

Allowed values: contacts contact_attempts calls survey_responses shift_confirmations appointments dnc_entries scrub_results usage_events caller_requests

format

Format

string

default: csv

Allowed value: csv

status

required

JobStatus

Lifecycle shared by the async import and export jobs.

string

Allowed values: queued running completed failed

filters

Filters

object

key

additional properties

string

columns

Columns

Array<string>

row_count

Any of:

integer

integer

null

null

download_url

Any of:

string

string

null

null

expires_at

Any of:

string

string format: date-time

null

null

requested_by

Any of:

string

string

null

null

created_at

required

Created At

string format: date-time

updated_at

required

Updated At

string format: date-time

Example

{
  "resource": "contacts",
  "format": "csv",
  "status": "queued"
}

422

Validation Error

Media typeapplication/json

HTTPValidationError

object

detail

Detail

Array<object>

ValidationError

object

loc

required

Location

Array

msg

required

Message

string

type

required

Error Type

string

input

Input

ctx

Context

object

Example^generated

{
  "detail": [
    {
      "loc": [
        "example"
      ],
      "msg": "example",
      "type": "example",
      "input": "example",
      "ctx": {}
    }
  ]
}