Skip to main content
GET
/
exports
/
{id}
Get one export's status
curl --request GET \
  --url https://www.consentfly.com.br/api/v1/exports/{id} \
  --header 'Authorization: <api-key>'
{
  "id": "exp_01HK8WD2QXKB4R7N9F1H3P5T0G",
  "site_id": "6b8b4567-327a-4d10-92a5-9e8c4f5a7d12",
  "format": "csv",
  "status": "ready",
  "row_count": 12480,
  "bytes_written": 2458912,
  "error_message": "",
  "requested_at": "2026-05-24T09:00:00Z",
  "completed_at": "2026-05-24T09:02:18Z",
  "expires_at": "2026-05-31T09:02:18Z",
  "download_url": "https://www.consentfly.com.br/api/v1/exports/download/eyJhbGciOiJIUzI1NiJ9.abc"
}

Documentation Index

Fetch the complete documentation index at: https://docs.consentfly.com/llms.txt

Use this file to discover all available pages before exploring further.

Authorizations

​
Authorization
string
header
required

Autenticação por API Key no formato Authorization: Bearer sk-... (sempre inclua o prefixo Bearer).

Gere sua chave em /dashboard/api-keys após criar a conta e verificar o e-mail. A chave é exibida uma única vez no momento da criação — armazene em variável de ambiente no seu backend. Nunca exponha em código client-side.

Path Parameters

​
id
string
required

Export UUID

Response

OK

Job de export de consentimentos (síncrono streamed ou assíncrono).

​
id
string

Identificador único do job.

Example:

"exp_01HK8WD2QXKB4R7N9F1H3P5T0G"

​
site_id
string<uuid>

UUID do site exportado.

Example:

"6b8b4567-327a-4d10-92a5-9e8c4f5a7d12"

​
format
string

Formato de saída.

Example:

"csv"

​
status
enum<string>

Estado atual do job.

Available options:
queued,
running,
ready,
failed,
expired,
streamed
Example:

"ready"

​
row_count
integer

Quantidade de linhas exportadas.

Example:

12480

​
bytes_written
integer<int64>

Tamanho em bytes do arquivo gerado.

Example:

2458912

​
error_message
string

Preenchido quando status=failed.

Example:

""

​
requested_at
string<date-time>
Example:

"2026-05-24T09:00:00Z"

​
completed_at
string<date-time> | null
Example:

"2026-05-24T09:02:18Z"

​
expires_at
string<date-time> | null

Quando o link assinado expira (7 dias após completed_at).

Example:

"2026-05-31T09:02:18Z"

​
download_url
string | null

Presente apenas quando status=ready. URL assinada com TTL de 10 minutos.

Example:

"https://www.consentfly.com.br/api/v1/exports/download/eyJhbGciOiJIUzI1NiJ9.abc"