Developer Portal

API Documentation

Back to Help

Overview

The CAIRA API allows you to programmatically manage surveys, retrieve responses, and trigger jobs. All requests must be authenticated using a **Bearer Token**.

Authentication

Include your personal access token in the `Authorization` header of every request. You can generate tokens in API Access Settings.

Token is stored locally for this session to power the "Try it out" features.

Endpoints

GET /api/forms

Retrieve a list of all active campaigns for your tenant.

curl -H "Authorization: Bearer YOUR_TOKEN" \
https://caira.daythree.ai//api/forms
Parameters

No parameters required.

Response
GET /api/forms/results

Retrieve all responses for a specific campaign ID.

curl -H "Authorization: Bearer YOUR_TOKEN" \
https://caira.daythree.ai//api/forms/results?form_id=123
Parameters
Response
POST /api/jobs/create

Submit a new survey batch job for processing.

curl -X POST -H "Authorization: Bearer YOUR_TOKEN" \
-H "Content-Type: application/json" \
-d '{
  "name": "Q4 Satisfaction",
  "form_id": 1,
  "template_id": 1,
  "participants": [
    {"contact": "[email protected]", "channel": "email"}
  ]
}' \
https://caira.daythree.ai//api/jobs/create
Request Body

Important: Use valid form_id and template_id from your account. Check My Forms and Templates for IDs.

Response
GET /api/jobs/status

Retrieve the status and participant logs for a specific job.

curl -H "Authorization: Bearer YOUR_TOKEN" \
https://caira.daythree.ai//api/jobs/status?id=JOB_ID
Parameters
Response
Quick Tips
  • Click "Try it out" to test endpoints live.
  • Enter your API token in the authentication box above.
  • Responses are returned in JSON format.
Response Formats

All success responses are returned as `application/json`.

{
  "status": "success",
  "data": { ... }
}