> Markdown versions of all pages of this connector library are available by appending `.md` to the page URL. For the full index of connectors, see [llms.txt](https://connectors.appmixer.com/llms.txt).

# Find Contacts

- Component: `appmixer.surveymonkey.core.FindContacts`
- Kind: Action
- Version: 1.0.0
- Visibility: Public
- Connector: [appmixer.surveymonkey 1.0.0](https://connectors.appmixer.com/connector/appmixer.surveymonkey/1.0.0.md)
- Component page: <https://connectors.appmixer.com/connector/appmixer.surveymonkey/1.0.0/component/appmixer.surveymonkey.core.FindContacts>

Find contacts in your SurveyMonkey address book by email, first name or last name. Returns up to 1000 contacts.

## Input ports

### Port `in`

| Field | Type | Description |
| --- | --- | --- |
| Search By (`searchBy`) | select | The contact field the search text is matched against. |
| Search (`search`) | text | The text to search for. Leave empty to return all contacts with the selected status. |
| Status (`status`) | select | Only contacts with this status. SurveyMonkey returns active contacts by default. |
| Output Type (`outputType`) | select | Choose whether you want to receive the result set as one complete list, or first item only or one item at a time or stream the items to a file. |

## Output ports

### Port `out`

Variables are loaded dynamically from `/component/appmixer/surveymonkey/core/FindContacts?outPort=out&ignoreAuth=true`.

### Port `notFound`

_No fields defined for this port._

## Full metadata (component.json)

```json
{
  "name": "appmixer.surveymonkey.core.FindContacts",
  "label": "Find Contacts",
  "description": "Find contacts in your SurveyMonkey address book by email, first name or last name. Returns up to 1000 contacts.",
  "author": "Appmixer <info@appmixer.com>",
  "version": "1.0.0",
  "auth": {
    "service": "appmixer:surveymonkey"
  },
  "quota": {
    "manager": "appmixer:surveymonkey",
    "resources": "requests",
    "scope": {
      "userId": "{{userId}}"
    }
  },
  "inPorts": [
    {
      "name": "in",
      "schema": {
        "type": "object",
        "properties": {
          "searchBy": {
            "type": "string",
            "enum": [
              "email",
              "first_name",
              "last_name"
            ]
          },
          "search": {
            "type": "string"
          },
          "status": {
            "type": "string",
            "enum": [
              "active",
              "optout",
              "bounced"
            ]
          },
          "outputType": {
            "type": "string",
            "default": "array"
          }
        }
      },
      "inspector": {
        "inputs": {
          "searchBy": {
            "type": "select",
            "index": 1,
            "label": "Search By",
            "defaultValue": "email",
            "tooltip": "The contact field the search text is matched against.",
            "options": [
              {
                "label": "Email",
                "value": "email"
              },
              {
                "label": "First Name",
                "value": "first_name"
              },
              {
                "label": "Last Name",
                "value": "last_name"
              }
            ]
          },
          "search": {
            "type": "text",
            "index": 2,
            "label": "Search",
            "tooltip": "The text to search for. Leave empty to return all contacts with the selected status."
          },
          "status": {
            "type": "select",
            "index": 3,
            "label": "Status",
            "defaultValue": "active",
            "tooltip": "Only contacts with this status. SurveyMonkey returns active contacts by default.",
            "options": [
              {
                "label": "Active",
                "value": "active"
              },
              {
                "label": "Opted out",
                "value": "optout"
              },
              {
                "label": "Bounced",
                "value": "bounced"
              }
            ]
          },
          "outputType": {
            "type": "select",
            "label": "Output Type",
            "index": 4,
            "defaultValue": "array",
            "tooltip": "Choose whether you want to receive the result set as one complete list, or first item only or one item at a time or stream the items to a file.",
            "options": [
              {
                "label": "First Item Only",
                "value": "first"
              },
              {
                "label": "All items at once",
                "value": "array"
              },
              {
                "label": "One item at a time",
                "value": "object"
              },
              {
                "label": "Store to CSV file",
                "value": "file"
              }
            ]
          }
        }
      }
    }
  ],
  "outPorts": [
    {
      "name": "out",
      "source": {
        "url": "/component/appmixer/surveymonkey/core/FindContacts?outPort=out&ignoreAuth=true",
        "data": {
          "properties": {
            "generateOutputPortOptions": true
          },
          "messages": {
            "in/outputType": "inputs/in/outputType"
          }
        }
      }
    },
    {
      "name": "notFound",
      "options": []
    }
  ],
  "icon": "(data URI omitted)"
}
```
