Skip to content

Surveys

Surveys collect structured feedback from your contacts. This part of the API is read-only. Use it to list the surveys configured in your account and pull the submissions people have completed.

Base URL: https://services.smbcrm.com · Version header: v3 · Scope: surveys.readonly (this API is read-only). See Scopes.

GET/surveys/

List the surveys configured in your SMBcrm account.

scope surveys.readonlyauth Location token or PIT

locationId is required. Use limit and skip to page through results.

Terminal window
curl "https://services.smbcrm.com/surveys/?locationId=<location_id>&limit=20&skip=0" \
-H "Authorization: Bearer <token>" \
-H "Version: v3"
200 OK
{
"surveys": [
{ "id": "<survey_id>", "locationId": "<location_id>", "name": "Customer Satisfaction" }
],
"total": 1
}
GET/surveys/submissions

List submissions for the surveys in your SMBcrm account.

scope surveys.readonlyauth Location token or PIT

locationId is required. Narrow to one survey with surveyId, restrict to a date range with startAt / endAt, and page through results with limit and page.

Terminal window
curl "https://services.smbcrm.com/surveys/submissions?locationId=<location_id>&surveyId=<survey_id>&limit=20&page=1&startAt=2026-06-01&endAt=2026-06-30" \
-H "Authorization: Bearer <token>" \
-H "Version: v3"
200 OK
{
"submissions": [
{
"id": "<submission_id>",
"surveyId": "<survey_id>",
"contactId": "<contact_id>",
"name": "Jordan Lee",
"email": "jordan@example.com",
"createdAt": "2026-06-14T09:15:00.000Z",
"others": {
"How satisfied are you with our service?": "Very satisfied"
}
}
],
"meta": {
"total": 1,
"currentPage": 1
}
}

The others object holds the answers to the survey’s questions, keyed by question text.

  • Forms uses the same list-and-read pattern for form submissions.
  • Contacts helps you look up the contact behind a submission.
  • Scopes is the permissions reference for surveys.readonly and other scopes.