Integration API overview
The /integrations/v1 API connects a survey platform to Ramon. It is
organization-scoped, requires an Integration API Bearer key, and is intended for
server-to-server use.
Provision survey → render browser embed → map response UUID
→ start scoring → poll run → look up session results → request deletion
Base URL: https://api.getramon.com/integrations/v1
All successful Integration API responses place the result in a data envelope.
Errors use { "error": "…" }. The interactive API reference
contains the canonical operation schemas and response status codes.
Core endpoints
| Task | Endpoint |
|---|---|
| Confirm key context | GET /context |
| Provision LimeSurvey survey | PUT /limesurvey/instances/{instanceId}/surveys/{externalSurveyId} |
| Read session summaries | POST /surveys/{surveyId}/sessions/lookup |
| Start a scoring run | POST /surveys/{surveyId}/scoring-runs |
| Read run progress | GET /surveys/{surveyId}/scoring-runs/{runId} |
| Request session deletion | DELETE /surveys/{surveyId}/sessions/by-reference/{reference} |
| Read deletion progress | GET /surveys/{surveyId}/session-deletions/{reference} |
Ramon currently exposes the provisioning contract for LimeSurvey. Other platforms can follow the generic lifecycle while their provider-specific provisioning contract is agreed with Ramon.