Get the OpenAPI specification
GET/api/openapi.json
Returns an OpenAPI 3.0 document that describes every endpoint of the REST API for RISE CRM: list, get by id, search, create, update and delete for each resource, plus the miscellaneous helper endpoints. Import the URL into Swagger UI, Postman, Insomnia or n8n to get a ready made client without writing anything by hand. The server URL is detected from the installation, so it already contains /index.php when your RISE installation is routed that way.
Headers
| Field | Type | Description |
|---|---|---|
| authtoken | String | Authentication token, generated from admin area |
Parameters
| Field | Type | Description |
|---|---|---|
| pretty | Number | optional Set to 0 to receive the document without indentation, which is roughly 60% smaller and preferable for machine consumers
|
curl -X GET "https://yoursite.com/api/openapi.json" \
-H "authtoken: YOUR_API_TOKEN"Success-Response:
HTTP/1.1 200 OK
{
"openapi": "3.0.3",
"info": { "title": "REST API for RISE CRM", "version": "2.1.0" },
"servers": [ { "url": "https://yourdomain.com/index.php/api" } ],
"security": [ { "authtoken": [] } ],
"paths": {
"/taxes": { "get": { "operationId": "getTaxes" }, "post": { "operationId": "createTax" } },
"/taxes/{id}": { "get": { "operationId": "showTax" } },
"/taxes/search/{keyword}": { "get": { "operationId": "searchTaxes" } }
}
}Invalid-Token:
HTTP/1.1 200 OK
{ "status": false, "message": "Token not found" }