Help API
Generated from the Celerp 2.8.0 OpenAPI schema, 2 November 2026.
GET /help/for-route
Help For Route
The help pages that cover the screen at ``path`` (its query included), for the top bar Help panel. A list address carries its filters, so the query may run long; the path part is held to a path's length.
Parameters
| Name | In | Required | Type | Description |
|---|---|---|---|---|
path | query | yes | string | Address of the screen to find help pages for, starting with a slash, with its query if it has one. The path part is at most 300 characters and the whole address at most 4096. |
Responses
| Status | Description | Body |
|---|---|---|
200 | Successful Response | object |
422 | Validation Error | HTTPValidationError |
Example
curl -X GET http://localhost:8000/help/for-route \
-H "Authorization: Bearer $TOKEN"GET /help/page/{page_id}
Help Read
Read one help page: its numbered steps, with button and menu names as the user sees them.
Parameters
| Name | In | Required | Type | Description |
|---|---|---|---|---|
page_id | path | yes | string | Identifier of the help page, as returned by help search. |
Responses
| Status | Description | Body |
|---|---|---|
200 | Successful Response | object |
422 | Validation Error | HTTPValidationError |
Example
curl -X GET http://localhost:8000/help/page/:page_id \
-H "Authorization: Bearer $TOKEN"GET /help/search
Help Search
Search the help pages (written in English) for how to do something in Celerp. Returns up to 8 hits, best first, each with its id for help_read, whether its module is on for this company and whether this role may use its screens.
Parameters
| Name | In | Required | Type | Description |
|---|---|---|---|---|
q | query | yes | string | Words describing what to do, matched against the help pages (written in English). |
module | query | -- | string, optional | Optional module name, to search only that module's help pages. |
Responses
| Status | Description | Body |
|---|---|---|
200 | Successful Response | object |
422 | Validation Error | HTTPValidationError |
Example
curl -X GET http://localhost:8000/help/search \
-H "Authorization: Bearer $TOKEN"