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

# SurveyMonkey as a data source

> Bring surveys, questions, responses and answers, collectors, contacts and teams from SurveyMonkey to Nekt.

SurveyMonkey is an online survey platform. This connector reads your SurveyMonkey account through the SurveyMonkey API v3 and brings your surveys and their design (pages, questions and answer options), every response with one row per answer, the collectors that gathered them, your contacts and contact lists, and, on Team plans, your teams and workgroups.

> [!NOTE]
>
> The connector only reads data. It never creates, changes or deletes anything in SurveyMonkey.

## Configuring SurveyMonkey as a Source

In the [Sources](https://app.nekt.ai/sources) tab, click on the "Add source" button located on the top right of your screen. Then, select the SurveyMonkey option from the list of connectors.

Click **Next** and you'll be prompted to add your access.

### 1. Add account access

The connector signs in with the **access token of a private app** that you create in your own SurveyMonkey account. No app from Nekt is involved and SurveyMonkey does not need to review it.

**1. Create the app**

Log in to [developer.surveymonkey.com](https://developer.surveymonkey.com/) with the SurveyMonkey account whose surveys you want to sync, open **My Apps** and click **Add a new app**. Give the app a name. It starts as a draft app that can only read your own account.

**2. Select the scopes**

In the app's **Settings**, under **Scopes**, set as required the read scopes of the tables you want to sync: **View Surveys**, **View Collectors**, **View Response Details**, **View Contacts**, **View Users**, **View Webhooks** and, on Team plans, **View Teams**, **View Workgroups** and **View Workgroup Members**. Save the settings.

**3. Deploy and copy the access token**

Deploy the app as a **Private** app (no review by SurveyMonkey is needed) and copy the **Access Token** shown in its **Settings** page. The token does not expire; if you revoke it or change the app, paste the new token in the source configuration.

> [!WARNING]
>
> Private apps require a **paid SurveyMonkey plan with API access**. A new app starts as a **draft**: its token works, but SurveyMonkey disables draft apps 90 days after they are created, so deploy the app as Private before that. Basic (free) plans can only read 25 responses per survey through the API.

See [SurveyMonkey's API documentation](https://api.surveymonkey.com/v3/docs).

The following configurations are available:

* **Access Token**: The access token of your private app.
* **Data Center**: Where your SurveyMonkey account is hosted: `us` if you log in at surveymonkey.com, `eu` for eu.surveymonkey.com, `ca` for surveymonkey.ca.
* **Start Date**: The earliest date to read responses from, by the date each response was last modified. Survey design, collectors, contacts and teams are always read in full.
* **Survey IDs** (advanced): Comma-separated IDs of the surveys to read. Leave empty to read every survey the access token can see, including surveys shared with you.

> [!WARNING]
>
> SurveyMonkey limits each private app to **500 API requests per day** (and 120 per minute) unless you buy a higher limit from SurveyMonkey. The limit resets at midnight GMT. Each sync costs about 1 request per survey for **Collectors**, 1 per survey with responses for **Responses** (plus 1 per 100 new or changed responses), 1 per new or changed survey for the survey design tables, and a few more for the other tables. For example, 200 surveys with every table selected cost more than 400 requests per sync, which fits about one sync per day.
>
> The connector never goes past the limit (SurveyMonkey penalizes apps that do). The survey tables (design, Responses and Response Answers) read as many surveys as today's limit allows, keeping enough requests for the other selected tables, and then end normally: the sync log says how many surveys are pending, and the next syncs continue with them first. The first sync of a large account, or a Full sync, can therefore take several days to complete: until then the tables hold the surveys read so far. This only works with the **Incremental** sync type: a survey table set to **Full table** is replaced on every sync, so when the daily limit cannot cover reading every survey in one sync, that table is marked as failed and keeps its previous data. Use Full table for the survey tables only if your whole account fits in one day's limit. Tables read in full (such as **Collectors** and **Contacts**) are only read when they fit in what is left of the limit; otherwise they are marked as failed with a message about the limit and keep their previous data. **Collectors** costs one request per survey, so on accounts with more surveys than the limit allows it fails every sync: deselect it or set **Survey IDs**. To make syncs fit, select only the tables you need, set **Survey IDs**, or schedule the source less often.

Once you're done, click **Next**.

### 2. Select streams

Choose which data streams you want to sync. For faster extractions, select only the streams that are relevant to your analysis. You can select entire groups of streams or pick specific ones.

> Tip: The stream can be found more easily by typing its name.

Select the streams and click **Next**.

### 3. Configure data streams

Customize how you want your data to appear in your catalog. Select the desired layer where the data will be placed, a folder to organize it inside the layer, a name for each table (which will effectively contain the fetched data) and the type of sync.

* **Layer**: choose between the existing layers on your catalog. This is where you will find your new extracted tables as the extraction runs successfully.
* **Folder**: a folder can be created inside the selected layer to group all tables being created from this new data source.
* **Table name**: we suggest a name, but feel free to customize it. You have the option to add a **prefix** to all tables at once and make this process faster!
* **Sync Type**: you can choose between INCREMENTAL and FULL\_TABLE.
  * Incremental: every time the extraction happens, we'll get only the new data, which is good if, for example, you want to keep every record ever fetched.
  * Full table: every time the extraction happens, we'll get the current state of the data, which is good if, for example, you don't want to have deleted data in your catalog.

> [!NOTE]
>
> On **Incremental**, Responses and Response Answers read, per survey, only the responses created or changed since the previous sync (responses changed in the last 5 minutes are left to the next sync), and the survey design tables re-read only the surveys created or changed since the previous sync. The SurveyMonkey API does not report deletions: deleted responses, questions or answer options stay in incremental tables until a Full sync. When a response is edited, its answers are sent again with the new `response_date_modified`; an answer row whose `response_date_modified` differs from the response's `date_modified` was replaced by that edit. A Full sync reads every response again, which costs as many requests as the first sync and, on an account larger than the daily limit, completes over several days (see the limit above).

Once you are done configuring, click **Next**.

### 4. Configure data source

Describe your data source for easy identification within your organization, not exceeding 140 characters.

To define your [Trigger](https://docs.nekt.com/runs/scheduling-and-triggers.md), consider how often you want data to be extracted from this source. This decision usually depends on how frequently you need the new table data updated (every day, once a week, or only at specific times). Keep SurveyMonkey's daily request limit in mind (see above).

Optionally, you can define some additional settings:

* Configure Delta Log Retention and determine for how long we should store old states of this table as it gets updated. Read more about this resource [here](https://docs.nekt.com/get-started/core-concepts/resource-control).
* Determine when to execute an **Additional [Full Sync](https://docs.nekt.com/get-started/core-concepts/types-of-sync#additional-full-sync)**. This will complement the incremental data extractions, ensuring that your data is completely synchronized with your source every once in a while. It removes deleted responses and questions from incremental tables, at the cost of reading everything again.

Once you are ready, click **Next** to finalize the setup.

### 5. Check your new source

You can view your new source on the [Sources](https://app.nekt.ai/sources) page. If needed, manually trigger the source extraction by clicking on the arrow button. Once executed, your data will appear in your Catalog.

> [!WARNING]
>
> For you to be able to see it on your [Catalog](https://app.nekt.ai/catalog), you need at least one successful source run.

# Streams and Fields

## Available streams

The table below lists every stream, its **slug** (the exact identifier to pass when creating the source via API), its sync type, the app scopes it needs and a short description.

| Stream | Slug | Sync | Scopes needed | Description |
| - | - | - | - | - |
| Surveys | `surveys` | Full table | View Surveys | Every survey the access token can see (owned and shared with the user), with current response and question counts. |
| Survey Folders | `survey_folders` | Full table | View Surveys | Folders that organize surveys. |
| Survey Details | `survey_details` | Incremental | View Surveys | Settings of each survey: folder, category, ownership, quiz options, custom variables and links. |
| Survey Pages | `survey_pages` | Incremental | View Surveys | Pages of each survey. |
| Survey Questions | `survey_questions` | Incremental | View Surveys | Questions of each survey, with type, text, validation and display settings. |
| Survey Question Choices | `survey_question_choices` | Incremental | View Surveys | Every answer option of every question: choices, matrix rows and columns, choices inside matrix column menus and 'other' options. |
| Responses | `responses` | Incremental | View Surveys and View Response Details (Basic plans: up to 25 responses per survey) | Survey responses with status, collector, respondent details, timing and custom variables. |
| Response Answers | `response_answers` | Incremental | View Surveys and View Response Details | One row per answer of a response: a selected choice, a matrix cell, a typed text or an uploaded file. |
| Collectors | `collectors` | Full table | View Surveys and View Collectors | Collectors of every survey (web links, email invitations, SMS and others), with status and response count. |
| Contacts | `contacts` | Full table | View Contacts | Contacts of the account in every status (active, opted out and bounced), with custom fields. |
| Contact Lists | `contact_lists` | Full table | View Contacts | Contact lists of the account. |
| Contact List Members | `contact_list_members` | Full table | View Contacts | Which contact belongs to which contact list, in every status. |
| Contact Fields | `contact_fields` | Full table | View Contacts | Labels of the custom contact fields (the keys of `contacts.custom_fields`). |
| Users | `users` | Full table | View Users | The SurveyMonkey user the access token belongs to, with plan, features and scopes. |
| Teams | `groups` | Full table | View Teams (Team plans) | Teams (groups) the user belongs to. |
| Team Members | `group_members` | Full table | View Teams (Team plans) | Members of each team, with role and status. |
| Workgroups | `workgroups` | Full table | View Workgroups (Team plans) | Workgroups of the team, with members and shared resource counts. |
| Workgroup Members | `workgroup_members` | Full table | View Workgroups and View Workgroup Members (Team plans) | Members of each workgroup. |
| Webhooks | `webhooks` | Full table | View Webhooks | Webhooks configured for the account. |

> [!NOTE]
>
> When your app was not granted the scope a table needs (or your SurveyMonkey plan does not include it), that table is skipped and not updated in that sync, the sync log names it and the scope to enable, and the other tables keep syncing. An invalid or revoked access token fails the sync. If SurveyMonkey refuses one survey (for example a survey shared with you without access to its results), or serves fewer of its responses than it announces even after a second read, that survey is skipped, the sync log names it, the other surveys are loaded, and the survey is tried again in the next sync. In tables replaced in full on every sync (**Collectors**, or a survey table you set to **Full table**), a refused survey's rows are left out of the table. A survey whose responses cannot be read consistently makes a survey table set to **Full table** fail instead, so that table keeps its previous data rather than being saved with a gap. Nested information (custom variables, settings, quiz options) comes as JSON text.

## Fields by stream

### Surveys and design

> [accordion] Surveys
>
> Every survey the access token can see (owned and shared with the user), with current response and question counts.
>
> Table: `surveys` · Primary key: `id` · Sync: Full table · Scopes: View Surveys.
>
> | Field | Type | Description |
> | :- | :- | :- |
> | `id` | String | Unique identifier of the survey. |
> | `title` | String | Title of the survey. |
> | `nickname` | String | Nickname of the survey. |
> | `language` | String | Language of the survey (ISO 639-1 code). |
> | `response_count` | Integer | Number of responses the survey has received. |
> | `question_count` | Integer | Number of questions in the survey. |
> | `date_created` | Date-time | When the survey was created (UTC). |
> | `date_modified` | Date-time | When the survey design was last modified (UTC). |
> | `analyze_url` | String | Link to the survey's results (Analyze) page in SurveyMonkey. |
> | `preview` | String | Link to preview the survey. |
> | `collect_stats` | String (JSON) | Response counts by collector status and type. |
> | `href` | String | API URL of the survey. |
> | `extra_fields` | String (JSON) | Fields SurveyMonkey returned that this connector does not map to a column yet, keyed by their original names. |

> [accordion] Survey Folders
>
> Folders that organize surveys.
>
> Table: `survey_folders` · Primary key: `id` · Sync: Full table · Scopes: View Surveys.
>
> | Field | Type | Description |
> | :- | :- | :- |
> | `id` | String | Unique identifier of the survey folder. |
> | `title` | String | Name of the folder. |
> | `num_surveys` | Integer | Number of surveys in the folder. |
> | `href` | String | API URL of the folder. |
> | `extra_fields` | String (JSON) | Fields SurveyMonkey returned that this connector does not map to a column yet, keyed by their original names. |

> [accordion] Survey Details
>
> Settings of each survey: folder, category, ownership, quiz options, custom variables and links. Re-read only for surveys created or changed since the previous sync.
>
> Table: `survey_details` · Primary key: `id` · Sync: Incremental by `date_modified` · Scopes: View Surveys.
>
> | Field | Type | Description |
> | :- | :- | :- |
> | `id` | String | Unique identifier of the survey. |
> | `title` | String | Title of the survey. |
> | `nickname` | String | Nickname of the survey. |
> | `language` | String | Language of the survey (ISO 639-1 code). |
> | `category` | String | Category chosen when the survey was created. |
> | `folder_id` | String | Identifier of the folder the survey is in (0 when in no folder). |
> | `is_owner` | Boolean | Whether the account behind the token owns the survey (false when it was shared with it). |
> | `owner` | String | Identifier of the owner of the survey. |
> | `page_count` | Integer | Number of pages in the survey. |
> | `question_count` | Integer | Number of questions in the survey. |
> | `response_count` | Integer | Number of responses when the design was read (the surveys table has the current count). |
> | `footer` | Boolean | Whether the SurveyMonkey footer is shown. |
> | `theme_id` | String | Identifier of the theme the survey uses, if any. |
> | `template_id` | String | Identifier of the template the survey was created from, if any. |
> | `custom_variables` | String (JSON) | Custom variables defined for the survey. |
> | `buttons_text` | String (JSON) | Texts of the survey's navigation buttons. |
> | `quiz_options` | String (JSON) | Quiz settings of the survey. |
> | `date_created` | Date-time | When the survey was created (UTC). |
> | `date_modified` | Date-time | When the survey design was last modified (UTC), used as the incremental replication key. |
> | `edit_url` | String | Link to edit the survey in SurveyMonkey. |
> | `collect_url` | String | Link to the survey's collectors page. |
> | `analyze_url` | String | Link to the survey's results (Analyze) page. |
> | `summary_url` | String | Link to the survey's summary page. |
> | `preview` | String | Link to preview the survey. |
> | `href` | String | API URL of the survey. |
> | `extra_fields` | String (JSON) | Fields SurveyMonkey returned that this connector does not map to a column yet, keyed by their original names. |

> [accordion] Survey Pages
>
> Pages of each survey. Re-read only for surveys created or changed since the previous sync.
>
> Table: `survey_pages` · Primary key: `survey_id`, `id` · Sync: Incremental by `survey_date_modified` · Scopes: View Surveys.
>
> | Field | Type | Description |
> | :- | :- | :- |
> | `id` | String | Unique identifier of the page. |
> | `survey_id` | String | Identifier of the survey the page belongs to. |
> | `title` | String | Title of the page. |
> | `description` | String | Description of the page. |
> | `position` | Integer | Position of the page in the survey. |
> | `question_count` | Integer | Number of questions on the page. |
> | `href` | String | API URL of the page. |
> | `survey_date_modified` | Date-time | When the survey design was last modified (UTC); rows of a survey are re-read when it changes, used as the incremental replication key. |
> | `extra_fields` | String (JSON) | Fields SurveyMonkey returned that this connector does not map to a column yet, keyed by their original names. |

> [accordion] Survey Questions
>
> Questions of each survey, with type, text, validation and display settings. Re-read only for surveys created or changed since the previous sync.
>
> Table: `survey_questions` · Primary key: `survey_id`, `id` · Sync: Incremental by `survey_date_modified` · Scopes: View Surveys.
>
> | Field | Type | Description |
> | :- | :- | :- |
> | `id` | String | Unique identifier of the question. |
> | `survey_id` | String | Identifier of the survey the question belongs to. |
> | `page_id` | String | Identifier of the page the question is on. |
> | `position` | Integer | Position of the question on its page. |
> | `heading` | String | Text of the question (its first heading). |
> | `headings` | String (JSON) | All headings of the question (text, description, image, random assignment). |
> | `family` | String | Question family: single\_choice, multiple\_choice, matrix, open\_ended, demographic, datetime or presentation. |
> | `subtype` | String | Subtype of the question family (e.g. vertical, menu, rating, single, essay). |
> | `visible` | Boolean | Whether the question is visible (false when it was deleted in the survey editor). |
> | `forced_ranking` | Boolean | Whether answers must be ranked without ties (matrix questions). |
> | `nickname` | String | Nickname of the question. |
> | `required` | String (JSON) | Whether and how much of the question must be answered. |
> | `validation` | String (JSON) | Validation rules of the answer. |
> | `sorting` | String (JSON) | How the answer options are sorted. |
> | `display_options` | String (JSON) | Display options of the question (e.g. slider, star rating, file upload). |
> | `quiz_options` | String (JSON) | Quiz scoring settings of the question. |
> | `layout` | String (JSON) | Layout settings of the question. |
> | `answers` | String (JSON) | Answer options of the question as returned by SurveyMonkey (also in survey\_question\_choices). |
> | `href` | String | API URL of the question. |
> | `survey_date_modified` | Date-time | When the survey design was last modified (UTC); rows of a survey are re-read when it changes, used as the incremental replication key. |
> | `extra_fields` | String (JSON) | Fields SurveyMonkey returned that this connector does not map to a column yet, keyed by their original names. |

> [accordion] Survey Question Choices
>
> Every answer option of every question: choices, matrix rows and columns, choices inside matrix column menus and 'other' options. Their identifiers are the `choice_id`, `row_id`, `col_id` and `other_id` of Response Answers.
>
> Table: `survey_question_choices` · Primary key: `option_key` · Sync: Incremental by `survey_date_modified` · Scopes: View Surveys.
>
> | Field | Type | Description |
> | :- | :- | :- |
> | `option_key` | String | Unique key of the option: question id, option type, parent column id and option id. |
> | `id` | String | Identifier of the option (the choice\_id, row\_id, col\_id or other\_id found in response\_answers). |
> | `option_type` | String | Kind of option: choice, row, col, col\_choice (a choice inside a matrix column menu) or other. |
> | `parent_id` | String | For col\_choice options, the identifier of the matrix column the choice belongs to. |
> | `survey_id` | String | Identifier of the survey. |
> | `page_id` | String | Identifier of the page of the question. |
> | `question_id` | String | Identifier of the question the option belongs to. |
> | `text` | String | Text of the option. |
> | `position` | Integer | Position of the option within its question. |
> | `visible` | Boolean | Whether the option is visible. |
> | `is_na` | Boolean | Whether the option is a 'not applicable' option. |
> | `weight` | Number | Weight (score) of the option, used in averages. |
> | `description` | String | Description of the option. |
> | `is_answer_choice` | Boolean | For 'other' options, whether the comment field counts as an answer choice. |
> | `quiz_options` | String (JSON) | Quiz scoring of the option. |
> | `image` | String (JSON) | Image of the option (image choice questions). |
> | `survey_date_modified` | Date-time | When the survey design was last modified (UTC); rows of a survey are re-read when it changes, used as the incremental replication key. |
> | `extra_fields` | String (JSON) | Fields SurveyMonkey returned that this connector does not map to a column yet, keyed by their original names. |

### Responses and collectors

> [accordion] Responses
>
> Survey responses with status, collector, respondent details, timing and custom variables. Each sync reads, per survey, the responses created or changed since the previous sync.
>
> Table: `responses` · Primary key: `id` · Sync: Incremental by `date_modified` · Scopes: View Surveys and View Response Details (Basic plans: up to 25 responses per survey).
>
> | Field | Type | Description |
> | :- | :- | :- |
> | `id` | String | Unique identifier of the response. |
> | `survey_id` | String | Identifier of the survey the response is for. |
> | `collector_id` | String | Identifier of the collector the response came through. |
> | `recipient_id` | String | Identifier of the recipient (email and SMS invitation collectors). |
> | `response_status` | String | Status of the response: completed, partial, overquota or disqualified. |
> | `collection_mode` | String | How the response was collected: default, preview, data\_entry, survey\_preview or edit. |
> | `total_time` | Integer | Total time in seconds the respondent spent on the survey. |
> | `date_created` | Date-time | When the response was started (UTC). |
> | `date_modified` | Date-time | When the response was last modified (UTC), used as the incremental replication key. |
> | `ip_address` | String | IP address the response was taken from (empty on anonymous collectors). |
> | `language` | String | Language the response was taken in. |
> | `first_name` | String | First name of the recipient (invitation collectors). |
> | `last_name` | String | Last name of the recipient (invitation collectors). |
> | `email_address` | String | Email address of the recipient (invitation collectors). |
> | `custom_value` | String | Custom value associated with the response. |
> | `custom_variables` | String (JSON) | Values of the survey's custom variables for this response. |
> | `metadata` | String (JSON) | Respondent metadata SurveyMonkey keeps for the response (e.g. contact fields). |
> | `logic_path` | String (JSON) | Survey logic the respondent went through. |
> | `page_path` | Array of strings | Pages the respondent saw, in order. |
> | `quiz_results` | String (JSON) | Quiz score of the response, for quizzes. |
> | `edit_url` | String | Link to edit the response. |
> | `analyze_url` | String | Link to the response in SurveyMonkey's results page. |
> | `href` | String | API URL of the response. |
> | `extra_fields` | String (JSON) | Fields SurveyMonkey returned that this connector does not map to a column yet, keyed by their original names. |

> [accordion] Response Answers
>
> One row per answer of a response: a selected choice, a matrix cell, a typed text or an uploaded file. Join with Survey Questions and Survey Question Choices to get the question and option texts.
>
> Table: `response_answers` · Primary key: `answer_key` · Sync: Incremental by `response_date_modified` · Scopes: View Surveys and View Response Details.
>
> | Field | Type | Description |
> | :- | :- | :- |
> | `answer_key` | String | Unique key of the answer: response, question, row, column, choice and other option ids, plus a counter for repeated answers. |
> | `response_id` | String | Identifier of the response. |
> | `survey_id` | String | Identifier of the survey. |
> | `collector_id` | String | Identifier of the collector the response came through. |
> | `page_id` | String | Identifier of the page of the question. |
> | `question_id` | String | Identifier of the question answered. |
> | `variable_id` | String | Identifier of the random assignment variable of the question, if any. |
> | `choice_id` | String | Identifier of the selected choice (see survey\_question\_choices). |
> | `row_id` | String | Identifier of the matrix row answered (or the text box of a multi-box question). |
> | `col_id` | String | Identifier of the matrix column answered. |
> | `other_id` | String | Identifier of the 'other' option answered. |
> | `text` | String | Text typed by the respondent (open-ended answers and 'other' comments). |
> | `download_url` | String | Download link of an uploaded file (file upload questions); expires about 12 hours after the sync. |
> | `human_download_url` | String | Non-expiring link to an uploaded file, for people (requires logging in to SurveyMonkey). |
> | `download_url_error` | String | Why an uploaded file cannot be downloaded, if so. |
> | `content_type` | String | MIME type of an uploaded file. |
> | `choice_metadata` | String (JSON) | Metadata of the selected choice (e.g. its weight). |
> | `tag_data` | String (JSON) | Tags (user or sentiment) on an open-ended answer. |
> | `response_date_modified` | Date-time | When the response was last modified (UTC), used as the incremental replication key. Answers of a response are re-sent whenever it changes, so an answer row whose value differs from responses.date\_modified was replaced or removed by a later edit. |
> | `extra_fields` | String (JSON) | Fields SurveyMonkey returned that this connector does not map to a column yet, keyed by their original names. |

> [accordion] Collectors
>
> Collectors of every survey (web links, email invitations, SMS and others), with status and response count.
>
> Table: `collectors` · Primary key: `id` · Sync: Full table · Scopes: View Surveys and View Collectors.
>
> | Field | Type | Description |
> | :- | :- | :- |
> | `id` | String | Unique identifier of the collector. |
> | `survey_id` | String | Identifier of the survey the collector belongs to. |
> | `name` | String | Name of the collector. |
> | `type` | String | Type of collector: weblink, email, sms, popup. |
> | `status` | String | Status of the collector: open, closed or new. |
> | `response_count` | Integer | Number of responses received through the collector. |
> | `url` | String | Link respondents use to take the survey (weblink collectors). |
> | `date_created` | Date-time | When the collector was created (UTC). |
> | `date_modified` | Date-time | When the collector was last modified (UTC). |
> | `href` | String | API URL of the collector. |
> | `extra_fields` | String (JSON) | Fields SurveyMonkey returned that this connector does not map to a column yet, keyed by their original names. |

### Contacts

> [accordion] Contacts
>
> Contacts of the account in every status (active, opted out and bounced), with custom fields.
>
> Table: `contacts` · Primary key: `id` · Sync: Full table · Scopes: View Contacts.
>
> | Field | Type | Description |
> | :- | :- | :- |
> | `id` | String | Unique identifier of the contact. |
> | `email` | String | Email address of the contact. |
> | `first_name` | String | First name of the contact. |
> | `last_name` | String | Last name of the contact. |
> | `phone_number` | String | Phone number of the contact. |
> | `status` | String | Status of the contact: active, optout (unsubscribed) or bounced. |
> | `custom_fields` | String (JSON) | Values of the contact's custom fields, keyed by field number (see contact\_fields). |
> | `href` | String | API URL of the contact. |
> | `extra_fields` | String (JSON) | Fields SurveyMonkey returned that this connector does not map to a column yet, keyed by their original names. |

> [accordion] Contact Lists
>
> Contact lists of the account.
>
> Table: `contact_lists` · Primary key: `id` · Sync: Full table · Scopes: View Contacts.
>
> | Field | Type | Description |
> | :- | :- | :- |
> | `id` | String | Unique identifier of the contact list. |
> | `name` | String | Name of the contact list. |
> | `href` | String | API URL of the contact list. |
> | `extra_fields` | String (JSON) | Fields SurveyMonkey returned that this connector does not map to a column yet, keyed by their original names. |

> [accordion] Contact List Members
>
> Which contact belongs to which contact list, in every status.
>
> Table: `contact_list_members` · Primary key: `contact_list_id`, `contact_id` · Sync: Full table · Scopes: View Contacts.
>
> | Field | Type | Description |
> | :- | :- | :- |
> | `contact_list_id` | String | Identifier of the contact list. |
> | `contact_id` | String | Identifier of the contact (see contacts). |
> | `status` | String | Status of the contact: active, optout (unsubscribed) or bounced. |
> | `email` | String | Email address of the contact. |
> | `extra_fields` | String (JSON) | Fields SurveyMonkey returned that this connector does not map to a column yet, keyed by their original names. |

> [accordion] Contact Fields
>
> Labels of the custom contact fields (the keys of `contacts.custom_fields`).
>
> Table: `contact_fields` · Primary key: `id` · Sync: Full table · Scopes: View Contacts.
>
> | Field | Type | Description |
> | :- | :- | :- |
> | `id` | String | Number of the custom contact field (the key used in contacts.custom\_fields). |
> | `label` | String | Label of the custom contact field. |
> | `href` | String | API URL of the field. |
> | `extra_fields` | String (JSON) | Fields SurveyMonkey returned that this connector does not map to a column yet, keyed by their original names. |

### Account, teams and webhooks

> [accordion] Users
>
> The SurveyMonkey user the access token belongs to, with plan, features and scopes.
>
> Table: `users` · Primary key: `id` · Sync: Full table · Scopes: View Users.
>
> | Field | Type | Description |
> | :- | :- | :- |
> | `id` | String | Unique identifier of the user. |
> | `username` | String | Username. |
> | `first_name` | String | First name of the user. |
> | `last_name` | String | Last name of the user. |
> | `email` | String | Email address of the account. |
> | `email_verified` | Boolean | Whether the email address was verified. |
> | `language` | String | Language of the account (ISO 639-1 code). |
> | `account_type` | String | SurveyMonkey plan of the account. |
> | `date_created` | Date-time | When the account was created (UTC). |
> | `date_last_login` | Date-time | When the user last logged in (UTC). |
> | `scopes` | String (JSON) | Scopes available to the account and granted to the app. |
> | `features` | String (JSON) | Features of the account's plan. |
> | `question_types` | String (JSON) | Question types available to the account. |
> | `sso_connections` | String (JSON) | Single sign-on connections of the account. |
> | `href` | String | API URL of the user. |
> | `extra_fields` | String (JSON) | Fields SurveyMonkey returned that this connector does not map to a column yet, keyed by their original names. |

> [accordion] Teams
>
> Teams (groups) the user belongs to.
>
> Table: `groups` · Primary key: `id` · Sync: Full table · Scopes: View Teams (Team plans).
>
> | Field | Type | Description |
> | :- | :- | :- |
> | `id` | String | Unique identifier of the team (group). |
> | `name` | String | Name of the team. |
> | `member_count` | Integer | Number of members in the team. |
> | `max_invites` | Integer | Maximum number of members the team can invite. |
> | `date_created` | Date-time | When the team was created (UTC). |
> | `href` | String | API URL of the team. |
> | `extra_fields` | String (JSON) | Fields SurveyMonkey returned that this connector does not map to a column yet, keyed by their original names. |

> [accordion] Team Members
>
> Members of each team, with role and status.
>
> Table: `group_members` · Primary key: `group_id`, `id` · Sync: Full table · Scopes: View Teams (Team plans).
>
> | Field | Type | Description |
> | :- | :- | :- |
> | `id` | String | Identifier of the membership. |
> | `group_id` | String | Identifier of the team (group). |
> | `user_id` | String | Identifier of the SurveyMonkey user. |
> | `username` | String | Username of the member. |
> | `first_name` | String | First name of the member. |
> | `last_name` | String | Last name of the member. |
> | `email` | String | Email address of the member. |
> | `type` | String | Role of the member: regular, admin or account\_owner. |
> | `status` | String | Whether the member accepted the invitation: active or pending. |
> | `language` | String | Language of the member. |
> | `date_created` | Date-time | When the member joined the team (UTC). |
> | `href` | String | API URL of the membership. |
> | `extra_fields` | String (JSON) | Fields SurveyMonkey returned that this connector does not map to a column yet, keyed by their original names. |

> [accordion] Workgroups
>
> Workgroups of the team, with members and shared resource counts.
>
> Table: `workgroups` · Primary key: `id` · Sync: Full table · Scopes: View Workgroups (Team plans).
>
> | Field | Type | Description |
> | :- | :- | :- |
> | `id` | String | Unique identifier of the workgroup. |
> | `name` | String | Name of the workgroup. |
> | `description` | String | Description of the workgroup. |
> | `organization_id` | String | Identifier of the organization the workgroup belongs to. |
> | `is_visible` | Boolean | Whether the workgroup is visible. |
> | `members_count` | Integer | Number of members in the workgroup. |
> | `share_count` | Integer | Number of resources shared with the workgroup. |
> | `members` | String (JSON) | Members of the workgroup (user id and whether they own it). |
> | `membership` | String (JSON) | Membership of the token's user in the workgroup. |
> | `default_role` | String (JSON) | Default role of the workgroup. |
> | `created_at` | Date-time | When the workgroup was created (UTC). |
> | `updated_at` | Date-time | When the workgroup was last updated (UTC). |
> | `extra_fields` | String (JSON) | Fields SurveyMonkey returned that this connector does not map to a column yet, keyed by their original names. |

> [accordion] Workgroup Members
>
> Members of each workgroup.
>
> Table: `workgroup_members` · Primary key: `workgroup_id`, `id` · Sync: Full table · Scopes: View Workgroups and View Workgroup Members (Team plans).
>
> | Field | Type | Description |
> | :- | :- | :- |
> | `id` | String | User identifier of the member. |
> | `workgroup_id` | String | Identifier of the workgroup. |
> | `status` | String | Status of the member: active or pending. |
> | `is_workgroup_owner` | Boolean | Whether the member owns the workgroup. |
> | `role_assignment_id` | String | Identifier of the role assigned to the member. |
> | `created_at` | Date-time | When the member was added (UTC). |
> | `updated_at` | Date-time | When the membership was last updated (UTC). |
> | `extra_fields` | String (JSON) | Fields SurveyMonkey returned that this connector does not map to a column yet, keyed by their original names. |

> [accordion] Webhooks
>
> Webhooks configured for the account. The authorization header SurveyMonkey sends with webhook events is never read into the table.
>
> Table: `webhooks` · Primary key: `id` · Sync: Full table · Scopes: View Webhooks.
>
> | Field | Type | Description |
> | :- | :- | :- |
> | `id` | String | Unique identifier of the webhook. |
> | `name` | String | Name of the webhook. |
> | `event_type` | String | Event the webhook listens to (e.g. response\_completed, survey\_created). |
> | `object_type` | String | Type of object the events are filtered by: survey, collector or app. |
> | `object_ids` | Array of strings | Identifiers of the objects the events are filtered by. |
> | `subscription_url` | String | URL the events are sent to. |
> | `href` | String | API URL of the webhook. |
> | `extra_fields` | String (JSON) | Fields SurveyMonkey returned that this connector does not map to a column yet, keyed by their original names. |


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.