# GET /api/openapi.json

> OpenAPI - Get the OpenAPI specification

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.

- **Endpoint:** `GET /api/openapi.json`
- **Group:** OpenAPI
- **Since:** v1.0.0
- **Defined in:** `RestApi/Controllers/OpenapiController.php`

## Headers

| Field | Type | Description |
| --- | --- | --- |
| `authtoken` | String | Authentication token, generated from admin area |

## Parameters

| Field | Type | Required | Description |
| --- | --- | --- | --- |
| `pretty` | Number | no | Set to 0 to receive the document without indentation, which is roughly 60% smaller and preferable for machine consumers Default: `1`. |

## Request example

```bash
curl -X GET "https://yoursite.com/index.php/api/openapi.json" \
  -H "authtoken: YOUR_API_TOKEN"
```

## Responses

### Success - Success-Response:

```json
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" } }
  }
}
```

### Error - Invalid-Token:

```json
HTTP/1.1 200 OK
{ "status": false, "message": "Token not found" }
```

---

Part of the [REST API for RISE CRM](https://risecrm.themesic.com/apiguide/) documentation.
Full page: https://risecrm.themesic.com/apiguide/open-api/get-open-api-spec/