Skip to content
Docs
Select language:English

/api/v1/exports/{id}

GET
/api/v1/exports/{id}
curl --request GET \
  --url https://example.com/api/v1/exports/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0

Parameters

Section titled “Parameters”

Path Parameters

Section titled “Path Parameters”
id
required
string format: uuid
/^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$/

Responses

Section titled “Responses”

200

Section titled “200”

Default Response

Media typeapplication/json
object
id
required
string format: uuid
/^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$/
scope
required
string
Allowed values: location me
locationId
string format: uuid
/^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$/
status
required
string
Allowed values: queued running done failed cancelled expired
progress
required
object
done
required
integer
>= -9007199254740991 <= 9007199254740991
total
required
integer
>= -9007199254740991 <= 9007199254740991
bytes
integer
>= -9007199254740991 <= 9007199254740991
sha256
string
includesSecrets
required
boolean
options
required
object
ended
required
boolean
trashed
required
boolean
history
required
boolean
aiCalls
required
boolean
readable
required
boolean
pdf
required
boolean
locale
required
string
digits
required
string
Allowed values: western eastern
createdAt
required
string
finishedAt
string
expiresAt
string
error
string
fileUrl
string
Example
{
  "scope": "location",
  "status": "queued",
  "options": {
    "digits": "western"
  }
}