Skip to main content

Demo Requests

2 API calls in this section.

List Demo Requests​

System Configuration / Demo Requests
GET/system/demo-requests?page=1&limit=10&status=&search=

Retrieves a paginated list of demo requests submitted by prospective tenants. Supports filtering by status and searching. Authentication: - Requires Bearer token - User must be a System Admin Query Parameters: - page: Page number (default 1) - limit: Items per page (default 10) - status: Filter by specific status - search: Search string for name, email, or phone Response: - Returns list of requests with pagination metadata.

Send a bearer token in the Authorization header for an authenticated OnDi user session.
Request
curl
1curl --request GET "$ONDI_BASE_URL/system/demo-requests?page=1&limit=10&status=&search=" \2  --header "Authorization: Bearer {{access_token}}"

Query parameters

pageOptional
query string

1

Page number (default: 1)

limitOptional
query string

10

Items per page (default: 10)

statusOptional
query string

Filter by status: Requested, Under Review, In Progress, Converted, Canceled, No Response

searchOptional
query string

Search by name, email, or phone number

Headers

AuthorizationOptional
header string

Bearer {{access_token}}

Responses

Success Response200OK
Response body
json
1{2  "success": true,3  "message": "data_retrieved_successfully",4  "data": [5    {6      "id": "a1b2c3d4-e5f6-7890-1234-56789abcdef0",7      "created_at": "2023-11-27T10:00:00Z",8      "updated_at": "2023-11-27T10:00:00Z",9      "name": "John Doe",10      "email": "john.doe@company.com",11      "phone_number": "+15551234567",12      "notes": "Interested in full suite",13      "interested_modules": [14        "delivery",15        "storefront"16      ],17      "status": "Requested",18      "status_history": [19        {20          "status": "Requested",21          "at": "2023-11-27T10:00:00Z"22        }23      ]24    }25  ],26  "page": 1,27  "limit": 10,28  "total": 129}

Update Demo Request Status​

System Configuration / Demo Requests
PUT/system/demo-requests/:id/status

Updates the status of a demo request. Tracks the status change in the history. Authentication: - Requires Bearer token - User must be a System Admin Path Parameters: - id: UUID of the demo request Request Body: - status (required): New status. Valid values: - Requested - Under Review - In Progress - Converted - Canceled - No Response Response: - Returns the updated demo request object.

Send a bearer token in the Authorization header for an authenticated OnDi user session.
Request
curl
1curl --request PUT "$ONDI_BASE_URL/system/demo-requests/:id/status" \2  --header "Authorization: Bearer {{access_token}}" \3  --header "Content-Type: application/json" \4  --header "Content-Type: application/json" \5  --data '{6  "status": "In Progress"7}'
Request body
json
1{2  "status": "In Progress"3}

Path parameters

idRequired
path string

request-uuid

UUID of the demo request

Request body fields

statusExample
string

Example field from the request body.

Headers

AuthorizationOptional
header string

Bearer {{access_token}}

Content-TypeOptional
header string

application/json

Responses

Success Response200OK
Response body
json
1{2  "success": true,3  "message": "status_updated_successfully",4  "data": {5    "id": "a1b2c3d4-e5f6-7890-1234-56789abcdef0",6    "status": "Under Review",7    "status_history": [8      {9        "status": "Requested",10        "at": "2023-11-27T10:00:00Z"11      },12      {13        "status": "Under Review",14        "at": "2023-11-27T10:30:00Z",15        "by": "admin-uuid"16      }17    ],18    "updated_at": "2023-11-27T10:30:00Z"19  }20}
Error - Invalid Status400Bad Request
Response body
json
1{2  "success": false,3  "message": "invalid_status_transition"4}