REST API

Share Public API

Public document sharing and import endpoints for viewing shared Celerp documents and downloading or importing portable document bundles.

Generated from the Celerp 2.5.0 OpenAPI schema, 21 September 2026.

GET /docs/import

Import Shared Document

Import a document another Celerp shared, from its share link. The document arrives as a received document for review.

Parameters

NameInRequiredTypeDescription
linkquery--string, optionalThe share link the document was sent with.
srcquery--string, optionalPublic URL of the sending Celerp installation for a shared-document import.
tokenquery--string, optionalOpaque public token identifying the shared or payment resource.

Responses

StatusDescriptionBody
200Redirects to the new received document.--
422The request failed validation. The response lists each invalid field and why.HTTPValidationError

Example

curl -X GET http://localhost:8000/docs/import \
  -H "Authorization: Bearer $TOKEN"

POST /docs/import-bundle

Import Document Bundle

Import a portable Celerp document bundle supplied as request data or an uploaded file.

Responses

StatusDescriptionBody
200Redirects to the new received document.--

Example

curl -X POST http://localhost:8000/docs/import-bundle \
  -H "Authorization: Bearer $TOKEN"

GET /share/{token}

View Shared Document

Display a public, read-only view of the shared Celerp document associated with the share link.

Parameters

NameInRequiredTypeDescription
tokenpathyesstringOpaque public token identifying the shared or payment resource.

Responses

StatusDescriptionBody
200Returns the document as an HTML page.--
422The request failed validation. The response lists each invalid field and why.HTTPValidationError

Example

curl -X GET http://localhost:8000/share/:token \
  -H "Authorization: Bearer $TOKEN"

GET /share/{token}/bundle

Download Shared Document Bundle

Download the shared Celerp document as a portable Celerp JSON bundle for transfer or import.

Parameters

NameInRequiredTypeDescription
tokenpathyesstringOpaque public token identifying the shared or payment resource.

Responses

StatusDescriptionBody
200Returns the generated file or download response.--
422The request failed validation. The response lists each invalid field and why.HTTPValidationError

Example

curl -X GET http://localhost:8000/share/:token/bundle \
  -H "Authorization: Bearer $TOKEN"