Get an export with its download link

Scope organisation.read

Path parameters

idstringrequired

Returns

11 fields of the 200 answer

idstringrequired

kindenumrequired

itemssuppressionstemplates

statusenumrequired

PENDINGRUNNINGREADYFAILEDEXPIRED

fileNamestringrequired

contentTypestringrequired

countsobjectrequired

errorstring or nullrequired

downloadUrlstring or nullrequired

expiresAtdate-time or nullrequired

createdAtdate-timerequired

finishedAtdate-time or nullrequired

Responses

200Success

401Authentication required or API key invalid

403Permission or scope missing, organisation suspended

404Not found

429Rate limited for this API key and class; wait Retry-After seconds

otherError (RFC 9457 problem details)

Request

curl https://api.postbuddy.nl/v1/exports/exp_01J9Y2K8QF4T6W8Z0B2D4F6H8K \
  -H "Authorization: Bearer $POSTBUDDY_API_KEY"

import { PostBuddyClient } from '@postbuddy/sdk';

const client = new PostBuddyClient({ apiKey: process.env.POSTBUDDY_API_KEY! });

const result = await client.exports.get('exp_01J9Y2K8QF4T6W8Z0B2D4F6H8K');

import os
from postbuddy import Client

client = Client(os.environ["POSTBUDDY_API_KEY"])

result = client.exports.get("exp_01J9Y2K8QF4T6W8Z0B2D4F6H8K")

Response

{
  "id": "exp_01J9Y2K8QF4T6W8Z0B2D4F6H8K",
  "kind": "items",
  "status": "READY",
  "fileName": "customers.csv",
  "contentType": "Example",
  "counts": {
    "key": 1
  },
  "error": "Example",
  "downloadUrl": "https://example.com/r/Fq3ZtR8w",
  "expiresAt": "2026-10-16T09:14:02.000Z",
  "createdAt": "2026-10-16T09:14:02.000Z",
  "finishedAt": "2026-10-16T09:14:02.000Z"
}

{
  "type": "https://docs.postbuddy.nl/errors/not_found",
  "title": "Not found",
  "status": 404,
  "code": "not_found",
  "detail": "Not found",
  "requestId": "req_01J9Y2K8QF4T6W8Z0B2D4F6H8K"
}