RoofKit
Developer docsPartner API
API keys

Get share link

Public rate-limited read for a share-link token. This endpoint does not require a Partner API key.

Endpoint

GET/api/v1/share-links/{token}
Path parameters1 parameter
  • tokenrequired
    string

    —

Responses

200Public share-link details.

Headers

  • X-RateLimit-LimitMaximum requests allowed in the current window.
  • X-RateLimit-RemainingRequests remaining in the current window.
  • X-RateLimit-ResetISO timestamp when the current rate-limit window resets.
application/json
ShareLinkPublicResponse
400Request payload, query, or required header is invalid.
application/json
ErrorResponse
404Resource not found in the key-bound workspace.
application/json
ErrorResponse
409Request conflicts with idempotency or external event identity.
application/json
ErrorResponse
410Request conflicts with idempotency or external event identity.
application/json
ErrorResponse
429Rate limit exceeded for this key and endpoint or invalid-auth bucket.

Headers

  • X-RateLimit-LimitMaximum requests allowed in the current window.
  • X-RateLimit-RemainingRequests remaining in the current window.
  • X-RateLimit-ResetISO timestamp when the current rate-limit window resets.
  • Retry-AfterSeconds until the caller should retry.
application/json
ErrorResponse
500Internal authentication or server error.
application/json
ErrorResponse
Try it out
Path parameters