Skip to content

List print jobs ​

List recent CloudPrint print jobs with cursor pagination for operational screens and support tools.

GET/api/v1/print-jobsAPI version: v1operationId: listPrintJobsView as Markdown

What this endpoint does ​

List recent CloudPrint print jobs with cursor pagination for operational screens and support tools.

Authentication ​

Send a short-lived access token in Authorization: Bearer <access_token>.

Required scopes: print_jobs:read

Request ​

Production base URL: https://public-api.cloudprint.me/api/v1/print-jobs

Parameters ​

NameLocationTypeRequiredDescriptionConstraints
limitqueryintegernoMaximum number of resources to return on one page.min: 1; max: 100; default: 20
cursorquerystring | nullnoOpaque cursor for the requested result page; reuse it unchanged.—
X-Request-IdheaderstringnoOptional request identifier for tracing; CloudPrint returns a safe value in the response header.maxLength: 128; example: "order-100045-attempt-1"

Request body ​

This endpoint has no request body.

Example requests ​

cURL ​

bash
curl -sS 'https://public-api.cloudprint.me/api/v1/print-jobs?limit=20' \
  -H "Authorization: Bearer $ACCESS_TOKEN"

Response ​

HTTP status: 200 — Print jobs

Response fields ​

NameTypeRequiredDescriptionConstraints
print_jobsarrayyesPrint jobs returned for the current account and filters.—
next_cursorstring | nullyesOpaque cursor for the next result page; send it back unchanged.—

Example response ​

json
{
  "print_jobs": [
    {
      "print_job_id": "11111111-1111-4111-8111-111111111111",
      "document_id": "11111111-1111-4111-8111-111111111111",
      "document_mime_type": "application/pdf",
      "document_format": "pdf",
      "document_raw_language": null,
      "printer_id": "11111111-1111-4111-8111-111111111111",
      "status": "pending",
      "copies": 1,
      "intent": "shipping_label",
      "color_mode": "default",
      "duplex_mode": "default",
      "media_width_mm": 58,
      "media_height_mm": 40,
      "dpi": 203,
      "scale_mode": "none",
      "orientation": "default",
      "offset_x_mm": 0,
      "offset_y_mm": 0,
      "margin_top_mm": 0,
      "margin_right_mm": 0,
      "margin_bottom_mm": 0,
      "margin_left_mm": 0,
      "created_at": "2026-08-06T12:00:00Z",
      "reserved_at": "2026-08-06T12:00:00Z",
      "started_at": "2026-08-06T12:00:00Z",
      "completed_at": "2026-08-06T12:00:00Z",
      "failure_reason": "string"
    }
  ],
  "next_cursor": "string"
}

Errors ​

HTTP statusDescription
401OAuth bearer token is invalid
403OAuth bearer token does not include print_jobs:read
422Pagination parameters are invalid
429Rate limit exceeded
500Unexpected error

Integration guidance ​

  • Use next_cursor exactly as returned; do not construct cursors.
  • This endpoint is suitable for operator and support views, while a single known job should be read by ID.

Guides for integrating CloudPrint, connecting the local agent and operating print workflows.