DocumentationReference

Other public routes

Document share links, service status, maintenance notices, signed-out privacy requests, public support threads and documentation feedback.

18 routes

Unauthenticated, and rate-limited per address. The share-link routes set Cache-Control: no-store and X-Robots-Tag: noindex on every answer. The last route is the one the feedback control at the foot of these pages posts to.

The guide for this family is Document shares.

POST /v1/documentation/feedback

POST /v1/documentation/feedback
Authentication
None

Request body — SubmitDocumentationFeedbackDto

pagePathrequired
string — IsString, Matches(/^\/(?:docs|documentation)
visitorIdrequired
string — IsUUID
helpfulrequired
boolean — IsBoolean
commentoptional
string — IsString, MaxLength(1000)
GET /v1/public/applications/{applicationId}/logo
Authentication
None

GET /v1/public/document-shares/{shareId}

GET /v1/public/document-shares/{shareId}
Authentication
None

POST /v1/public/document-shares/{shareId}/unlock

POST /v1/public/document-shares/{shareId}/unlock
Authentication
None

A document link protected by a password.

Request body — UnlockPersonalShareDto

passwordrequired
string — IsString, MinLength(1), MaxLength(72)

GET /v1/public/document-shares/personal-information/{shareId}

GET /v1/public/document-shares/personal-information/{shareId}
Authentication
None

POST /v1/public/document-shares/personal-information/{shareId}/unlock

POST /v1/public/document-shares/personal-information/{shareId}/unlock
Authentication
None

Request body — UnlockPersonalShareDto

passwordrequired
string — IsString, MinLength(1), MaxLength(72)

GET /v1/public/maintenance/{surface}

GET /v1/public/maintenance/{surface}
Authentication
None

POST /v1/public/privacy/requests

POST /v1/public/privacy/requests
Authentication
None

Request body — SubmitSignedOutPrivacyRequestDto

challengeIdrequired
string — IsUUID
coderequired
string — IsString, Matches(/^\d{6}$/)
requestTyperequired
string — IsIn(NON_ACTIVE_PRIVACY_REQUEST_TYPES)
reasonoptional
string — IsString, MaxLength(1000)
detailsoptional
string — IsString, MaxLength(2000)

POST /v1/public/privacy/requests/email-code

POST /v1/public/privacy/requests/email-code
Authentication
None

Request body — RequestSignedOutPrivacyCodeDto

emailrequired
string — IsEmail, MaxLength(320)

GET /v1/public/status

GET /v1/public/status
Authentication
None

POST /v1/public/support/contact

POST /v1/public/support/contact
Authentication
None

Request body — ContactDto

emailrequired
string — IsEmail, MaxLength(320)
nameoptional
string — IsString, MaxLength(120)
categoryrequired
string — IsString, IsIn([...CONTACT_CATEGORIES])
subjectoptional
string — IsString, MaxLength(180)
messagerequired
string — IsString, MinLength(10), MaxLength(5000)
captchaTokenoptional
string — IsString, MaxLength(TURNSTILE_TOKEN_MAX_LENGTH)

POST /v1/public/support/contact/confirm

POST /v1/public/support/contact/confirm
Authentication
None

Request body — ThreadTokenDto

tokenrequired
string — IsString, MinLength(20), MaxLength(200)

POST /v1/public/support/threads/follow-up

POST /v1/public/support/threads/follow-up
Authentication
None

Request body — ThreadFollowUpDto

subjectoptional
string — IsString, MinLength(5), MaxLength(180)
messagerequired
string — IsString, MinLength(10), MaxLength(10000)

POST /v1/public/support/threads/link/passkey/options

POST /v1/public/support/threads/link/passkey/options
Authentication
None

A discoverable passkey challenge, for proving which account a request belongs to.

POST /v1/public/support/threads/link/passkey/verify

POST /v1/public/support/threads/link/passkey/verify
Authentication
None

Request body — ThreadPasskeyLinkDto

challengeIdrequired
string — IsUUID
credentialrequired
Record<string, unknown> — IsObject

POST /v1/public/support/threads/read

POST /v1/public/support/threads/read
Authentication
None

Request body — ThreadTokenDto

tokenrequired
string — IsString, MinLength(20), MaxLength(200)

POST /v1/public/support/threads/reopen

POST /v1/public/support/threads/reopen
Authentication
None

Request body — ThreadTokenDto

tokenrequired
string — IsString, MinLength(20), MaxLength(200)

POST /v1/public/support/threads/reply

POST /v1/public/support/threads/reply
Authentication
None

Request body — ThreadReplyDto

bodyrequired
string — IsString, MinLength(2), MaxLength(10000)
attachmentsoptional
AttachmentDto[] — IsArray, ArrayMaxSize(ATTACHMENTS_PER_MESSAGE), ValidateNested({ each: true })

What this does not do

  • Responses are not listed. The API declares no response types, so this page describes what to send and who may send it. Recorded response shapes are on the guides.
  • This page is generated. It was read from the API at commit 234dba22. Editing it by hand changes nothing; the next sync overwrites it.

Verified against API commit 234dba22 on 2026-10-18. The routes, scopes, checklist, events and limits on these pages are read from that export, not typed.