Settings API
System settings and Celerp Connect API for account setup, cloud connection state, billing, backups, connectors, and partner configuration.
Generated from the Celerp 2.5.0 OpenAPI schema, 21 September 2026.
GET /settings/account-methods
List Account Sign-In Methods
Return the optional account sign-in methods currently available for this Celerp installation.
Responses
| Status | Description | Body |
|---|---|---|
200 | Returns the requested account sign-in methods. | object |
Example
curl -X GET http://localhost:8000/settings/account-methods \
-H "Authorization: Bearer $TOKEN"POST /settings/account-signup
Start Account Sign-Up
Start the supported account sign-up flow.
Request body
object
Responses
| Status | Description | Body |
|---|---|---|
200 | Returns the result of the start account sign-up operation. | object |
422 | The request failed validation. The response lists each invalid field and why. | HTTPValidationError |
Example
curl -X POST http://localhost:8000/settings/account-signup \
-H "Authorization: Bearer $TOKEN" \
-H "Content-Type: application/json" \
-d '{ ... }'GET /settings/account-status
Get Account Connection Status
Return the current account connection and sign-in status for this Celerp installation.
Responses
| Status | Description | Body |
|---|---|---|
200 | Returns the requested account connection status result. | object |
Example
curl -X GET http://localhost:8000/settings/account-status \
-H "Authorization: Bearer $TOKEN"GET /settings/backup-status
Get Backup Scheduler Status
Return scheduled-backup status, including recent backup results and upcoming scheduled runs.
Responses
| Status | Description | Body |
|---|---|---|
200 | Returns the requested backup scheduler status result. | object |
Example
curl -X GET http://localhost:8000/settings/backup-status \
-H "Authorization: Bearer $TOKEN"GET /settings/billing-catalog
Get Billing Catalog
Return the current billing catalog information available for display in Celerp settings.
Responses
| Status | Description | Body |
|---|---|---|
200 | Returns the requested billing catalog result. | object |
Example
curl -X GET http://localhost:8000/settings/billing-catalog \
-H "Authorization: Bearer $TOKEN"POST /settings/cloud-accept-tos
Accept Celerp Connect Terms
Record acceptance of the current Celerp Connect terms of service.
Responses
| Status | Description | Body |
|---|---|---|
200 | Returns the Connect status and the installation's public URL. | object |
Example
curl -X POST http://localhost:8000/settings/cloud-accept-tos \
-H "Authorization: Bearer $TOKEN"POST /settings/cloud-activate
Activate Celerp Connect
Activate Celerp Connect for this installation, or refresh its connection.
Request body
object, optional
Responses
| Status | Description | Body |
|---|---|---|
200 | Returns the connection status, or `verification_required` when an email code is needed first. | object |
422 | The request failed validation. The response lists each invalid field and why. | HTTPValidationError |
Example
curl -X POST http://localhost:8000/settings/cloud-activate \
-H "Authorization: Bearer $TOKEN" \
-H "Content-Type: application/json" \
-d '{ ... }'POST /settings/cloud-claim
Claim Celerp Connect Installation
Claim the current Celerp installation for the authenticated Connect account.
Request body
object
Responses
| Status | Description | Body |
|---|---|---|
200 | Returns the claim result, or an error with the number of attempts left when the code is wrong. | object |
422 | The request failed validation. The response lists each invalid field and why. | HTTPValidationError |
Example
curl -X POST http://localhost:8000/settings/cloud-claim \
-H "Authorization: Bearer $TOKEN" \
-H "Content-Type: application/json" \
-d '{ ... }'POST /settings/cloud-disconnect
Disconnect Celerp Connect
Disconnect the installation from Celerp Connect.
Responses
| Status | Description | Body |
|---|---|---|
200 | Returns `disconnected: true`. | object |
Example
curl -X POST http://localhost:8000/settings/cloud-disconnect \
-H "Authorization: Bearer $TOKEN"POST /settings/cloud-send-otp
Send Celerp Connect Verification Code
Request a one-time verification code for the supported Celerp Connect sign-in or setup flow.
Request body
object
Responses
| Status | Description | Body |
|---|---|---|
200 | Returns confirmation that the code was sent, or an error. | object |
422 | The request failed validation. The response lists each invalid field and why. | HTTPValidationError |
Example
curl -X POST http://localhost:8000/settings/cloud-send-otp \
-H "Authorization: Bearer $TOKEN" \
-H "Content-Type: application/json" \
-d '{ ... }'GET /settings/cloud-status
Get Celerp Connect Status
Return the current Celerp Connect connection and subscription status used by the settings UI.
Responses
| Status | Description | Body |
|---|---|---|
200 | Returns the requested Celerp connect status result. | object |
Example
curl -X GET http://localhost:8000/settings/cloud-status \
-H "Authorization: Bearer $TOKEN"POST /settings/cloud/billing-portal
Open Subscription Billing Portal
Create a billing-management session.
Responses
| Status | Description | Body |
|---|---|---|
200 | Returns the billing portal URL. | object |
Example
curl -X POST http://localhost:8000/settings/cloud/billing-portal \
-H "Authorization: Bearer $TOKEN"GET /settings/connectors-catalog
Get External Connector Catalog
Return the external connector catalog available to this Celerp installation.
Responses
| Status | Description | Body |
|---|---|---|
200 | Returns the requested external connector catalog result. | object |
Example
curl -X GET http://localhost:8000/settings/connectors-catalog \
-H "Authorization: Bearer $TOKEN"GET /settings/connectors/{platform}/authorize-url
Get Connector Authorization URL
Return the authorization URL used to connect the selected external platform.
Parameters
| Name | In | Required | Type | Description |
|---|---|---|---|---|
platform | path | yes | string | External connector platform name. |
shop | query | -- | string | Store or shop identifier used by the connector authorization flow. |
Responses
| Status | Description | Body |
|---|---|---|
200 | Returns the requested connector authorization URL result. | object |
422 | The request failed validation. The response lists each invalid field and why. | HTTPValidationError |
Example
curl -X GET http://localhost:8000/settings/connectors/:platform/authorize-url \
-H "Authorization: Bearer $TOKEN"POST /settings/partner-claim/accept
Accept Partner Claim
Accept a previously resolved partner claim.
Request body
object
Responses
| Status | Description | Body |
|---|---|---|
200 | Returns the partner ID and the new commercial mode. | object |
422 | The request failed validation. The response lists each invalid field and why. | HTTPValidationError |
Example
curl -X POST http://localhost:8000/settings/partner-claim/accept \
-H "Authorization: Bearer $TOKEN" \
-H "Content-Type: application/json" \
-d '{ ... }'POST /settings/partner-claim/resolve
Resolve Partner Claim
Preview the partner associated with a claim request without accepting the relationship.
Request body
object
Responses
| Status | Description | Body |
|---|---|---|
200 | Returns the partner's name and details so you can review them before accepting. | object |
422 | The request failed validation. The response lists each invalid field and why. | HTTPValidationError |
Example
curl -X POST http://localhost:8000/settings/partner-claim/resolve \
-H "Authorization: Bearer $TOKEN" \
-H "Content-Type: application/json" \
-d '{ ... }'