Survey

Storefront Survey API endpoints

Endpoints

GET/surveys/{survey_id}

Get survey by ID

GET /surveys/{survey_id}

A detailed description of the survey.

Path parameters

survey_idRequiredinteger

Survey ID

ReturnsSurvey

Survey object response

curl https://api.subbly.co/storefront/v1/surveys/{survey_id} \
  -H 'X-API-KEY: <api-key>'

Response

{
  "id": 1,
  "title": "What is your favorite color?",
  "questions": [
    {
      "id": 1,
      "type": "text",
      "title": "What is your favorite color?",
      "description": "What is your favorite color?",
      "min_amount": 1,
      "max_amount": 10,
      "min_count": 1,
      "max_count": 10,
      "required": true,
      "position": 1,
      "answers": [
        {}
      ],
      "customizations": {},
      "created_at": "2022-04-01 00:00:00",
      "updated_at": "2022-04-01 00:00:00"
    }
  ],
  "single_step": true,
  "multiply_price_by_shipment_number": true,
  "appearance_type": "after_checkout",
  "customizations": {
    "color": "red",
    "size": "large"
  },
  "created_at": "2023-03-30T15:00:00+00:00",
  "updated_at": "2023-03-30T15:00:00+00:00"
}

Survey

Storefront Survey API endpoints

Endpoints

GET/surveys/{survey_id}

Get survey by ID

GET /surveys/{survey_id}

A detailed description of the survey.

Path parameters

survey_idRequiredinteger

Survey ID

ReturnsSurvey

Survey object response

idinteger

titlestring

questionsSurveyQuestion[]

single_stepbooleanDeprecated

multiply_price_by_shipment_numberboolean

appearance_typestring | null

Possible values: before_cart, after_checkout, subscription_box.

customizationsSurveyCustomization

created_atstring

Format: date-time.

updated_atstring

Format: date-time.

curl https://api.subbly.co/storefront/v1/surveys/{survey_id} \
  -H 'X-API-KEY: <api-key>'

Response

{
  "id": 1,
  "title": "What is your favorite color?",
  "questions": [
    {
      "id": 1,
      "type": "text",
      "title": "What is your favorite color?",
      "description": "What is your favorite color?",
      "min_amount": 1,
      "max_amount": 10,
      "min_count": 1,
      "max_count": 10,
      "required": true,
      "position": 1,
      "answers": [
        {}
      ],
      "customizations": {},
      "created_at": "2022-04-01 00:00:00",
      "updated_at": "2022-04-01 00:00:00"
    }
  ],
  "single_step": true,
  "multiply_price_by_shipment_number": true,
  "appearance_type": "after_checkout",
  "customizations": {
    "color": "red",
    "size": "large"
  },
  "created_at": "2023-03-30T15:00:00+00:00",
  "updated_at": "2023-03-30T15:00:00+00:00"
}