Skip to content

Get the current API client context

Confirm which CloudPrint account, client application and scopes are represented by the current access token.

GET/api/v1/meAPI version: v1operationId: getApiClientContextView as Markdown

What this endpoint does

Confirm which CloudPrint account, client application and scopes are represented by the current access token.

Authentication

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

Any valid CloudPrint API access token is accepted; no additional scope is required.

Request

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

Parameters

This endpoint has no path, query or custom header parameters.

Request body

This endpoint has no request body.

Example requests

cURL

bash
curl -sS https://public-api.cloudprint.me/api/v1/me \
  -H "Authorization: Bearer $ACCESS_TOKEN"

Response

HTTP status: 200 — Current API client context

Response fields

NameTypeRequiredDescriptionConstraints
account_idstring (uuid)yesStable UUID of the CloudPrint account that owns the resource.
account_namestringyesHuman-readable CloudPrint account name.example: "Acme Print Ops"
client_app_idstring | null (uuid)noStable identifier of the API credential represented by the current token.
client_app_namestring | nullnoAPI credential name used in account diagnostics.
application_idstring | null (uuid)noStable identifier of the Developer Application represented by the installation token.
application_namestring | nullnoDeveloper Application name shown to account operators.
authorization_modestringyesAuthorization model represented by the token: account client credentials or an app installation.enum: client_credentials, app_installation
installation_idstring | null (uuid)yesStable UUID of the App Installation that authorized the token.
scopesarraynoScopes granted to the current access token.example: ["agents:read","printers:read","documents:write","print_jobs:write","print_jobs:read"]
permissionsarraynoPermissions approved for the installation and included in this token.

Example response

json
{
  "account_id": "11111111-1111-4111-8111-111111111111",
  "account_name": "Acme Print Ops",
  "client_app_id": null,
  "client_app_name": null,
  "application_id": null,
  "application_name": null,
  "authorization_mode": "client_credentials",
  "installation_id": null,
  "scopes": [
    "agents:read",
    "printers:read",
    "documents:write",
    "print_jobs:write",
    "print_jobs:read"
  ],
  "permissions": [
    "string"
  ]
}

Errors

HTTP statusDescription
401OAuth bearer token is missing, invalid or no longer authorized
429Rate limit exceeded
500Unexpected error

Integration guidance

  • Use this check during onboarding and diagnostics to verify the account and granted scopes.
  • Do not call it before every business request; the access token already represents the client context.

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