Documents

List managed documents

List only documents owned by the API-key principal, ordered by latest activity.

GET/api/v2/documents

Required scopedocuments.read

Parameters

limit

queryintegeroptional

Maximum number of documents to return.

Default: 25
Minimum: 1
Maximum: 100

cursor

querystringoptional

Opaque cursor returned by the preceding page. Do not inspect or construct it.

Maximum length: 512

Request body

This operation does not accept a request body.

Operational behavior

Idempotency

Mode: naturally safe. No idempotency header is required.

Retries

Retry transport failures, 429, and 503 with exponential backoff and full jitter. Honor Retry-After. Retry statuses: 429, 503. Honor Retry-After.

Retention

Each document includes its content expiry. Opaque cursors contain no document content and expire with list-state retention. Response field: retention.

Responses

200An owner-scoped page of documents.

Response headers

X-Correlation-Id

Response schema

DocumentListResponse

Document List Response object used by the Publishing API.

contractVersion

stringrequired

Contract Version value.

documents

array<Document>required

Documents value.

Maximum items: 100

pagination

objectrequired

Pagination value.

200 example

{
  "contractVersion": "publishing.lifecycle.v1",
  "documents": [
    {
      "createdAt": "2026-07-20T12:00:00.000Z",
      "id": "11111111-1111-4111-8111-111111111111",
      "lastActivityAt": "2026-07-20T12:10:00.000Z",
      "latestRevisionId": "22222222-2222-4222-8222-222222222222",
      "locale": "en",
      "retention": {
        "deleteRequestedAt": null,
        "deletedAt": null,
        "expiresAt": "2026-08-19T12:10:00.000Z",
        "policy": "managed_default"
      },
      "status": "active",
      "taskId": "executive-brief",
      "title": "Northstar Launch Brief",
      "updatedAt": "2026-07-20T12:10:00.000Z"
    }
  ],
  "pagination": {
    "hasMore": false,
    "nextCursor": null
  }
}

401The bearer credential is missing, malformed, expired, revoked, or belongs to the wrong environment.

Response headers

X-Correlation-Id

Response schema

PublishingErrorEnvelope

Publishing Error Envelope object used by the Publishing API.

contractVersion

stringrequired

Contract Version value.

error

objectrequired

Error value.

401 example

{
  "contractVersion": "publishing.lifecycle.v1",
  "error": {
    "category": "authentication",
    "code": "unauthorized",
    "httpStatus": 401,
    "message": "A valid API key is required.",
    "retryable": false
  }
}

403The principal is authenticated but lacks the operation's required scope.

Response headers

X-Correlation-Id

Response schema

PublishingErrorEnvelope

Publishing Error Envelope object used by the Publishing API.

contractVersion

stringrequired

Contract Version value.

error

objectrequired

Error value.

403 example

{
  "contractVersion": "publishing.lifecycle.v1",
  "error": {
    "category": "authorization",
    "code": "forbidden",
    "httpStatus": 403,
    "message": "The API key does not have the required scope.",
    "retryable": false
  }
}

404The resource does not exist or is not visible to this principal. Cross-tenant misses use the same response.

Response headers

X-Correlation-Id

Response schema

PublishingErrorEnvelope

Publishing Error Envelope object used by the Publishing API.

contractVersion

stringrequired

Contract Version value.

error

objectrequired

Error value.

404 example

{
  "contractVersion": "publishing.lifecycle.v1",
  "error": {
    "category": "authorization",
    "code": "not_found",
    "httpStatus": 404,
    "message": "The requested resource was not found.",
    "retryable": false
  }
}

429The request is temporarily rate limited. No final publication unit is consumed.

Response headers

X-Correlation-IdRetry-After

Response schema

PublishingErrorEnvelope

Publishing Error Envelope object used by the Publishing API.

contractVersion

stringrequired

Contract Version value.

error

objectrequired

Error value.

429 example

{
  "contractVersion": "publishing.lifecycle.v1",
  "error": {
    "category": "entitlement",
    "code": "rate_limited",
    "details": {
      "retryAfterSeconds": 30
    },
    "httpStatus": 429,
    "message": "Too many publishing requests. Retry after 30 seconds.",
    "retryable": true
  }
}

503A transient publishing, queue, renderer, or storage dependency is unavailable. No failed render consumes a final publication unit.

Response headers

X-Correlation-IdRetry-After

Response schema

PublishingErrorEnvelope

Publishing Error Envelope object used by the Publishing API.

contractVersion

stringrequired

Contract Version value.

error

objectrequired

Error value.

503 example

{
  "contractVersion": "publishing.lifecycle.v1",
  "error": {
    "category": "internal",
    "code": "service_unavailable",
    "details": {
      "retryAfterSeconds": 30
    },
    "httpStatus": 503,
    "message": "Publishing is temporarily unavailable.",
    "retryable": true
  }
}

Request

curl --request GET \
  "https://markdowntopdfconverter.com/api/v2/documents" \
  -H "Authorization: Bearer $MD2PDF_API_KEY"

Response

200 An owner-scoped page of documents.

{
  "contractVersion": "publishing.lifecycle.v1",
  "documents": [
    {
      "createdAt": "2026-07-20T12:00:00.000Z",
      "id": "11111111-1111-4111-8111-111111111111",
      "lastActivityAt": "2026-07-20T12:10:00.000Z",
      "latestRevisionId": "22222222-2222-4222-8222-222222222222",
      "locale": "en",
      "retention": {
        "deleteRequestedAt": null,
        "deletedAt": null,
        "expiresAt": "2026-08-19T12:10:00.000Z",
        "policy": "managed_default"
      },
      "status": "active",
      "taskId": "executive-brief",
      "title": "Northstar Launch Brief",
      "updatedAt": "2026-07-20T12:10:00.000Z"
    }
  ],
  "pagination": {
    "hasMore": false,
    "nextCursor": null
  }
}