Fetch User Survey

Returns the URL of a user's available survey

Headers

x-pch-digest
Type: string
required

The signature for the API call
Authorization
Type: string
required

Used to authorize the request with access_token. It should be supplied as Bearer ACCESS_TOKEN_GOES_HERE.
Accept
Type: string
required

Advertises which content types the client is able to understand
Accept-Language
Type: string

Preferred language
Content-Type
Type: string
required

Set this header to application/json.
Accept-Timezone
Type: string
User-Agent
Type: string
required

Used to identify the software, device, and application initiating the request, providing information about the client to the server. For details, see User Agent.

Body

application/json

client
Type: string
required

OAuth client ID provided by the business
user_survey_id
Type: integer
required

ID of the survey

Responses

application/json

get/api2/mobile/survey_details

curl https://SERVER_NAME_GOES_HERE.punchh.com/api2/mobile/survey_details \
  --header 'x-pch-digest: {{$$.env.signature}}' \
  --header 'Authorization: Bearer ACCESS_TOKEN_GOES_HERE' \
  --header 'Accept: application/json' \
  --header 'Accept-Language: en' \
  --header 'Content-Type: application/json' \
  --header 'Accept-Timezone: Etc/UTC' \
  --header 'User-Agent: AppName/AppVersion/BuildNumber (OS; Model; MANUFACTURER; MODEL; OS Version)' \
  --data '{
  "client": "CLIENT_GOES_HERE",
  "user_survey_id": 123456
}'

Show Schema

{
  "id": 123456,
  "survey_url": "URL_GOES_HERE"
}

Surveys

Users