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.8.0 OpenAPI schema, 2 November 2026.

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"

POST /docs/import-link

Import Shared Doc

Fetch a document another Celerp shared and file it in Received. Nothing is booked: the recipient reviews it there and books it explicitly.

Parameters

NameInRequiredTypeDescription
linkquery--string, optionalThe share link: the page the sender's document is shown on
srcquery--string, optionalOlder link form: the sender's public address, given with token
tokenquery--string, optionalOlder link form: the share token, given with src

Responses

StatusDescriptionBody
200Successful Response--
422Validation ErrorHTTPValidationError

Example

curl -X POST http://localhost:8000/docs/import-link \
  -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"