Brivio API reference
Exports

Download an export. Stored files: 200 JSON {url, expires_at, filename, sha256} with a short-lived signed URL. Legacy files (and deployments without object storage): 200 with the raw bytes and Content-Disposition: attachment. 409 while running or when the job failed; 410 once the file expired (the sha256 stays in error.details). (scope: exports:read)

GET
/exports/{id}/download

Authorization

bearerAuth
headerAuthorizationBearer <token>

API key as Bearer token

Path Parameters

id*string

Response Body

Signed URL (JSON) or the file bytes

  1. response
data*

Short-lived signed URL. Fetch it WITHOUT the Authorization header.

error*null
curl -X GET "https://example.com/exports/string/download"
{  "data": {    "url": "http://example.com",    "expires_at": "2019-08-24T14:15:22Z",    "filename": "string",    "sha256": "string"  },  "error": null}

Start a csv/xlsx export. Runs in the background; poll GET /exports/{id} or subscribe to export.completed. Needs the exported entity read scope as well (403 SCOPE_REQUIRED names it). Requires Idempotency-Key. (scope: exports:write) POST

Previous Page

Get an export job (scope: exports:read) GET

Next Page