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

# findymail

> Findymail API

**Server path:** `/findymail` | **Type:** Application | **PCID required:** Yes

## Tools

| Tool                                                                                  | Description                   |
| ------------------------------------------------------------------------------------- | ----------------------------- |
| [`findymail_add_excluded_domains`](#findymail_add_excluded_domains)                   | Add excluded domains          |
| [`findymail_create_amonitor`](#findymail_create_amonitor)                             | Create a monitor              |
| [`findymail_create_anew_exclusion_list`](#findymail_create_anew_exclusion_list)       | Create a new exclusion list   |
| [`findymail_create_anew_list`](#findymail_create_anew_list)                           | Create a new list             |
| [`findymail_delete_agiven_list`](#findymail_delete_agiven_list)                       | Delete a given list           |
| [`findymail_delete_amonitor`](#findymail_delete_amonitor)                             | Delete a monitor              |
| [`findymail_delete_an_exclusion_list`](#findymail_delete_an_exclusion_list)           | Delete an exclusion list      |
| [`findymail_find_employees`](#findymail_find_employees)                               | Find employees                |
| [`findymail_find_from_business_profile`](#findymail_find_from_business_profile)       | Find from business profile    |
| [`findymail_find_from_domain`](#findymail_find_from_domain)                           | Find from domain              |
| [`findymail_find_from_name`](#findymail_find_from_name)                               | Find from name                |
| [`findymail_find_phone`](#findymail_find_phone)                                       | Find phone                    |
| [`findymail_get_all_exclusion_lists`](#findymail_get_all_exclusion_lists)             | Get all exclusion lists       |
| [`findymail_get_asignal`](#findymail_get_asignal)                                     | Get a signal                  |
| [`findymail_get_company_information`](#findymail_get_company_information)             | Get company information       |
| [`findymail_get_contacts_saved`](#findymail_get_contacts_saved)                       | Get contacts saved            |
| [`findymail_get_excluded_domains`](#findymail_get_excluded_domains)                   | Get excluded domains          |
| [`findymail_get_exclusion_list_details`](#findymail_get_exclusion_list_details)       | Get exclusion list details    |
| [`findymail_get_export_status`](#findymail_get_export_status)                         | Get export status             |
| [`findymail_get_remaining_credits`](#findymail_get_remaining_credits)                 | Get remaining credits         |
| [`findymail_get_results`](#findymail_get_results)                                     | Get results                   |
| [`findymail_get_team_usage`](#findymail_get_team_usage)                               | Get team usage                |
| [`findymail_get_the_list_of_contact_lists`](#findymail_get_the_list_of_contact_lists) | Get the list of contact lists |
| [`findymail_get_usage`](#findymail_get_usage)                                         | Get usage                     |
| [`findymail_list_monitors`](#findymail_list_monitors)                                 | List monitors                 |
| [`findymail_list_signals`](#findymail_list_signals)                                   | List signals                  |
| [`findymail_lookup_reverse_email`](#findymail_lookup_reverse_email)                   | Reverse email lookup          |
| [`findymail_remove_excluded_domains`](#findymail_remove_excluded_domains)             | Remove excluded domains       |
| [`findymail_search_leads`](#findymail_search_leads)                                   | Search leads                  |
| [`findymail_search_lookalike_companies`](#findymail_search_lookalike_companies)       | Search lookalike companies    |
| [`findymail_update_acontact_list`](#findymail_update_acontact_list)                   | Update a contact list         |
| [`findymail_update_amonitor`](#findymail_update_amonitor)                             | Update a monitor              |
| [`findymail_update_an_exclusion_list`](#findymail_update_an_exclusion_list)           | Update an exclusion list      |
| [`findymail_verify_an_email`](#findymail_verify_an_email)                             | Verify an email               |

***

## findymail\_add\_excluded\_domains

Add excluded domains

**Parameters:**

| Parameter | Type      | Required | Default | Description                                                                                  |
| --------- | --------- | -------- | ------- | -------------------------------------------------------------------------------------------- |
| `domains` | string\[] | Yes      | —       | Array of domain names to exclude (max 10000).                                                |
| `list_id` | integer   | No       | —       | Optional list ID to add domains to. If not provided, domains are added as global exclusions. |

<Expandable title="inputSchema">
  ```json theme={null}
  {
    "type": "object",
    "properties": {
      "PCID": {
        "type": "string",
        "description": "Pink Connect ID for the authenticated connection"
      },
      "domains": {
        "type": "array",
        "items": {
          "type": "string"
        },
        "description": "Array of domain names to exclude (max 10000)."
      },
      "list_id": {
        "type": "integer",
        "description": "Optional list ID to add domains to. If not provided, domains are added as global exclusions."
      }
    },
    "required": [
      "PCID",
      "domains"
    ]
  }
  ```
</Expandable>

***

## findymail\_create\_amonitor

Create a monitor

**Parameters:**

| Parameter          | Type      | Required | Default | Description                                                                                                                                                                                                                                                                                                                                                                                    |
| ------------------ | --------- | -------- | ------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `engagement_types` | string\[] | No       | —       | Engagement types to track (required for post\_engagement). Accepted values: `like`, `comment`.                                                                                                                                                                                                                                                                                                 |
| `enrichment_level` | string    | No       | —       | Contact enrichment level. Accepted values: `email`, `email_phone`.                                                                                                                                                                                                                                                                                                                             |
| `icp_filters`      | object    | No       | —       | Optional ICP filter criteria to narrow signal matching.                                                                                                                                                                                                                                                                                                                                        |
| `keywords`         | string\[] | No       | —       | Keywords to track (required for keyword\_mention and post\_engagement without post\_url, max 5).                                                                                                                                                                                                                                                                                               |
| `lead_list_id`     | integer   | No       | —       | ID of a lead list to automatically add matched contacts to.                                                                                                                                                                                                                                                                                                                                    |
| `name`             | string    | Yes      | —       | The monitor name.                                                                                                                                                                                                                                                                                                                                                                              |
| `post_url`         | string    | No       | —       | LinkedIn post URL to monitor engagement on (for post\_engagement type).                                                                                                                                                                                                                                                                                                                        |
| `signal_type`      | string    | Yes      | —       | The signal type. Accepted values: `keyword_mention`, `new_hire`, `job_change`, `post_engagement`. IMPORTANT: Additional fields are required depending on signal\_type: (1) keyword\_mention requires `keywords`. (2) post\_engagement requires `engagement_types` AND either `post_url` or `keywords`. Omitting these conditionally-required fields will cause a server-side validation error. |
| `webhook_url`      | string    | No       | —       | Optional HTTPS URL to receive webhook notifications when new signals match.                                                                                                                                                                                                                                                                                                                    |

<Expandable title="inputSchema">
  ```json theme={null}
  {
    "type": "object",
    "properties": {
      "PCID": {
        "type": "string",
        "description": "Pink Connect ID for the authenticated connection"
      },
      "engagement_types": {
        "type": "array",
        "items": {
          "type": "string"
        },
        "description": "Engagement types to track (required for post_engagement). Accepted values: `like`, `comment`."
      },
      "enrichment_level": {
        "type": "string",
        "description": "Contact enrichment level. Accepted values: `email`, `email_phone`."
      },
      "icp_filters": {
        "type": "object",
        "description": "Optional ICP filter criteria to narrow signal matching.",
        "properties": {
          "industries": {
            "type": "array",
            "items": {
              "type": "string"
            },
            "description": "Industries to match (LinkedIn Industry Codes V2)."
          },
          "employee_count_ranges": {
            "type": "array",
            "items": {
              "type": "string"
            },
            "description": "Employee count ranges. Accepted values: `1-10`, `11-50`, `51-200`, `201-500`, `501-1000`, `1001-5000`, `5001-10000`, `10001+`."
          },
          "countries": {
            "type": "array",
            "items": {
              "type": "string"
            },
            "description": "2-letter ISO 3166-1 alpha-2 country codes."
          },
          "job_title_keywords": {
            "type": "array",
            "items": {
              "type": "string"
            },
            "description": "Job title keywords to match (max 10)."
          },
          "seniority_levels": {
            "type": "array",
            "items": {
              "type": "integer"
            },
            "description": "Seniority levels (1=Entry, 4=IC, 6=Senior IC, 8=Management, 9=Director, 11=VP, 13=Executive, 14=C-Suite, 15=Founder)."
          }
        }
      },
      "keywords": {
        "type": "array",
        "items": {
          "type": "string"
        },
        "description": "Keywords to track (required for keyword_mention and post_engagement without post_url, max 5)."
      },
      "lead_list_id": {
        "type": "integer",
        "description": "ID of a lead list to automatically add matched contacts to."
      },
      "name": {
        "type": "string",
        "description": "The monitor name."
      },
      "post_url": {
        "type": "string",
        "description": "LinkedIn post URL to monitor engagement on (for post_engagement type)."
      },
      "signal_type": {
        "type": "string",
        "description": "The signal type. Accepted values: `keyword_mention`, `new_hire`, `job_change`, `post_engagement`. IMPORTANT: Additional fields are required depending on signal_type: (1) keyword_mention requires `keywords`. (2) post_engagement requires `engagement_types` AND either `post_url` or `keywords`. Omitting these conditionally-required fields will cause a server-side validation error."
      },
      "webhook_url": {
        "type": "string",
        "description": "Optional HTTPS URL to receive webhook notifications when new signals match."
      }
    },
    "required": [
      "PCID",
      "name",
      "signal_type"
    ]
  }
  ```
</Expandable>

***

## findymail\_create\_anew\_exclusion\_list

Create a new exclusion list

**Parameters:**

| Parameter   | Type    | Required | Default | Description                                      |
| ----------- | ------- | -------- | ------- | ------------------------------------------------ |
| `is_shared` | boolean | No       | —       | Whether to share the list with the current team. |
| `name`      | string  | Yes      | —       | The name of the list (must be unique per user).  |

<Expandable title="inputSchema">
  ```json theme={null}
  {
    "type": "object",
    "properties": {
      "PCID": {
        "type": "string",
        "description": "Pink Connect ID for the authenticated connection"
      },
      "is_shared": {
        "type": "boolean",
        "description": "Whether to share the list with the current team."
      },
      "name": {
        "type": "string",
        "description": "The name of the list (must be unique per user)."
      }
    },
    "required": [
      "PCID",
      "name"
    ]
  }
  ```
</Expandable>

***

## findymail\_create\_anew\_list

Create a new list

**Parameters:**

| Parameter | Type   | Required | Default | Description      |
| --------- | ------ | -------- | ------- | ---------------- |
| `name`    | string | Yes      | —       | Name of the list |

<Expandable title="inputSchema">
  ```json theme={null}
  {
    "type": "object",
    "properties": {
      "PCID": {
        "type": "string",
        "description": "Pink Connect ID for the authenticated connection"
      },
      "name": {
        "type": "string",
        "description": "Name of the list"
      }
    },
    "required": [
      "PCID",
      "name"
    ]
  }
  ```
</Expandable>

***

## findymail\_delete\_agiven\_list

Delete a given list

**Parameters:**

| Parameter | Type    | Required | Default | Description         |
| --------- | ------- | -------- | ------- | ------------------- |
| `id`      | integer | Yes      | —       | The ID of the list. |

<Expandable title="inputSchema">
  ```json theme={null}
  {
    "type": "object",
    "properties": {
      "PCID": {
        "type": "string",
        "description": "Pink Connect ID for the authenticated connection"
      },
      "id": {
        "type": "integer",
        "description": "The ID of the list."
      }
    },
    "required": [
      "PCID",
      "id"
    ]
  }
  ```
</Expandable>

***

## findymail\_delete\_amonitor

Delete a monitor

**Parameters:**

| Parameter | Type    | Required | Default | Description            |
| --------- | ------- | -------- | ------- | ---------------------- |
| `id`      | integer | Yes      | —       | The ID of the monitor. |

<Expandable title="inputSchema">
  ```json theme={null}
  {
    "type": "object",
    "properties": {
      "PCID": {
        "type": "string",
        "description": "Pink Connect ID for the authenticated connection"
      },
      "id": {
        "type": "integer",
        "description": "The ID of the monitor."
      }
    },
    "required": [
      "PCID",
      "id"
    ]
  }
  ```
</Expandable>

***

## findymail\_delete\_an\_exclusion\_list

Delete an exclusion list

**Parameters:**

| Parameter               | Type    | Required | Default | Description                       |
| ----------------------- | ------- | -------- | ------- | --------------------------------- |
| `excludedDomainList_id` | integer | Yes      | —       | The ID of the excludedDomainList. |

<Expandable title="inputSchema">
  ```json theme={null}
  {
    "type": "object",
    "properties": {
      "PCID": {
        "type": "string",
        "description": "Pink Connect ID for the authenticated connection"
      },
      "excludedDomainList_id": {
        "type": "integer",
        "description": "The ID of the excludedDomainList."
      }
    },
    "required": [
      "PCID",
      "excludedDomainList_id"
    ]
  }
  ```
</Expandable>

***

## findymail\_find\_employees

Find employees

**Parameters:**

| Parameter    | Type      | Required | Default | Description                                      |
| ------------ | --------- | -------- | ------- | ------------------------------------------------ |
| `count`      | integer   | No       | —       | Number of contacts to return (max 5). Default 1. |
| `job_titles` | string\[] | Yes      | —       | target job titles (max 10)                       |
| `website`    | string    | Yes      | —       | company website                                  |

<Expandable title="inputSchema">
  ```json theme={null}
  {
    "type": "object",
    "properties": {
      "PCID": {
        "type": "string",
        "description": "Pink Connect ID for the authenticated connection"
      },
      "count": {
        "type": "integer",
        "description": "Number of contacts to return (max 5). Default 1."
      },
      "job_titles": {
        "type": "array",
        "items": {
          "type": "string"
        },
        "description": "target job titles (max 10)"
      },
      "website": {
        "type": "string",
        "description": "company website"
      }
    },
    "required": [
      "PCID",
      "job_titles",
      "website"
    ]
  }
  ```
</Expandable>

***

## findymail\_find\_from\_business\_profile

Find from business profile

**Parameters:**

| Parameter      | Type   | Required | Default | Description                                                                                                                                         |
| -------------- | ------ | -------- | ------- | --------------------------------------------------------------------------------------------------------------------------------------------------- |
| `linkedin_url` | string | Yes      | —       | Person's business profile URL. (can be full URL "[https://linkedin.com/in/johndoe](https://linkedin.com/in/johndoe)" or username only "johndoe")    |
| `webhook_url`  | string | No       | —       | Webhook URL that will receive the result as callback. If submitted, email search will happen in the background and notify this URL upon completion. |

<Expandable title="inputSchema">
  ```json theme={null}
  {
    "type": "object",
    "properties": {
      "PCID": {
        "type": "string",
        "description": "Pink Connect ID for the authenticated connection"
      },
      "linkedin_url": {
        "type": "string",
        "description": "Person's business profile URL. (can be full URL \"https://linkedin.com/in/johndoe\" or username only \"johndoe\")"
      },
      "webhook_url": {
        "type": "string",
        "description": "Webhook URL that will receive the result as callback. If submitted, email search will happen in the background and notify this URL upon completion."
      }
    },
    "required": [
      "PCID",
      "linkedin_url"
    ]
  }
  ```
</Expandable>

***

## findymail\_find\_from\_domain

Find from domain

**Parameters:**

| Parameter     | Type      | Required | Default | Description                                                                                                                                   |
| ------------- | --------- | -------- | ------- | --------------------------------------------------------------------------------------------------------------------------------------------- |
| `domain`      | string    | Yes      | —       | Email domain                                                                                                                                  |
| `roles`       | string\[] | Yes      | —       | Target roles related to the given domain (max 3 roles)                                                                                        |
| `webhook_url` | string    | No       | —       | Webhook URL that will receive the result as callback. If submitted, search will happen in the background and notify this URL upon completion. |

<Expandable title="inputSchema">
  ```json theme={null}
  {
    "type": "object",
    "properties": {
      "PCID": {
        "type": "string",
        "description": "Pink Connect ID for the authenticated connection"
      },
      "domain": {
        "type": "string",
        "description": "Email domain"
      },
      "roles": {
        "type": "array",
        "items": {
          "type": "string"
        },
        "description": "Target roles related to the given domain (max 3 roles)"
      },
      "webhook_url": {
        "type": "string",
        "description": "Webhook URL that will receive the result as callback. If submitted, search will happen in the background and notify this URL upon completion."
      }
    },
    "required": [
      "PCID",
      "domain",
      "roles"
    ]
  }
  ```
</Expandable>

***

## findymail\_find\_from\_name

Find from name

**Parameters:**

| Parameter     | Type   | Required | Default | Description                                                                                                                                         |
| ------------- | ------ | -------- | ------- | --------------------------------------------------------------------------------------------------------------------------------------------------- |
| `domain`      | string | Yes      | —       | Company domain (best) or company name                                                                                                               |
| `name`        | string | Yes      | —       | Person's full name                                                                                                                                  |
| `webhook_url` | string | No       | —       | Webhook URL that will receive the result as callback. If submitted, email search will happen in the background and notify this URL upon completion. |

<Expandable title="inputSchema">
  ```json theme={null}
  {
    "type": "object",
    "properties": {
      "PCID": {
        "type": "string",
        "description": "Pink Connect ID for the authenticated connection"
      },
      "domain": {
        "type": "string",
        "description": "Company domain (best) or company name"
      },
      "name": {
        "type": "string",
        "description": "Person's full name"
      },
      "webhook_url": {
        "type": "string",
        "description": "Webhook URL that will receive the result as callback. If submitted, email search will happen in the background and notify this URL upon completion."
      }
    },
    "required": [
      "PCID",
      "domain",
      "name"
    ]
  }
  ```
</Expandable>

***

## findymail\_find\_phone

Find phone

**Parameters:**

| Parameter      | Type   | Required | Default | Description                                                                                                                                      |
| -------------- | ------ | -------- | ------- | ------------------------------------------------------------------------------------------------------------------------------------------------ |
| `linkedin_url` | string | Yes      | —       | Person's business profile URL. (can be full URL "[https://linkedin.com/in/johndoe](https://linkedin.com/in/johndoe)" or username only "johndoe") |

<Expandable title="inputSchema">
  ```json theme={null}
  {
    "type": "object",
    "properties": {
      "PCID": {
        "type": "string",
        "description": "Pink Connect ID for the authenticated connection"
      },
      "linkedin_url": {
        "type": "string",
        "description": "Person's business profile URL. (can be full URL \"https://linkedin.com/in/johndoe\" or username only \"johndoe\")"
      }
    },
    "required": [
      "PCID",
      "linkedin_url"
    ]
  }
  ```
</Expandable>

***

## findymail\_get\_all\_exclusion\_lists

Get all exclusion lists

<Expandable title="inputSchema">
  ```json theme={null}
  {
    "type": "object",
    "properties": {
      "PCID": {
        "type": "string",
        "description": "Pink Connect ID for the authenticated connection"
      }
    },
    "required": [
      "PCID"
    ]
  }
  ```
</Expandable>

***

## findymail\_get\_asignal

Get a signal

**Parameters:**

| Parameter | Type    | Required | Default | Description           |
| --------- | ------- | -------- | ------- | --------------------- |
| `id`      | integer | Yes      | —       | The ID of the signal. |

<Expandable title="inputSchema">
  ```json theme={null}
  {
    "type": "object",
    "properties": {
      "PCID": {
        "type": "string",
        "description": "Pink Connect ID for the authenticated connection"
      },
      "id": {
        "type": "integer",
        "description": "The ID of the signal."
      }
    },
    "required": [
      "PCID",
      "id"
    ]
  }
  ```
</Expandable>

***

## findymail\_get\_company\_information

Get company information

**Parameters:**

| Parameter      | Type   | Required | Default | Description          |
| -------------- | ------ | -------- | ------- | -------------------- |
| `domain`       | string | No       | —       | Company domain       |
| `linkedin_url` | string | No       | —       | Company LinkedIn URL |
| `name`         | string | No       | —       | Company name         |

<Expandable title="inputSchema">
  ```json theme={null}
  {
    "type": "object",
    "properties": {
      "PCID": {
        "type": "string",
        "description": "Pink Connect ID for the authenticated connection"
      },
      "domain": {
        "type": "string",
        "description": "Company domain"
      },
      "linkedin_url": {
        "type": "string",
        "description": "Company LinkedIn URL"
      },
      "name": {
        "type": "string",
        "description": "Company name"
      }
    },
    "required": [
      "PCID"
    ]
  }
  ```
</Expandable>

***

## findymail\_get\_contacts\_saved

Get contacts saved

**Parameters:**

| Parameter | Type    | Required | Default | Description                                                                                  |
| --------- | ------- | -------- | ------- | -------------------------------------------------------------------------------------------- |
| `id`      | integer | Yes      | —       | Optional parameter. Get contacts from a specified list. If 0, no list used ("All contacts"). |

<Expandable title="inputSchema">
  ```json theme={null}
  {
    "type": "object",
    "properties": {
      "PCID": {
        "type": "string",
        "description": "Pink Connect ID for the authenticated connection"
      },
      "id": {
        "type": "integer",
        "description": "Optional parameter. Get contacts from a specified list. If 0, no list used (\"All contacts\")."
      }
    },
    "required": [
      "PCID",
      "id"
    ]
  }
  ```
</Expandable>

***

## findymail\_get\_excluded\_domains

Get excluded domains

**Parameters:**

| Parameter  | Type    | Required | Default | Description                     |
| ---------- | ------- | -------- | ------- | ------------------------------- |
| `query`    | string  | No       | —       | Search query to filter domains. |
| `list_id`  | integer | No       | —       | Filter domains by list ID.      |
| `per_page` | integer | No       | —       | Number of domains per page.     |
| `page`     | integer | No       | —       | Page number.                    |

<Expandable title="inputSchema">
  ```json theme={null}
  {
    "type": "object",
    "properties": {
      "PCID": {
        "type": "string",
        "description": "Pink Connect ID for the authenticated connection"
      },
      "query": {
        "type": "string",
        "description": "Search query to filter domains."
      },
      "list_id": {
        "type": "integer",
        "description": "Filter domains by list ID."
      },
      "per_page": {
        "type": "integer",
        "description": "Number of domains per page."
      },
      "page": {
        "type": "integer",
        "description": "Page number."
      }
    },
    "required": [
      "PCID"
    ]
  }
  ```
</Expandable>

***

## findymail\_get\_exclusion\_list\_details

Get exclusion list details

**Parameters:**

| Parameter               | Type    | Required | Default | Description                       |
| ----------------------- | ------- | -------- | ------- | --------------------------------- |
| `excludedDomainList_id` | integer | Yes      | —       | The ID of the excludedDomainList. |

<Expandable title="inputSchema">
  ```json theme={null}
  {
    "type": "object",
    "properties": {
      "PCID": {
        "type": "string",
        "description": "Pink Connect ID for the authenticated connection"
      },
      "excludedDomainList_id": {
        "type": "integer",
        "description": "The ID of the excludedDomainList."
      }
    },
    "required": [
      "PCID",
      "excludedDomainList_id"
    ]
  }
  ```
</Expandable>

***

## findymail\_get\_export\_status

Get export status

**Parameters:**

| Parameter | Type   | Required | Default | Description                                      |
| --------- | ------ | -------- | ------- | ------------------------------------------------ |
| `hash`    | string | Yes      | —       | The export hash returned by the search endpoint. |

<Expandable title="inputSchema">
  ```json theme={null}
  {
    "type": "object",
    "properties": {
      "PCID": {
        "type": "string",
        "description": "Pink Connect ID for the authenticated connection"
      },
      "hash": {
        "type": "string",
        "description": "The export hash returned by the search endpoint."
      }
    },
    "required": [
      "PCID",
      "hash"
    ]
  }
  ```
</Expandable>

***

## findymail\_get\_remaining\_credits

Get remaining credits

<Expandable title="inputSchema">
  ```json theme={null}
  {
    "type": "object",
    "properties": {
      "PCID": {
        "type": "string",
        "description": "Pink Connect ID for the authenticated connection"
      }
    },
    "required": [
      "PCID"
    ]
  }
  ```
</Expandable>

***

## findymail\_get\_results

Get results

**Parameters:**

| Parameter  | Type    | Required | Default | Description                                |
| ---------- | ------- | -------- | ------- | ------------------------------------------ |
| `hash`     | string  | Yes      | —       | The hash returned by the search endpoint.  |
| `page`     | integer | No       | —       | The page number (default: 1).              |
| `per_page` | integer | No       | —       | Results per page (max: 500, default: 100). |

<Expandable title="inputSchema">
  ```json theme={null}
  {
    "type": "object",
    "properties": {
      "PCID": {
        "type": "string",
        "description": "Pink Connect ID for the authenticated connection"
      },
      "hash": {
        "type": "string",
        "description": "The hash returned by the search endpoint."
      },
      "page": {
        "type": "integer",
        "description": "The page number (default: 1)."
      },
      "per_page": {
        "type": "integer",
        "description": "Results per page (max: 500, default: 100)."
      }
    },
    "required": [
      "PCID",
      "hash"
    ]
  }
  ```
</Expandable>

***

## findymail\_get\_team\_usage

Get team usage

**Parameters:**

| Parameter | Type   | Required | Default | Description                                                                                  |
| --------- | ------ | -------- | ------- | -------------------------------------------------------------------------------------------- |
| `from`    | string | No       | —       | optional The start date (incl.) for the report (YYYY-MM-DD format). Defaults to 30 days ago. |
| `to`      | string | No       | —       | optional The end date (incl.) for the report (YYYY-MM-DD format). Defaults to today.         |

<Expandable title="inputSchema">
  ```json theme={null}
  {
    "type": "object",
    "properties": {
      "PCID": {
        "type": "string",
        "description": "Pink Connect ID for the authenticated connection"
      },
      "from": {
        "type": "string",
        "description": "optional The start date (incl.) for the report (YYYY-MM-DD format). Defaults to 30 days ago."
      },
      "to": {
        "type": "string",
        "description": "optional The end date (incl.) for the report (YYYY-MM-DD format). Defaults to today."
      }
    },
    "required": [
      "PCID"
    ]
  }
  ```
</Expandable>

***

## findymail\_get\_the\_list\_of\_contact\_lists

Get the list of contact lists

<Expandable title="inputSchema">
  ```json theme={null}
  {
    "type": "object",
    "properties": {
      "PCID": {
        "type": "string",
        "description": "Pink Connect ID for the authenticated connection"
      }
    },
    "required": [
      "PCID"
    ]
  }
  ```
</Expandable>

***

## findymail\_get\_usage

Get usage

**Parameters:**

| Parameter | Type   | Required | Default | Description                                                                                    |
| --------- | ------ | -------- | ------- | ---------------------------------------------------------------------------------------------- |
| `from`    | string | No       | —       | optional The start date (incl.) for the timeline (YYYY-MM-DD format). Defaults to 30 days ago. |
| `to`      | string | No       | —       | optional The end date (incl.) for the timeline (YYYY-MM-DD format). Defaults to today.         |

<Expandable title="inputSchema">
  ```json theme={null}
  {
    "type": "object",
    "properties": {
      "PCID": {
        "type": "string",
        "description": "Pink Connect ID for the authenticated connection"
      },
      "from": {
        "type": "string",
        "description": "optional The start date (incl.) for the timeline (YYYY-MM-DD format). Defaults to 30 days ago."
      },
      "to": {
        "type": "string",
        "description": "optional The end date (incl.) for the timeline (YYYY-MM-DD format). Defaults to today."
      }
    },
    "required": [
      "PCID"
    ]
  }
  ```
</Expandable>

***

## findymail\_list\_monitors

List monitors

<Expandable title="inputSchema">
  ```json theme={null}
  {
    "type": "object",
    "properties": {
      "PCID": {
        "type": "string",
        "description": "Pink Connect ID for the authenticated connection"
      }
    },
    "required": [
      "PCID"
    ]
  }
  ```
</Expandable>

***

## findymail\_list\_signals

List signals

**Parameters:**

| Parameter          | Type    | Required | Default | Description                                                                                                              |
| ------------------ | ------- | -------- | ------- | ------------------------------------------------------------------------------------------------------------------------ |
| `signal_type`      | string  | No       | —       | Filter by signal type. Accepted values: `keyword_mention`, `new_hire`, `job_change`, `post_engagement`.                  |
| `monitor_id`       | integer | No       | —       | Filter by a specific monitor ID (must be owned by the authenticated user).                                               |
| `date_from`        | string  | No       | —       | Filter signals detected on or after this date (format: YYYY-MM-DD).                                                      |
| `date_to`          | string  | No       | —       | Filter signals detected on or before this date (format: YYYY-MM-DD).                                                     |
| `relevance_scores` | string  | No       | —       | Comma-separated AI relevance scores to include (0-5). Optionally combine with `monitor_id` to scope to a single monitor. |
| `page`             | integer | No       | —       | The page number (default: 1).                                                                                            |
| `per_page`         | integer | No       | —       | Results per page (max: 100, default: 50).                                                                                |

<Expandable title="inputSchema">
  ```json theme={null}
  {
    "type": "object",
    "properties": {
      "PCID": {
        "type": "string",
        "description": "Pink Connect ID for the authenticated connection"
      },
      "signal_type": {
        "type": "string",
        "description": "Filter by signal type. Accepted values: `keyword_mention`, `new_hire`, `job_change`, `post_engagement`."
      },
      "monitor_id": {
        "type": "integer",
        "description": "Filter by a specific monitor ID (must be owned by the authenticated user)."
      },
      "date_from": {
        "type": "string",
        "description": "Filter signals detected on or after this date (format: YYYY-MM-DD)."
      },
      "date_to": {
        "type": "string",
        "description": "Filter signals detected on or before this date (format: YYYY-MM-DD)."
      },
      "relevance_scores": {
        "type": "string",
        "description": "Comma-separated AI relevance scores to include (0-5). Optionally combine with `monitor_id` to scope to a single monitor."
      },
      "page": {
        "type": "integer",
        "description": "The page number (default: 1)."
      },
      "per_page": {
        "type": "integer",
        "description": "Results per page (max: 100, default: 50)."
      }
    },
    "required": [
      "PCID"
    ]
  }
  ```
</Expandable>

***

## findymail\_lookup\_reverse\_email

Reverse email lookup

**Parameters:**

| Parameter      | Type    | Required | Default | Description                                                  |
| -------------- | ------- | -------- | ------- | ------------------------------------------------------------ |
| `email`        | string  | Yes      | —       | Email address to lookup                                      |
| `with_profile` | boolean | No       | —       | optional Whether to return profile metadata (default: false) |

<Expandable title="inputSchema">
  ```json theme={null}
  {
    "type": "object",
    "properties": {
      "PCID": {
        "type": "string",
        "description": "Pink Connect ID for the authenticated connection"
      },
      "email": {
        "type": "string",
        "description": "Email address to lookup"
      },
      "with_profile": {
        "type": "boolean",
        "description": "optional Whether to return profile metadata (default: false)"
      }
    },
    "required": [
      "PCID",
      "email"
    ]
  }
  ```
</Expandable>

***

## findymail\_remove\_excluded\_domains

Remove excluded domains

**Parameters:**

| Parameter | Type       | Required | Default | Description                    |
| --------- | ---------- | -------- | ------- | ------------------------------ |
| `ids`     | integer\[] | Yes      | —       | Array of domain IDs to delete. |

<Expandable title="inputSchema">
  ```json theme={null}
  {
    "type": "object",
    "properties": {
      "PCID": {
        "type": "string",
        "description": "Pink Connect ID for the authenticated connection"
      },
      "ids": {
        "type": "array",
        "items": {
          "type": "integer"
        },
        "description": "Array of domain IDs to delete."
      }
    },
    "required": [
      "PCID",
      "ids"
    ]
  }
  ```
</Expandable>

***

## findymail\_search\_leads

Search leads

**Parameters:**

| Parameter | Type    | Required | Default | Description                                                          |
| --------- | ------- | -------- | ------- | -------------------------------------------------------------------- |
| `config`  | object  | No       | —       | Export configuration (all fields are optional).                      |
| `limit`   | integer | No       | —       | The maximum number of companies to export (default: 100, max: 5000). |
| `query`   | string  | Yes      | —       | The search query describing target companies.                        |

<Expandable title="inputSchema">
  ```json theme={null}
  {
    "type": "object",
    "properties": {
      "PCID": {
        "type": "string",
        "description": "Pink Connect ID for the authenticated connection"
      },
      "config": {
        "type": "object",
        "description": "Export configuration (all fields are optional).",
        "properties": {
          "find_contact": {
            "type": "boolean",
            "description": "Whether to find contacts (default: false)."
          },
          "find_email": {
            "type": "boolean",
            "description": "Whether to enrich contacts with email. (1 credit per email found) (default: false)."
          },
          "find_phone": {
            "type": "boolean",
            "description": "Whether to enrich contacts with phone number (10 credits per phone number found) (default: false)."
          },
          "target_job_titles": {
            "type": "array",
            "items": {
              "type": "string"
            },
            "description": "Target job titles for contacts. Variations that have the same intent (eg. \"CEO\" and \"Chief Executive Officer\") are already handled. (default: [\"CEO\"])."
          },
          "lead_list_id": {
            "type": "integer",
            "description": "Lead list ID to add contacts to."
          },
          "mode": {
            "type": "string",
            "description": "Export mode: \"broad\" or \"targeted\" (default: \"broad\")."
          },
          "add_to_exclusion_list": {
            "type": "boolean",
            "description": "Add exported companies to exclusion list (default: false)."
          },
          "exclusion_list_id": {
            "type": "integer",
            "description": "Exclusion list ID where to add domains when add_to_exclusion_list is true."
          },
          "exclusion_filter_list_ids": {
            "type": "array",
            "items": {
              "type": "integer"
            },
            "description": "List of exclusion list IDs to filter results (default: [0] = global exclusion list, [-1] = no filter)."
          }
        }
      },
      "limit": {
        "type": "integer",
        "description": "The maximum number of companies to export (default: 100, max: 5000)."
      },
      "query": {
        "type": "string",
        "description": "The search query describing target companies."
      }
    },
    "required": [
      "PCID",
      "query"
    ]
  }
  ```
</Expandable>

***

## findymail\_search\_lookalike\_companies

Search lookalike companies

**Parameters:**

| Parameter            | Type       | Required | Default | Description                                                                |
| -------------------- | ---------- | -------- | ------- | -------------------------------------------------------------------------- |
| `exclusion_list_ids` | integer\[] | No       | —       | IDs of exclusion lists to filter out already-known companies.              |
| `limit`              | integer    | No       | —       | Maximum number of companies to return (default: 100, max: 10000).          |
| `same_country`       | boolean    | No       | —       | Only return companies in the same country as the seed (default: false).    |
| `same_size`          | boolean    | No       | —       | Only return companies in the same size range as the seed (default: false). |
| `seed`               | string     | Yes      | —       | The seed company domain or URL.                                            |

<Expandable title="inputSchema">
  ```json theme={null}
  {
    "type": "object",
    "properties": {
      "PCID": {
        "type": "string",
        "description": "Pink Connect ID for the authenticated connection"
      },
      "exclusion_list_ids": {
        "type": "array",
        "items": {
          "type": "integer"
        },
        "description": "IDs of exclusion lists to filter out already-known companies."
      },
      "limit": {
        "type": "integer",
        "description": "Maximum number of companies to return (default: 100, max: 10000)."
      },
      "same_country": {
        "type": "boolean",
        "description": "Only return companies in the same country as the seed (default: false)."
      },
      "same_size": {
        "type": "boolean",
        "description": "Only return companies in the same size range as the seed (default: false)."
      },
      "seed": {
        "type": "string",
        "description": "The seed company domain or URL."
      }
    },
    "required": [
      "PCID",
      "seed"
    ]
  }
  ```
</Expandable>

***

## findymail\_update\_acontact\_list

Update a contact list

**Parameters:**

| Parameter  | Type    | Required | Default | Description                               |
| ---------- | ------- | -------- | ------- | ----------------------------------------- |
| `id`       | integer | Yes      | —       | The ID of the list.                       |
| `isShared` | boolean | Yes      | —       | Enable/disable list sharing with the team |
| `name`     | string  | Yes      | —       | New name of the list                      |

<Expandable title="inputSchema">
  ```json theme={null}
  {
    "type": "object",
    "properties": {
      "PCID": {
        "type": "string",
        "description": "Pink Connect ID for the authenticated connection"
      },
      "id": {
        "type": "integer",
        "description": "The ID of the list."
      },
      "isShared": {
        "type": "boolean",
        "description": "Enable/disable list sharing with the team"
      },
      "name": {
        "type": "string",
        "description": "New name of the list"
      }
    },
    "required": [
      "PCID",
      "id",
      "isShared",
      "name"
    ]
  }
  ```
</Expandable>

***

## findymail\_update\_amonitor

Update a monitor

**Parameters:**

| Parameter          | Type      | Required | Default | Description                                                                                    |
| ------------------ | --------- | -------- | ------- | ---------------------------------------------------------------------------------------------- |
| `id`               | integer   | Yes      | —       | The ID of the monitor.                                                                         |
| `engagement_types` | string\[] | No       | —       | Engagement types to track (required for post\_engagement). Accepted values: `like`, `comment`. |
| `enrichment_level` | string    | No       | —       | Contact enrichment level. Accepted values: `email`, `email_phone`.                             |
| `icp_filters`      | object    | No       | —       | Optional ICP filter criteria.                                                                  |
| `keywords`         | string\[] | No       | —       | Keywords to track (required for keyword\_mention, nullable otherwise, max 5).                  |
| `lead_list_id`     | integer   | No       | —       | ID of a lead list to automatically add matched contacts to.                                    |
| `name`             | string    | Yes      | —       | The monitor name.                                                                              |
| `webhook_url`      | string    | No       | —       | Optional HTTPS URL to receive webhook notifications.                                           |

<Expandable title="inputSchema">
  ```json theme={null}
  {
    "type": "object",
    "properties": {
      "PCID": {
        "type": "string",
        "description": "Pink Connect ID for the authenticated connection"
      },
      "id": {
        "type": "integer",
        "description": "The ID of the monitor."
      },
      "engagement_types": {
        "type": "array",
        "items": {
          "type": "string"
        },
        "description": "Engagement types to track (required for post_engagement). Accepted values: `like`, `comment`."
      },
      "enrichment_level": {
        "type": "string",
        "description": "Contact enrichment level. Accepted values: `email`, `email_phone`."
      },
      "icp_filters": {
        "type": "object",
        "description": "Optional ICP filter criteria.",
        "properties": {
          "industries": {
            "type": "array",
            "items": {
              "type": "string"
            },
            "description": "Industries to match (LinkedIn Industry Codes V2)."
          },
          "employee_count_ranges": {
            "type": "array",
            "items": {
              "type": "string"
            },
            "description": "Accepted values: `1-10`, `11-50`, `51-200`, `201-500`, `501-1000`, `1001-5000`, `5001-10000`, `10001+`."
          },
          "countries": {
            "type": "array",
            "items": {
              "type": "string"
            },
            "description": "2-letter ISO 3166-1 alpha-2 country codes."
          },
          "job_title_keywords": {
            "type": "array",
            "items": {
              "type": "string"
            },
            "description": "Job title keywords to match (max 10)."
          },
          "seniority_levels": {
            "type": "array",
            "items": {
              "type": "integer"
            },
            "description": "Seniority levels (1=Entry, 4=IC, 6=Senior IC, 8=Management, 9=Director, 11=VP, 13=Executive, 14=C-Suite, 15=Founder)."
          }
        }
      },
      "keywords": {
        "type": "array",
        "items": {
          "type": "string"
        },
        "description": "Keywords to track (required for keyword_mention, nullable otherwise, max 5)."
      },
      "lead_list_id": {
        "type": "integer",
        "description": "ID of a lead list to automatically add matched contacts to."
      },
      "name": {
        "type": "string",
        "description": "The monitor name."
      },
      "webhook_url": {
        "type": "string",
        "description": "Optional HTTPS URL to receive webhook notifications."
      }
    },
    "required": [
      "PCID",
      "id",
      "name"
    ]
  }
  ```
</Expandable>

***

## findymail\_update\_an\_exclusion\_list

Update an exclusion list

**Parameters:**

| Parameter               | Type    | Required | Default | Description                                                      |
| ----------------------- | ------- | -------- | ------- | ---------------------------------------------------------------- |
| `excludedDomainList_id` | integer | Yes      | —       | The ID of the excludedDomainList.                                |
| `is_shared`             | boolean | No       | —       | Optional. Set to true to share with team, false to make private. |
| `name`                  | string  | Yes      | —       | The new name for the list (must be unique per user).             |

<Expandable title="inputSchema">
  ```json theme={null}
  {
    "type": "object",
    "properties": {
      "PCID": {
        "type": "string",
        "description": "Pink Connect ID for the authenticated connection"
      },
      "excludedDomainList_id": {
        "type": "integer",
        "description": "The ID of the excludedDomainList."
      },
      "is_shared": {
        "type": "boolean",
        "description": "Optional. Set to true to share with team, false to make private."
      },
      "name": {
        "type": "string",
        "description": "The new name for the list (must be unique per user)."
      }
    },
    "required": [
      "PCID",
      "excludedDomainList_id",
      "name"
    ]
  }
  ```
</Expandable>

***

## findymail\_verify\_an\_email

Verify an email

**Parameters:**

| Parameter | Type   | Required | Default | Description     |
| --------- | ------ | -------- | ------- | --------------- |
| `email`   | string | Yes      | —       | Email to verify |

<Expandable title="inputSchema">
  ```json theme={null}
  {
    "type": "object",
    "properties": {
      "PCID": {
        "type": "string",
        "description": "Pink Connect ID for the authenticated connection"
      },
      "email": {
        "type": "string",
        "description": "Email to verify"
      }
    },
    "required": [
      "PCID",
      "email"
    ]
  }
  ```
</Expandable>