Skip to content

Developer portal

GET /r/{token}

Read public share metadata and high-level scan readiness overview.

GET /r/{token}Public

Summary

Read public share metadata and high-level scan readiness overview.

Example

Response

{
  "status": "success",
  "token": "shr_01J9W8AX3X",
  "scope": "passport",
  "expires_at": "2026-06-20T12:00:00Z"
}

Errors

CodeMeaningTypical causeSuggested fix
404Not foundScan, schedule, share link, or resource id does not exist or expired.Verify id and tenant scope; share links expire per expiresHours.
422Unprocessable entityInvalid payload shape, unsupported scenario, or infeasible constraints.Fix field errors in response detail; relax constraints and retry.
429Too many requestsPer-key rate limit exceeded (default 300 requests per minute) or public endpoint limit.Backoff with jitter; cache results; request higher limit for production.
500Internal server errorUnexpected backend failure; includes requestId in response.Retry with exponential backoff; contact support with requestId if persistent.

See the full errors reference.