HighLevel: Get Surveys Submissions

← Surveys operations · Get started

Operation gohighlevel.get_surveys_submissions

Provider route: GET /surveys/submissions. Alter supplies the connection’s credentials and routing.

Call through Alter

Install @alter-ai/sdk @alter-ai/gohighlevel with npm, or alter-sdk-gohighlevel with pip. Supply your connected customer’s grant ID and the arguments described below.

import { App } from "@alter-ai/sdk";
import { HighLevelIntegration } from "@alter-ai/gohighlevel";

async function execute(input: Parameters<HighLevelIntegration["surveys"]["getSurveysSubmissions"]>[0]) {
  const app = new App({ apiKey: process.env.ALTER_API_KEY! });
  try {
    const provider = new HighLevelIntegration(app, { grantId: process.env.PROVIDER_GRANT_ID! });
    const call = await provider.surveys.getSurveysSubmissions(input);
    const result = await call.wait();
    return result.bodyJson();
  } finally {
    await app.close();
  }
}

import os
from alter_sdk import App
from alter_sdk_gohighlevel import HighLevelIntegration

async def execute(arguments):
    async with App(api_key=os.environ["ALTER_API_KEY"]) as app:
        provider = HighLevelIntegration(app, {"grant_id": os.environ["PROVIDER_GRANT_ID"]})
        call = await provider.surveys.get_surveys_submissions(arguments)
        result = await call.wait()
        return result.body_json()

Input

Field	Type	Presence	Description and constraints
$	object	Root	Additional keys: not allowed
query	object	Required within parent	Additional keys: not allowed
query.locationId	string	Required within parent
query.page	number	Optional	Default: 1
query.limit	number	Optional	Default: 20
query.surveyId	string	Optional
query.q	string	Optional
query.startAt	string	Optional
query.endAt	string	Optional

Response

Response media type: application/json. The table describes the pinned successful response. Referenced models link to their complete fields.

Field	Type	Presence	Description and constraints
$	Model	Root	Expand Get Surveys Submissions — response body

Referenced models: Get Surveys Submissions — response body

Schemas

Get Surveys Submissions — response body

Field	Type	Presence	Description and constraints
$	object	Root
meta	Model	Optional	Expand Get Forms Submissions — response body — meta
submissions	array	Optional
submissions[]	Model	Each item	Expand Get Surveys Submissions — response body — submissions item

Referenced models: Get Surveys Submissions — response body — submissions item, Get Forms Submissions — response body — meta

Get Surveys Submissions — response body — submissions item

Field	Type	Presence	Description and constraints
$	object	Root
contactId	string	Optional
createdAt	string	Optional
email	string	Optional
id	string	Optional
name	string	Optional
others	Model	Optional	Expand Get Forms Submissions — response body — submissions item others
surveyId	string	Optional

Referenced models: Get Forms Submissions — response body — submissions item others

Get Forms Submissions — response body — meta

Field	Type	Presence	Description and constraints
$	object	Root
currentPage	JSON	Optional
currentPage (anyOf 1)	number	Alternative
currentPage (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
nextPage	JSON	Optional
nextPage (anyOf 1)	JSON	Alternative
nextPage (anyOf 1) (anyOf 1)	number	Alternative
nextPage (anyOf 1) (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
nextPage (anyOf 2)	null	Alternative
prevPage	JSON	Optional
prevPage (anyOf 1)	JSON	Alternative
prevPage (anyOf 1) (anyOf 1)	number	Alternative
prevPage (anyOf 1) (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
prevPage (anyOf 2)	null	Alternative
total	JSON	Optional
total (anyOf 1)	number	Alternative
total (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$

Get Forms Submissions — response body — submissions item others

Field	Type	Presence	Description and constraints
$	object	Root
__custom_field_id__	string	Optional
__submissions_other_field__	string	Optional
eventData	Model	Optional	Expand Get Forms Submissions — response body — submissions item others event Data
fieldsOriSequance	array	Optional
fieldsOriSequance[]	string	Each item

Referenced models: Get Forms Submissions — response body — submissions item others event Data

Get Forms Submissions — response body — submissions item others event Data

Field	Type	Presence	Description and constraints
$	object	Root
adSource	string	Optional
contactSessionIds	JSON	Optional
contactSessionIds (anyOf 1)	JSON	Alternative
contactSessionIds (anyOf 1) (allOf 1)	Model	All variants apply	Expand Get Forms Submissions — response body — submissions item others event Data contact Session Ids ids ids
contactSessionIds (anyOf 2)	null	Alternative
domain	string	Optional
fbEventId	string	Optional
fbc	string	Optional
fbp	string	Optional
fingerprint	string	Optional
medium	string	Optional
mediumId	string	Optional
page	Model	Optional	Expand Get Forms Submissions — response body — submissions item others event Data page
pageVisitType	string	Optional
parentId	string	Optional
parentName	string	Optional
referrer	string	Optional
source	string	Optional
timestamp	JSON	Optional
timestamp (anyOf 1)	number	Alternative
timestamp (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
type	string	Optional
version	string	Optional

Referenced models: Get Forms Submissions — response body — submissions item others event Data contact Session Ids ids ids, Get Forms Submissions — response body — submissions item others event Data page

Get Forms Submissions — response body — submissions item others event Data contact Session Ids ids ids

Field	Type	Presence	Description and constraints
$	object	Root
ids	JSON	Optional
ids (anyOf 1)	array	Alternative
ids (anyOf 1)[]	string	Each item
ids (anyOf 2)	null	Alternative

Get Forms Submissions — response body — submissions item others event Data page

Field	Type	Presence	Description and constraints
$	object	Root
title	string	Optional
url	string	Optional

Policy, approvals and errors

SDK function policy ID: gohighlevel.get_surveys_submissions. Catalog operation: get-surveys-submissions. Rules can name either ID; function rules distinguish managed calls and conservatively cover raw calls sharing the route. Existing grant permissions and policy rules apply. wait() returns an immediate result or waits for a required approval; it never approves the request itself. Persist the approval ID to resume after a restart.

Provider errors retain their response; JSON decoding raises ProviderAPIError for provider failures. ManagedOperationError identifies contract/input/retention errors. See error handling and provider-specific behavior. Sensitive input may be refused before approval storage. A decoding error never resubmits a write.

Required provider scopes: ["surveys.readonly"]

Pinned headers: {"Version": "v3"}

Official provider source