Surveys | Subrite

Surveys

Endpoints for Surveys

ReferenceUpdated October 13, 2026View as Markdown

GET/api/v1/surveys

Authentication: Bearer token (JWT)

Parameters

Query parameters6

pagenumberOptional
Default: 1minimum: 1
takenumberOptional
Default: 10minimum: 1maximum: 50
orderBystringOptional
Default: "createdAt"Allowed values: "createdAt", "id", "updatedAt"
orderDirectionstringOptional
Default: "desc"Allowed values: "asc", "desc"
statusstringOptional
Filter by survey statusAllowed values: "draft", "published", "paused", "stopped", "archived"
searchstringOptional
Search surveys by namemaxLength: 255

Responses

2 status codes

Responses 200

Status200 401application/json

Schema ExampleSurveyResponseDtoPaginated

2 top-level fieldsSelect an object to expand

itemsarray of SurveyResponseDtoRequired15 fields
items
- idstringRequired when parent is presentField path: items[].id
- namestringRequired when parent is presentField path: items[].name

Example requestcurl

curl

curl https://api.subrite.no/api/v1/surveys \
  --header 'Authorization: Bearer <token>'

Try it

Create a new draft survey#

POST/api/v1/surveys

Authentication: Bearer token (JWT)

Request body

Required bodyapplication/json

Schema ExampleCreateSurveyDto

7 top-level fields

namestringRequired
Survey namemaxLength: 255
statusstringOptional
Survey status (defaults to draft)Allowed values: "draft", "published", "paused", "stopped", "archived"

GET/api/v1/surveys/templates

Authentication: Bearer token (JWT)

Responses

2 status codes

Responses 200

Status200 401application/json

Schema Examplearray of SurveyTemplateResponseDto

7 top-level fields

idstringRequired when parent is present
namestringRequired when parent is present

GET/api/v1/surveys/{id}

Authentication: Bearer token (JWT)

Parameters

Path parameters1

idstringRequired

Responses

3 status codes

Responses 200

Status200 401 404application/json

Schema ExampleSurveyResponseDto

Same fields as Create a new draft survey (201).

DELETE/api/v1/surveys/{id}

Authentication: Bearer token (JWT)

Parameters

Path parameters1

idstringRequired

Responses

4 status codes

Responses 204

Survey deleted

This response has no body.

Responses 400

PATCH/api/v1/surveys/{id}

Authentication: Bearer token (JWT)

Parameters

Path parameters1

idstringRequired

Request body

Required bodyapplication/json

Schema ExampleUpdateSurveyDto

7 top-level fields

namestringOptional
Survey namemaxLength: 255
status

Copy a survey as a new draft#

POST/api/v1/surveys/{id}/copy

Authentication: Bearer token (JWT)

Parameters

Path parameters1

idstringRequired

Responses

4 status codes

Responses 201

Status201 401 404 409application/json

Schema ExampleSurveyResponseDto

Same fields as Create a new draft survey (201).

GET/api/v1/surveys/{surveyId}/analytics

Authentication: Bearer token (JWT)

Parameters

Path parameters1

surveyIdstringRequired

Query parameters2

timePeriodstringOptional
Default: "all_time"Time period filter for analytics dataAllowed values: "all_time", "last_7_days", "last_30_days"
isCompletebooleanOptional
Filter by completion status

Responses

3 status codes

Responses 200

Get paginated text responses for a specific question#

GET/api/v1/surveys/{surveyId}/text-responses

Authentication: Bearer token (JWT)

Parameters

Path parameters1

surveyIdstringRequired

Query parameters7

pagenumberOptional
Default: 1minimum: 1
takenumberOptional
Default: 10minimum: 1maximum: 50
orderBystringOptional

GET/api/v1/surveys/{surveyId}/responses

Authentication: Bearer token (JWT)

Parameters

Path parameters1

surveyIdstringRequired

Query parameters6

pagenumberOptional
Default: 1minimum: 1
takenumberOptional
Default: 10minimum: 1maximum: 50
orderBystringOptional
Default: "createdAt"

Submit a new survey response (public)#

POST/api/v1/surveys/{surveyId}/responses

Parameters

Path parameters1

surveyIdstringRequired

Header parameters1

x-survey-sessionstring (uuid)Optional
Opaque per-respondent session id used to detect a duplicate submission. Must be a UUID; a malformed value is rejected with 400 rather than ignored, since silently dropping it would silently disable duplicate protection. Omit it to skip duplicate detection.

Request body

Required bodyapplication/json

Schema ExampleCreateSurveyResponseDto

3 top-level fields

GET/api/v1/surveys/{surveyId}/responses/{id}

Authentication: Bearer token (JWT)

Parameters

Path parameters2

surveyIdstringRequired
idstringRequired

Responses

3 status codes

Responses 200

Status200 401 404application/json

Schema ExampleSurveyResponseItemDto

PATCH/api/v1/surveys/{surveyId}/responses/{id}

Parameters

Path parameters2

surveyIdstringRequired
idstringRequired

Header parameters1

x-survey-sessionstring (uuid)Optional
Opaque per-respondent session id used to detect a duplicate submission. Must be a UUID; a malformed value is rejected with 400 rather than ignored, since silently dropping it would silently disable duplicate protection. Omit it to skip duplicate detection.

Request body

Required bodyapplication/json

GET/api/v1/surveys/{id}/form

Parameters

Path parameters1

idstringRequired

Responses

2 status codes

Responses 200

Status200 404application/json

Schema ExampleSurveyPublicFormDto

5 top-level fields

Schema ExampleSurveyResponseDtoPaginated

200 · application/json

{
  "items": [
    {
      "formJson": {},
      "themeJson": {},
      "completionJson": {}
    }
  ],
  "meta": {
    "page": 0,
    "take": 0,
    "count": 0,
    "pageCount": 0,
    "hasPreviousPage": true,
    "hasNextPage": true
  }
}

Example · 17 linesShow full heightShow compact view

Schema ExampleCreateSurveyDto

application/json

{
  "name": "string",
  "status": "draft",
  "formJson": {},
  "themeJson": {},
  "startDate": "string",
  "endDate": "string",
  "completionJson": {}
}

Example · 9 linesShow full heightShow compact view

Responses

4 status codes

Responses 201

Status201 400 401 409application/json

Schema ExampleSurveyResponseDto

15 top-level fields

idstringRequired
namestringRequired
statusstringRequired
Allowed values: "draft", "published", "paused", "stopped", "archived"
formJsonobject
Can be null
themeJsonobject
Can be null
completionJsonobject
Can be null
startDatestring (date-time)
Can be null
endDatestring (date-time)
Can be null
publishedAtstring (date-time)
Can be null
stoppedAtstring (date-time)
Can be null
createdAtstring (date-time)Required
updatedAtstring (date-time)Required
createdByUserIdnumber
Can be null
updatedByUserIdnumber
Can be null
responseCountnumberRequired
Number of responses for this survey

15 documented fields · Scroll to see moreShow full heightShow compact view

Schema ExampleSurveyResponseDto

201 · application/json

{
  "id": "string",
  "name": "string",
  "status": "draft",
  "formJson": {},
  "themeJson": {},
  "completionJson": {},
  "startDate": "2019-08-24T14:15:22Z",
  "endDate": "2019-08-24T14:15:22Z",
  "publishedAt": "2019-08-24T14:15:22Z",
  "stoppedAt": "2019-08-24T14:15:22Z",
  "createdAt": "2019-08-24T14:15:22Z",
  "updatedAt": "2019-08-24T14:15:22Z",
  "createdByUserId": 0,
  "updatedByUserId": 0,
  "responseCount": 0
}

Example · 17 linesShow full heightShow compact view

Responses 400

Status201 400 401 409application/json

surveyInvalidCreateStatus | surveyFormJsonRequired | surveyFormJsonMissingQuestions | surveyEndDateMustBeFuture | surveyEndDateBeforeStartDate

Schema ExampleErrorResponse

3 top-level fieldsSelect an object to expand

messageCodestringRequired
Allowed values: "surveyInvalidCreateStatus"
messagestring
errorsarray of FieldErrorRequired7 fields

Responses 401

unauthorized

This response has no body.

Responses 409

Status201 400 401 409application/json

surveyNameAlreadyExists

Schema ExampleErrorResponse

3 top-level fieldsSelect an object to expand

messageCodestringRequired
Allowed values: "surveyNameAlreadyExists"
messagestring
errorsarray of FieldErrorRequired7 fields
errors

Example requestcurl

curl

curl https://api.subrite.no/api/v1/surveys \
  --request POST \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{
  "name": "string",
  "status": "draft",
  "formJson": {},
  "themeJson": {},
  "startDate": "string",
  "endDate": "string",
  "completionJson": {}
}'

Schema Examplearray of SurveyTemplateResponseDto

200 · application/json

[
  {
    "id": "string",
    "name": "string",
    "description": "string",
    "formJson": {},
    "metaData": {},
    "createdAt": "2019-08-24T14:15:22Z",
    "updatedAt": "2019-08-24T14:15:22Z"
  }
]

Example · 11 linesShow full heightShow compact view

SurveyResponseDto

200 · application/json

{
  "id": "string",
  "name": "string",
  "status": "draft",
  "formJson": {},
  "themeJson": {},
  "completionJson": {},
  "startDate": "2019-08-24T14:15:22Z",
  "endDate": "2019-08-24T14:15:22Z",
  "publishedAt": "2019-08-24T14:15:22Z",
  "stoppedAt": "2019-08-24T14:15:22Z",
  "createdAt": "2019-08-24T14:15:22Z",
  "updatedAt": "2019-08-24T14:15:22Z",
  "createdByUserId": 0,
  "updatedByUserId": 0,
  "responseCount": 0
}

Example · 17 linesShow full heightShow compact view

Responses 404

Status200 401 404application/json

surveyNotFound

Schema ExampleErrorResponse

3 top-level fieldsSelect an object to expand

messageCodestringRequired
Allowed values: "surveyNotFound"
messagestring
errorsarray of FieldErrorRequired7 fields
errors
- fieldstringRequired when parent is presentField path: errors[].field
- fieldValuestringRequired when parent is presentField path: errors[].fieldValue
- identifierstringRequired when parent is presentField path: errors[].identifier
- identifierValuestringRequired when parent is presentField path: errors[].identifierValue
- messageCodestringRequired when parent is presentField path: errors[].messageCode
- messagestringField path: errors[].message
- errorTypestringRequired when parent is presentField path: errors[].errorType

10 documented fields · Scroll to see moreShow full heightShow compact view

Schema ExampleErrorResponse

404 · application/json

{
  "messageCode": "surveyNotFound",
  "message": "string",
  "errors": [
    {}
  ]
}

Example · 7 linesShow full heightShow compact view

application/json

Schema ExampleErrorResponse

3 top-level fieldsSelect an object to expand

messageCodestringRequired
Allowed values: "surveyOnlyDraftStoppedOrArchivedCanBeDeleted"
messagestring
errorsarray of FieldErrorRequired7 fields
errors
- fieldstringRequired when parent is presentField path: errors[].field
- fieldValuestringRequired when parent is presentField path: errors[].fieldValue
- identifierstringRequired when parent is presentField path: errors[].identifier
- identifierValuestringRequired when parent is presentField path: errors[].identifierValue
- messageCodestringRequired when parent is presentField path: errors[].messageCode
- messagestringField path: errors[].message
- errorTypestringRequired when parent is presentField path: errors[].errorType

10 documented fields · Scroll to see moreShow full heightShow compact view

Schema ExampleErrorResponse

400 · application/json

{
  "messageCode": "surveyOnlyDraftStoppedOrArchivedCanBeDeleted",
  "message": "string",
  "errors": [
    {}
  ]
}

Example · 7 linesShow full heightShow compact view

Responses 404

Status204 400 401 404application/json

surveyNotFound

Schema ExampleErrorResponse

Same fields as Get a single survey by ID (404).

Schema ExampleErrorResponse

404 · application/json

{
  "messageCode": "surveyNotFound",
  "message": "string",
  "errors": [
    {}
  ]
}

Example · 7 linesShow full heightShow compact view

string

Schema ExampleUpdateSurveyDto

application/json

{
  "name": "string",
  "status": "draft",
  "formJson": {},
  "themeJson": {},
  "startDate": "string",
  "endDate": "string",
  "completionJson": {}
}

Example · 9 linesShow full heightShow compact view

Responses

5 status codes

Responses 200

Status200 400 401 404 409application/json

Schema ExampleSurveyResponseDto

Same fields as Create a new draft survey (201).

Schema ExampleSurveyResponseDto

200 · application/json

{
  "id": "string",
  "name": "string",
  "status": "draft",
  "formJson": {},
  "themeJson": {},
  "completionJson": {},
  "startDate": "2019-08-24T14:15:22Z",
  "endDate": "2019-08-24T14:15:22Z",
  "publishedAt": "2019-08-24T14:15:22Z",
  "stoppedAt": "2019-08-24T14:15:22Z",
  "createdAt": "2019-08-24T14:15:22Z",
  "updatedAt": "2019-08-24T14:15:22Z",
  "createdByUserId": 0,
  "updatedByUserId": 0,
  "responseCount": 0
}

Example · 17 linesShow full heightShow compact view

Responses 400

Status200 400 401 404 409application/json

Schema ExampleErrorResponse

3 top-level fieldsSelect an object to expand

messageCodestringRequired
Allowed values: "surveyArchivedCannotBeEdited"
messagestring

Responses 401

unauthorized

This response has no body.

Responses 404

Status200 400 401 404 409application/json

surveyNotFound

Schema ExampleErrorResponse

Same fields as Get a single survey by ID (404).

Schema ExampleErrorResponse

404 · application/json

{
  "messageCode": "surveyNotFound",
  "message": "string",
  "errors": [
    {}
  ]
}

Example · 7 linesShow full height

Responses 409

Status200 400 401 404 409application/json

surveyNameAlreadyExists

Schema ExampleErrorResponse

Same fields as Create a new draft survey (409).

Schema ExampleErrorResponse

409 · application/json

{
  "messageCode": "surveyNameAlreadyExists",
  "message": "string",
  "errors": [
    {}
  ]
}

Example · 7 lines

Example requestcurl

curl

curl 'https://api.subrite.no/api/v1/surveys/{id}' \
  --request PATCH \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{
  "name": "string",
  "status": "draft",
  "formJson": {},
  "themeJson": {},
  "startDate": "string",
  "endDate": "string",
  "completionJson": {}
}'

SurveyResponseDto

201 · application/json

{
  "id": "string",
  "name": "string",
  "status": "draft",
  "formJson": {},
  "themeJson": {},
  "completionJson": {},
  "startDate": "2019-08-24T14:15:22Z",
  "endDate": "2019-08-24T14:15:22Z",
  "publishedAt": "2019-08-24T14:15:22Z",
  "stoppedAt": "2019-08-24T14:15:22Z",
  "createdAt": "2019-08-24T14:15:22Z",
  "updatedAt": "2019-08-24T14:15:22Z",
  "createdByUserId": 0,
  "updatedByUserId": 0,
  "responseCount": 0
}

Example · 17 linesShow full heightShow compact view

Responses 404

Status201 401 404 409application/json

surveyNotFound

Schema ExampleErrorResponse

Same fields as Get a single survey by ID (404).

Schema ExampleErrorResponse

404 · application/json

{
  "messageCode": "surveyNotFound",
  "message": "string",
  "errors": [
    {}
  ]
}

Example · 7 linesShow full heightShow compact view

Responses 409

Status201 401 404 409application/json

surveyNameAlreadyExists

Schema ExampleErrorResponse

Same fields as Create a new draft survey (409).

Schema ExampleErrorResponse

409 · application/json

{
  "messageCode": "surveyNameAlreadyExists",
  "message": "string",
  "errors": [
    {}
  ]
}

Example · 7 linesShow full heightShow compact view

application/json

Schema ExampleSurveyAnalyticsResponseDto

2 top-level fieldsSelect an object to expand

summaryAnalyticsSummaryDtoRequired4 fields
summary
- totalResponsesnumberRequiredField path: summary.totalResponses
- completednumberRequiredField path: summary.completed
- incompletenumberRequiredField path: summary.incomplete
- completionRatenumberRequiredField path: summary.completionRate
questionsarray of QuestionAnalyticsItemDtoRequired13 fields
questions
- namestringRequired when parent is presentField path: questions[].name
- typestringRequired when parent is presentField path: questions[].type
- titlestringRequired when parent is presentField path: questions[].title
- choicesarray of stringRequired when parent is presentField path: questions[].choices
- positionnumberRequired when parent is presentField path: questions[].position

24 documented fields · Scroll to see moreShow full heightShow compact view

Schema ExampleSurveyAnalyticsResponseDto

200 · application/json

{
  "summary": {
    "totalResponses": 0,
    "completed": 0,
    "incomplete": 0,
    "completionRate": 0
  },
  "questions": [
    {
      "choices": [],
      "rows": [],
      "columns": [],
      "distribution": [],
      "textResponses": []
    }
  ]
}

Example · 17 linesShow full heightShow compact view

Responses 404

Status200 401 404application/json

surveyNotFound

Schema ExampleErrorResponse

Same fields as Get a single survey by ID (404).

Schema ExampleErrorResponse

404 · application/json

{
  "messageCode": "surveyNotFound",
  "message": "string",
  "errors": [
    {}
  ]
}

Example · 7 linesShow full heightShow compact view

Responses

3 status codes

Responses 200

Status200 401 404application/json

Schema ExampleTextResponseDtoPaginated

2 top-level fieldsSelect an object to expand

itemsarray of TextResponseDtoRequired3 fields
items
- idstringRequired when parent is presentField path: items[].id
- textstringRequired when parent is presentField path: items[].text
- submittedAtstringRequired when parent is presentField path: items[].submittedAt
metaPageMetaRequired6 fields
meta
- pagenumberRequiredField path: meta.page
- takenumberRequiredField path: meta.take
- countnumberRequiredField path: meta.count
- pageCountnumberRequiredField path: meta.pageCount
- hasPreviousPagebooleanRequiredField path: meta.hasPreviousPage
- hasNextPagebooleanRequiredField path: meta.hasNextPage

11 documented fields · Scroll to see moreShow full heightShow compact view

Schema ExampleTextResponseDtoPaginated

200 · application/json

{
  "items": [
    {}
  ],
  "meta": {
    "page": 0,
    "take": 0,
    "count": 0,
    "pageCount": 0,
    "hasPreviousPage": true,
    "hasNextPage": true
  }
}

Example · 13 linesShow full heightShow compact view

Responses 401

unauthorized

This response has no body.

Responses 404

Status200 401 404application/json

surveyNotFound

Schema ExampleErrorResponse

Same fields as Get a single survey by ID (404).

Schema ExampleErrorResponse

404 · application/json

{
  "messageCode": "surveyNotFound",
  "message": "string",
  "errors": [
    {}
  ]
}

Example · 7 lines

Responses

3 status codes

Responses 200

Status200 401 404application/json

Schema ExampleSurveyResponseItemDtoPaginated

2 top-level fieldsSelect an object to expand

itemsarray of SurveyResponseItemDtoRequired9 fields
items
- idstringRequired when parent is presentField path: items[].id
- answersobjectRequired when parent is presentField path: items[].answers
- isCompletebooleanRequired when parent is presentField path: items[].isComplete
- completedAtstring (date-time)Field path: items[].completedAt
  Can be null
- progressobjectField path: items[].progress
  Can be null
- surveyIdstringRequired when parent is presentField path: items[].surveyId
- userIdnumberField path: items[].userId
  Can be null
- createdAtstring (date-time)Required when parent is presentField path: items[].createdAt
- updatedAtstring (date-time)Required when parent is presentField path: items[].updatedAt
metaPageMetaRequired6 fields
meta
- pagenumberRequiredField path: meta.page
- takenumberRequiredField path: meta.take
- countnumberRequiredField path: meta.count
- pageCountnumberRequiredField path: meta.pageCount
- hasPreviousPagebooleanRequiredField path: meta.hasPreviousPage
- hasNextPagebooleanRequiredField path: meta.hasNextPage

17 documented fields · Scroll to see moreShow full heightShow compact view

Schema ExampleSurveyResponseItemDtoPaginated

200 · application/json

{
  "items": [
    {
      "answers": {},
      "progress": {}
    }
  ],
  "meta": {
    "page": 0,
    "take": 0,
    "count": 0,
    "pageCount": 0,
    "hasPreviousPage": true,
    "hasNextPage": true
  }
}

Example · 16 linesShow full heightShow compact view

Responses 401

unauthorized

This response has no body.

Responses 404

Status200 401 404application/json

surveyNotFound

Schema ExampleErrorResponse

Same fields as Get a single survey by ID (404).

Schema ExampleErrorResponse

404 · application/json

{
  "messageCode": "surveyNotFound",
  "message": "string",
  "errors": [
    {}
  ]
}

Example · 7 linesShow full height

Responses

6 status codes

Responses 201

Status201 400 404 409 429 503application/json

Schema ExampleSurveyResponseItemDto

9 top-level fields

idstringRequired
answersobjectRequired
isCompletebooleanRequired
completedAtstring (date-time)
Can be null
progressobject
Can be null
surveyIdstringRequired
userIdnumber
Can be null
createdAtstring (date-time)Required
updatedAtstring (date-time)Required

9 documented fields · Scroll to see moreShow full heightShow compact view

Schema ExampleSurveyResponseItemDto

201 · application/json

{
  "id": "string",
  "answers": {},
  "isComplete": true,
  "completedAt": "2019-08-24T14:15:22Z",
  "progress": {},
  "surveyId": "string",
  "userId": 0,
  "createdAt": "2019-08-24T14:15:22Z",
  "updatedAt": "2019-08-24T14:15:22Z"
}

Example · 11 linesShow full heightShow compact view

Responses 400

Status201 400 404 409 429 503application/json

surveyNotAcceptingResponses | surveyAuthRequired

Schema ExampleErrorResponse

3 top-level fieldsSelect an object to expand

messageCodestringRequired
Allowed values: "surveyNotAcceptingResponses"
messagestring

Responses 404

Status201 400 404 409 429 503application/json

surveyNotFound

Schema ExampleErrorResponse

Same fields as Get a single survey by ID (404).

Schema ExampleErrorResponse

404 · application/json

Responses 409

Status201 400 404 409 429 503application/json

surveyAlreadySubmitted

Schema ExampleErrorResponse

3 top-level fieldsSelect an object to expand

messageCodestringRequired
Allowed values: "surveyAlreadySubmitted"
messagestring

Responses 429

Status201 400 404 409 429 503application/json

surveyRateLimitExceeded | surveyFloodLimitExceeded

Schema ExampleErrorResponse

3 top-level fieldsSelect an object to expand

messageCodestringRequired
Allowed values: "surveyRateLimitExceeded"
messagestring

Responses 503

Status201 400 404 409 429 503application/json

surveySubmissionTemporarilyUnavailable

Schema ExampleErrorResponse

3 top-level fieldsSelect an object to expand

messageCodestringRequired
Allowed values: "surveySubmissionTemporarilyUnavailable"
messagestring

Example requestcurl

curl

curl 'https://api.subrite.no/api/v1/surveys/{surveyId}/responses' \
  --request POST \
  --header 'Content-Type: application/json' \
  --data '{
  "answers": {},
  "isComplete": true,
  "progress": {}
}'

Schema ExampleSurveyResponseItemDto

200 · application/json

{
  "id": "string",
  "answers": {},
  "isComplete": true,
  "completedAt": "2019-08-24T14:15:22Z",
  "progress": {},
  "surveyId": "string",
  "userId": 0,
  "createdAt": "2019-08-24T14:15:22Z",
  "updatedAt": "2019-08-24T14:15:22Z"
}

Example · 11 linesShow full heightShow compact view

Responses 404

Status200 401 404application/json

surveyNotFound | surveyResponseNotFound

Schema ExampleErrorResponse

Same fields as Get a single survey by ID (404).

Schema ExampleErrorResponse

404 · application/json

{
  "messageCode": "surveyNotFound",
  "message": "string",
  "errors": [
    {}
  ]
}

Example · 7 linesShow full heightShow compact view

UpdateSurveyResponseDto

Responses

6 status codes

Responses 200

Status200 400 404 409 429 503application/json

Schema ExampleSurveyResponseItemDto

Same fields as Submit a new survey response (public) (201).

Schema ExampleSurveyResponseItemDto

200 · application/json

{
  "id": "string",
  "answers": {},
  "isComplete": true,
  "completedAt": "2019-08-24T14:15:22Z",
  "progress": {},
  "surveyId": "string",
  "userId": 0,
  "createdAt": "2019-08-24T14:15:22Z",
  "updatedAt": "2019-08-24T14:15:22Z"
}

Example · 11 linesShow full heightShow compact view

Responses 400

Status200 400 404 409 429 503application/json

surveyNotAcceptingResponses | surveyResponseAlreadyCompleted

Schema ExampleErrorResponse

Same fields as Submit a new survey response (public) (400).

Schema ExampleErrorResponse

400 · application/json

Responses 404

Status200 400 404 409 429 503application/json

surveyNotFound | surveyResponseNotFound

Schema ExampleErrorResponse

Same fields as Get a single survey by ID (404).

Schema ExampleErrorResponse

404 · application/json

Responses 409

Status200 400 404 409 429 503application/json

surveyAlreadySubmitted

Schema ExampleErrorResponse

Same fields as Submit a new survey response (public) (409).

Schema ExampleErrorResponse

409 · application/json

Responses 429

Status200 400 404 409 429 503application/json

surveyFloodLimitExceeded

Schema ExampleErrorResponse

3 top-level fieldsSelect an object to expand

messageCodestringRequired
Allowed values: "surveyFloodLimitExceeded"
messagestring

Responses 503

Status200 400 404 409 429 503application/json

surveySubmissionTemporarilyUnavailable

Schema ExampleErrorResponse

Same fields as Submit a new survey response (public) (503).

Schema ExampleErrorResponse

503 · application/json

Example requestcurl

curl

curl 'https://api.subrite.no/api/v1/surveys/{surveyId}/responses/{id}' \
  --request PATCH \
  --header 'Content-Type: application/json' \
  --data '{
  "answers": {},
  "isComplete": true,
  "progress": {}
}'

Schema ExampleSurveyPublicFormDto

200 · application/json

{
  "id": "string",
  "name": "string",
  "formJson": {},
  "themeJson": {},
  "completionJson": {}
}

Example · 7 linesShow full heightShow compact view

Responses 404

Status200 404application/json

surveyNotFound

Schema ExampleErrorResponse

Same fields as Get a single survey by ID (404).

Schema ExampleErrorResponse

404 · application/json

{
  "messageCode": "surveyNotFound",
  "message": "string",
  "errors": [
    {}
  ]
}

Example · 7 linesShow full heightShow compact view

Schema ExampleErrorResponse

400 · application/json

{
  "messageCode": "surveyInvalidCreateStatus",
  "message": "string",
  "errors": [
    {}
  ]
}

Example · 7 linesShow full heightShow compact view

Schema ExampleErrorResponse

409 · application/json

{
  "messageCode": "surveyNameAlreadyExists",
  "message": "string",
  "errors": [
    {}
  ]
}

Example · 7 linesShow full heightShow compact view

Schema ExampleErrorResponse

400 · application/json

{
  "messageCode": "surveyArchivedCannotBeEdited",
  "message": "string",
  "errors": [
    {}
  ]
}

Example · 7 linesShow full heightShow compact view

Schema ExampleErrorResponse

400 · application/json

{
  "messageCode": "surveyNotAcceptingResponses",
  "message": "string",
  "errors": [
    {}
  ]
}

Example · 7 linesShow full heightShow compact view

{
  "messageCode": "surveyNotFound",
  "message": "string",
  "errors": [
    {}
  ]
}

Schema ExampleErrorResponse

409 · application/json

{
  "messageCode": "surveyAlreadySubmitted",
  "message": "string",
  "errors": [
    {}
  ]
}

Example · 7 linesShow full heightShow compact view

Schema ExampleErrorResponse

429 · application/json

{
  "messageCode": "surveyRateLimitExceeded",
  "message": "string",
  "errors": [
    {}
  ]
}

Example · 7 linesShow full heightShow compact view

Schema ExampleErrorResponse

503 · application/json

{
  "messageCode": "surveySubmissionTemporarilyUnavailable",
  "message": "string",
  "errors": [
    {}
  ]
}

Example · 7 linesShow full heightShow compact view

{
  "messageCode": "surveyNotAcceptingResponses",
  "message": "string",
  "errors": [
    {}
  ]
}

{
  "messageCode": "surveyNotFound",
  "message": "string",
  "errors": [
    {}
  ]
}

{
  "messageCode": "surveyAlreadySubmitted",
  "message": "string",
  "errors": [
    {}
  ]
}

Schema ExampleErrorResponse

429 · application/json

{
  "messageCode": "surveyFloodLimitExceeded",
  "message": "string",
  "errors": [
    {}
  ]
}

Example · 7 linesShow full heightShow compact view

{
  "messageCode": "surveySubmissionTemporarilyUnavailable",
  "message": "string",
  "errors": [
    {}
  ]
}

List surveys (paginated)#

Parameters

Responses

Responses 200

Create a new draft survey#

Request body

List survey templates#

Responses

Responses 200

Get a single survey by ID#

Parameters

Responses

Responses 200

Soft delete a draft, stopped, or archived survey#

Parameters

Responses

Responses 204

Responses 400

Update a survey#

Parameters

Request body

Copy a survey as a new draft#

Parameters

Responses

Responses 201

Get aggregated analytics for a survey#

Parameters

Responses

Responses 200

Get paginated text responses for a specific question#

Parameters

List responses for a survey (paginated)#

Parameters

Submit a new survey response (public)#

Parameters

Request body

Get a single survey response#

Parameters

Responses

Responses 200

Update an in-progress survey response (public partial save)#

Parameters

Request body

Get published survey form (public respondent view)#

Parameters

Responses

Responses 200

List surveys (paginated)#

Parameters

Responses

Responses 200

Create a new draft survey#

Request body

List survey templates#

Responses

Responses 200

Get a single survey by ID#

Parameters

Responses

Responses 200

Soft delete a draft, stopped, or archived survey#

Parameters

Responses

Responses 204

Responses 400

Update a survey#

Parameters

Request body

Copy a survey as a new draft#

Parameters

Responses

Responses 201

Get aggregated analytics for a survey#

Parameters

Responses

Responses 200

Get paginated text responses for a specific question#

Parameters

List responses for a survey (paginated)#

Parameters