> ## Documentation Index
> Fetch the complete documentation index at: https://help.hoopai.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Surveys Overview

> Retrieve surveys, manage submission data, export results, and generate PDFs with the HoopAI Platform Surveys REST API.

The HoopAI Platform Surveys REST API gives you full programmatic control over your survey data. Retrieve survey lists and paginated submissions, look up individual submission records, schedule CSV exports, generate PDF reports for submissions, clone surveys from themes, and manage images — all through a single, consistent interface.

## Base URL

```
https://services.leadconnectorhq.com
```

## Authentication

Every request requires a Bearer token and an API version header.

```bash theme={null}
Authorization: Bearer <access_token>
Version: 2021-07-28
```

Use an access token generated with user type **Account**, or a **Private Integration Token** from an Account. See [OAuth 2.0](/api-reference/oauth/overview) for details.

## OAuth scopes

| Scope              | Access granted                                   |
| ------------------ | ------------------------------------------------ |
| `surveys.readonly` | Read surveys and survey submissions              |
| `surveys.write`    | Full access to surveys and submission management |

## Quick start

List all surveys for a location:

```bash theme={null}
curl -X GET "https://services.leadconnectorhq.com/surveys/?locationId=<locationId>&limit=20&skip=0" \
  -H "Authorization: Bearer <access_token>" \
  -H "Version: 2021-07-28"
```

## Endpoints

| Method | Path                                                          | Description                                 |
| ------ | ------------------------------------------------------------- | ------------------------------------------- |
| `GET`  | `/surveys/`                                                   | Get surveys                                 |
| `GET`  | `/surveys/submissions`                                        | Get surveys submissions                     |
| `GET`  | `/surveys/multiple-surveys-submissions`                       | Get submissions from multiple surveys       |
| `GET`  | `/surveys/submission/{submissionId}`                          | Get submission by ID                        |
| `GET`  | `/surveys/submission-details/{submissionId}`                  | Get survey submission details (open)        |
| `GET`  | `/surveys/surveys-list`                                       | Get surveys by IDs                          |
| `POST` | `/surveys/restore-version`                                    | Restore a survey version                    |
| `POST` | `/surveys/schedule-survey-export`                             | Schedule survey submission export as CSV    |
| `POST` | `/surveys/clone-from-theme`                                   | Clone survey from theme                     |
| `GET`  | `/surveys/theme-style/{themeId}`                              | Get theme style                             |
| `POST` | `/surveys/image`                                              | Add image in storage                        |
| `POST` | `/surveys/{surveyId}/submissions/{submissionId}/download-pdf` | Initiate PDF download for survey submission |
| `GET`  | `/surveys/{surveyId}/submissions/{submissionId}/pdf-url`      | Get PDF URL for survey submission           |

## Related

* [OAuth 2.0 overview](/api-reference/oauth/overview)
* [Forms API overview](/api-reference/forms/overview)
* [Contacts API overview](/api-reference/contacts/overview)