Survey Steps

The SurveyStep object defines the individual steps that make up a survey. Each step represents a single interaction within the survey flow, such as a question, informational screen, or other input field.

Steps are ordered and associated with a parent survey, and include configuration for content, input types, validation rules, and conditional logic. The API allows you to retrieve and manage steps to control the structure and behavior of survey experiences.

The Survey Step Object

Schema SurveyStep not found in OpenAPI spec.

Retrieve Survey Steps

Retrieve survey steps for a business

Parameters

businessstringPath RequiredField must be in path.

The ID of the business to retrieve the surveys for.

surveystringPath RequiredField must be in path.

The ID of the survey to retrieve the steps for.

Returns200

The survey steps.

The SurveyStep Object

Endpoint

GET /v2/businesses/{business}/surveys/{survey}/steps

Retrieve a Survey Step

Retrieve a survey step for a business

Parameters

businessstringPath RequiredField must be in path.

The ID of the business to retrieve the surveys for.

surveystringPath RequiredField must be in path.

The ID of the survey to retrieve the steps for.

stepstringPath RequiredField must be in path.

The ID of the survey step to retrieve.

Returns200

The survey step was found.

The SurveyStep Object

Endpoint

GET /v2/businesses/{business}/surveys/{survey}/steps/{step}

Create a Survey Step

Create a survey step for a business

Parameters

businessstringPath RequiredField must be in path.

The ID of the business to retrieve the surveys for.

surveystringPath RequiredField must be in path.

The ID of the survey to create the step for.

Schema undefined not found in OpenAPI spec.

Returns201

The survey step was created.

The SurveyStep Object

Endpoint

POST /v2/businesses/{business}/surveys/{survey}/steps

Update a Survey Step

Update a survey step for a business

Parameters

businessstringPath RequiredField must be in path.

The ID of the business to retrieve the surveys for.

surveystringPath RequiredField must be in path.

The ID of the survey to retrieve the steps for.

stepstringPath RequiredField must be in path.

The ID of the survey step to retrieve.

Schema undefined not found in OpenAPI spec.

Returns200

The survey step was updated.

The SurveyStep Object

Endpoint

PATCH /v2/businesses/{business}/surveys/{survey}/steps/{step}

Delete a Survey Step

Delete a survey step for a business

Parameters

businessstringPath RequiredField must be in path.

The ID of the business to retrieve the surveys for.

surveystringPath RequiredField must be in path.

The ID of the survey to retrieve the steps for.

stepstringPath RequiredField must be in path.

The ID of the survey step to retrieve.

Returns204

The survey step was deleted.

Endpoint

DELETE /v2/businesses/{business}/surveys/{survey}/steps/{step}