Share API
Document sharing API for creating, inspecting, updating, and revoking public share links for Celerp documents and lists.
Generated from the Celerp 2.5.0 OpenAPI schema, 21 September 2026.
GET /docs/{entity_id}/share
Get Document Share Status
Return the current public sharing status for a Celerp document or list.
Parameters
| Name | In | Required | Type | Description |
|---|---|---|---|---|
entity_id | path | yes | string | Identifier of the requested Celerp record. |
Responses
| Status | Description | Body |
|---|---|---|
200 | Returns the requested document share status result. | object |
422 | The request failed validation. The response lists each invalid field and why. | HTTPValidationError |
Example
curl -X GET http://localhost:8000/docs/:entity_id/share \
-H "Authorization: Bearer $TOKEN"POST /docs/{entity_id}/share
Create or Update Share Link
Create or update a public share link for a Celerp document or list.
Parameters
| Name | In | Required | Type | Description |
|---|---|---|---|---|
entity_id | path | yes | string | Identifier of the requested Celerp record. |
Request body
ShareCreateBody, optional
Responses
| Status | Description | Body |
|---|---|---|
200 | Returns the created or update share link or creation result. | object |
422 | The request failed validation. The response lists each invalid field and why. | HTTPValidationError |
Example
curl -X POST http://localhost:8000/docs/:entity_id/share \
-H "Authorization: Bearer $TOKEN" \
-H "Content-Type: application/json" \
-d '{ ... }'DELETE /docs/{entity_id}/share
Revoke Document Share Link
Revoke the public share link for a Celerp document or list.
Parameters
| Name | In | Required | Type | Description |
|---|---|---|---|---|
entity_id | path | yes | string | Identifier of the requested Celerp record. |
Responses
| Status | Description | Body |
|---|---|---|
200 | Returns the document's sharing state after the link is turned off. | object |
422 | The request failed validation. The response lists each invalid field and why. | HTTPValidationError |
Example
curl -X DELETE http://localhost:8000/docs/:entity_id/share \
-H "Authorization: Bearer $TOKEN"GET /docs/{entity_id}/share/state
Get Document Share State
Return the current sharing state for a Celerp document or list without changing it.
Parameters
| Name | In | Required | Type | Description |
|---|---|---|---|---|
entity_id | path | yes | string | Identifier of the requested Celerp record. |
Responses
| Status | Description | Body |
|---|---|---|
200 | Returns the requested document share state result. | object |
422 | The request failed validation. The response lists each invalid field and why. | HTTPValidationError |
Example
curl -X GET http://localhost:8000/docs/:entity_id/share/state \
-H "Authorization: Bearer $TOKEN"