Surveys

The Survey object defines feedback forms that can be configured, distributed, and tracked through the API.

Surveys are powerful tools for collecting structured feedback across various touchpoints, typically delivered to restaurant guests via QR codes, direct links, SMS, or email. Through the API, you can programmatically manage surveys, retrieve responses (submissions), and sync survey data with your internal systems to enhance customer insight and drive operational improvements.

warning

We are in the process of migrating fully to our V2 /surveys endpoints, so these are currently READ-only. You are technically able to make changes to your surveys in the V2 endpoints, but we they won't be reflected in live customer surveys and may be overwritten in the future.

The Survey Object

Schema Survey not found in OpenAPI spec.

Retrieve Surveys

Retrieve surveys for a business

Parameters

businessstringPath RequiredField must be in path.

The ID of the business to retrieve the surveys for.

expandstring

Returns200

The surveys.

The Survey Object

Endpoint

GET /v2/businesses/{business}/surveys

Retrieve a Survey

Retrieve a survey for a business

Parameters

businessstringPath RequiredField must be in path.

The ID of the business to retrieve the survey for.

surveystringPath RequiredField must be in path.

The ID of the survey to retrieve.

expandstring

Returns200

The survey was found.

The Survey Object

Endpoint

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

Create a Survey

Create a survey for a business

Parameters

businessstringPath RequiredField must be in path.

The ID of the business to retrieve the surveys for.

Schema undefined not found in OpenAPI spec.

Returns201

The survey was created.

The Survey Object

Endpoint

POST /v2/businesses/{business}/surveys

Update a Survey

Update a survey for a business

Parameters

businessstringPath RequiredField must be in path.

The ID of the business to retrieve the survey for.

surveystringPath RequiredField must be in path.

The ID of the survey to retrieve.

Schema undefined not found in OpenAPI spec.

Returns200

The survey was updated.

The Survey Object

Endpoint

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

Delete a Survey

Delete a survey for a business

Parameters

businessstringPath RequiredField must be in path.

The ID of the business to retrieve the survey for.

surveystringPath RequiredField must be in path.

The ID of the survey to delete.

Returns204

The survey was deleted successfully.

Endpoint

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