Export permission-filtered document metadata CSV (scope documents:read)

GET/api/v1/documents/export

Authorization

AuthorizationBearer token · headerrequired

Scoped API token (bnx_…). Required scopes are noted per operation.

Query parameters

relationIdstring

min length 1

Responses

200

CSV metadata export (capped with total/truncated response headers)

string

401

Unauthenticated

errorstringrequired

codestringrequired

rulestring

403

Forbidden (missing scope or permission)

errorstringrequired

codestringrequired

rulestring

429

Rate limited

errorstringrequired

codestringrequired

rulestring

Request

curl -X GET '/api/v1/documents/export' \
  -H 'Authorization: Bearer YOUR_TOKEN'

const response = await fetch("/api/v1/documents/export", {
  method: "GET",
  headers: {
    "Authorization": "Bearer YOUR_TOKEN"
  }
});

import requests

response = requests.get(
    "/api/v1/documents/export",
    headers={
        "Authorization": "Bearer YOUR_TOKEN"
    },
)

Response

"string"

{
  "error": "string",
  "code": "string",
  "rule": "string"
}

{
  "error": "string",
  "code": "string",
  "rule": "string"
}

{
  "error": "string",
  "code": "string",
  "rule": "string"
}