Jump to

Initialize survey session

`POST` `/api/v1/public/surveys/init/`

Initialize survey session and retrieve survey configuration. Creates an initialization event and returns survey details along with user's previous interaction state.

Request body

Comparison table
Field	Type	Required	Description
`survey_uuid`	string (uuid)	Yes	UUID of the survey to initialize.
`session_uuid`	string (uuid)	No	Existing session to resume. Omit on the first call — the response returns a server-generated session_uuid to reuse in respond/event.

Code example

curl -X POST https://feedback.tools/api/v1/public/surveys/init \
  -H "Authorization: Bearer pk_..." \
  -H "Content-Type: application/json" \
  -d '{"survey_uuid":"<survey_uuid>"}'

Responses

`200` Success

Comparison table
Field	Type	Required
`survey_uuid`	string (uuid)	Yes
`session_uuid`	string (uuid)	Yes
`survey`	object	Yes
`user_closed_survey`	boolean	Yes
`user_submitted_score`	boolean	Yes
`user_submitted_text`	boolean	Yes

survey object:

Comparison table
Field	Type	Required
`survey_type`	`csat_2` \| `csat_5` \| `ces_7` \| `nps_10`	Yes
`scale_style`	`emoji` \| `numbers` \| `stars` \| `thumbs`	Yes
`show_on_pages`	object \| null	Yes
`trigger`	object \| null	Yes
`do_not_show_if_closed`	boolean	Yes
`manual_tracking`	boolean	Yes
`feedback_button`	boolean	Yes
`question`	string	Yes
`min_label`	string	Yes
`max_label`	string	Yes
`text_question`	string \| null	Yes
`text_button_label`	string \| null	Yes
`thank_you_message`	string \| null	Yes
`response_type`	`none` \| `text` \| `choices`	Yes
`choice_options`	object \| null	Yes

`400 / 403 / 404` Error

Comparison table
Field	Type	Required
`detail`	string	Yes
`survey_uuid`	string (uuid) \| null	No
`session_uuid`	string (uuid) \| null	No

On this page

Overview

Endpoints