Get an upload session

Scope templates.read

Path parameters

idstringrequired

Returns

12 fields of the 200 answer

idstringrequired

kindenumrequired

imagefontcsvattachment

fileNamestringrequired

contentTypestringrequired

sizeBytesintegerrequired

statusenumrequired

PENDINGUPLOADEDPROCESSINGREADYREJECTEDEXPIRED

rejectionobject or nullrequired

2 fields

codestringrequired

reasonstring or nullrequired

resultIdstring or nullrequired

expiresAtdate-timerequired

completedAtdate-time or nullrequired

processedAtdate-time or nullrequired

createdAtdate-timerequired

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/uploads/upl_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.uploads.get('upl_01J9Y2K8QF4T6W8Z0B2D4F6H8K');

import os
from postbuddy import Client

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

result = client.uploads.get("upl_01J9Y2K8QF4T6W8Z0B2D4F6H8K")

Response

{
  "id": "upl_01J9Y2K8QF4T6W8Z0B2D4F6H8K",
  "kind": "image",
  "fileName": "customers.csv",
  "contentType": "Example",
  "sizeBytes": 1,
  "status": "READY",
  "rejection": {
    "code": "validation_failed",
    "reason": "Example"
  },
  "resultId": "obj_01J9Y2K8QF4T6W8Z0B2D4F6H8K",
  "expiresAt": "2026-10-16T09:14:02.000Z",
  "completedAt": "2026-10-16T09:14:02.000Z",
  "processedAt": "2026-10-16T09:14:02.000Z",
  "createdAt": "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"
}