Skip to main content
GET
/
v1
/
codon-exports
/
batches
/
{batch_id}
Get a codon export batch
curl --request GET \
  --url https://api.example.com/v1/codon-exports/batches/{batch_id} \
  --header 'Authorization: Bearer <token>'
{
  "id": "<string>",
  "strategy": "<string>",
  "host": "<string>",
  "options": {},
  "requested_formats": [
    "<string>"
  ],
  "export_ids": [
    "<string>"
  ],
  "created_at": "<string>",
  "object": "codon_export_batch"
}

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

​
batch_id
string<uuid>
required

Response

Successful Response

A codon export batch as returned by GET /v1/codon-exports/batches/{id}.

​
id
string
required

Opaque batch identifier (UUID).

​
strategy
string
required
​
host
string
required
​
options
Options · object
required
​
requested_formats
string[]
required
​
export_ids
string[]
required

Export UUIDs belonging to this batch.

​
created_at
string
required

ISO-8601 timestamp (UTC).

​
object
string
default:codon_export_batch

Polymorphic discriminator. Always codon_export_batch.

Allowed value: "codon_export_batch"