Download the Postman collection
GET/api/postman.json
Returns a ready to import Postman v2.1 collection covering every endpoint registered under the api route group. The collection declares two variables, {{base_url}} (pre-filled with this installation URL) and {{authtoken}} (intentionally left empty - paste your own token after import). Collection level auth sends {{authtoken}} as the authtoken header on every request. Requests are foldered by apidoc group and carry the endpoint description plus a sample JSON body built from the documented body parameters. Routes registered with $routes->add() answer any HTTP verb; they are exported once as GET and labelled (any verb). Any route line the generator cannot read is listed in a trailing ! Unparsed routes folder instead of being dropped silently.
Headers
| Field | Type | Description |
|---|---|---|
| authtoken | String | Authentication token, generated from admin area |
curl -X GET "https://yoursite.com/api/postman.json" \
-H "authtoken: YOUR_API_TOKEN"Success-Response:
HTTP/1.1 200 OK
{
"info": { "name": "RISE CRM REST API", "schema": "https://schema.getpostman.com/json/collection/v2.1.0/collection.json" },
"variable": [ { "key": "base_url", "value": "https://crm.example.com" }, { "key": "authtoken", "value": "" } ],
"item": [ { "name": "Taxes", "item": [ { "name": "GET - List all Taxes" } ] } ]
}