Surveys
Surveys: questions, responses and the results.
partData42 operationsid surveys
How it sits
A part does one thing, and any other part can call it. The counts and the links below are from the platform's spec and the other services' own descriptions.
| Operations | 42 GET 18 · POST 15 · DELETE 6 · PUT 2 · PATCH 1 |
| Resources | 7 |
| Leaned on by | no other service names it |
| Leans on | none named |
| In recipes | none yet |
What it can do
42 operations in 7 resources, as the spec declares them. Each row is one call; paths are relative to the part.
surveys
| Method | Path | Does |
|---|---|---|
| GET | /api/v1/surveys | List all surveys |
| POST | /api/v1/surveys | Create a new survey |
| DELETE | /api/v1/surveys/{survey_id} | Delete a survey |
| GET | /api/v1/surveys/{survey_id} | Get survey details |
| PATCH | /api/v1/surveys/{survey_id} | Update survey metadata |
| POST | /api/v1/surveys/{survey_id}/archive | Archive survey (any → ARCHIVED) |
| POST | /api/v1/surveys/{survey_id}/clone | Clone a survey into a new draft |
| GET | /api/v1/surveys/{survey_id}/links | List a survey's minted links |
| POST | /api/v1/surveys/{survey_id}/links | Mint a public tracked link for a survey |
| DELETE | /api/v1/surveys/{survey_id}/links/{slug} | Deactivate a minted link |
| POST | /api/v1/surveys/{survey_id}/pause | Pause survey (ACTIVE → INACTIVE) |
| POST | /api/v1/surveys/{survey_id}/publish | Publish survey (DRAFT → ACTIVE) |
| GET | /api/v1/surveys/{survey_id}/questions | List survey questions |
| POST | /api/v1/surveys/{survey_id}/questions | Add a question |
| PUT | /api/v1/surveys/{survey_id}/questions/order | Reorder questions |
| DELETE | /api/v1/surveys/{survey_id}/questions/{question_id} | Delete a question |
| PUT | /api/v1/surveys/{survey_id}/questions/{question_id} | Update a question |
| GET | /api/v1/surveys/{survey_id}/responses | List responses |
| POST | /api/v1/surveys/{survey_id}/responses | Submit survey response |
| GET | /api/v1/surveys/{survey_id}/responses/count | Count responses |
| DELETE | /api/v1/surveys/{survey_id}/responses/{response_id} | Soft-delete a response |
| GET | /api/v1/surveys/{survey_id}/responses/{response_id} | Get response details |
| POST | /api/v1/surveys/{survey_id}/resume | Resume survey (INACTIVE → ACTIVE) |
| POST | /api/v1/surveys/{survey_id}/state | Change survey state |
| GET | /api/v1/surveys/{survey_id}/topline | Survey topline (aggregate counts only) |
| POST | /api/v1/surveys/{survey_id}/transfer | Transfer a survey to another owner (administrators only) |
| POST | /api/v1/surveys/{survey_id}/unpublish | Un-publish survey (ACTIVE → DRAFT) |
27 operations
users
| Method | Path | Does |
|---|---|---|
| GET | /api/v1/users | List all users |
| POST | /api/v1/users | Create a new user |
| GET | /api/v1/users/me | Get current user |
| GET | /api/v1/users/me/keys | List my API keys |
| POST | /api/v1/users/me/keys | Create API key |
| DELETE | /api/v1/users/me/keys/{key_id} | Revoke API key |
| DELETE | /api/v1/users/{user_id} | Deactivate a user |
| GET | /api/v1/users/{user_id} | Get user by ID |
8 operations
health
| Method | Path | Does |
|---|---|---|
| GET | /health | Basic health check |
| GET | /health/detailed | Detailed health check |
2 operations
r
| Method | Path | Does |
|---|---|---|
| GET | /api/v1/r/{slug} | Resolve a public survey link → renderable survey |
| POST | /api/v1/r/{slug}/responses | Submit a response via a public link |
2 operations
domains
| Method | Path | Does |
|---|---|---|
| GET | /api/v1/domains | List public send domains (for the domain picker) |
1 operation
prime
| Method | Path | Does |
|---|---|---|
| GET | /prime | Prime application caches |
1 operation
status
| Method | Path | Does |
|---|---|---|
| GET | /status | Service status overview |
1 operation
All the partsDataThe platform's own id for this service is cbsurveys.
forge-catalog.json, generated Oct 30, 2026