Snov.io API

https://snov.io/api
Admin
Snov.io API allows developers to integrate Snov.io's sales automation features, including email...
Tokens:43,650
Snippets:143
Trust Score:10
Update:8 months ago
Show doc for...
Tokens:
Raw
### GET /v2/company-domain-by-name/result

Source: https://snov.io/api/index

Retrieves the results of a previously started company domain search task using the provided task hash.

```APIDOC
## GET /v2/company-domain-by-name/result

### Description
Retrieves the results of a previously started company domain search task using the provided task hash.

### Method
GET

### Endpoint
https://api.snov.io/v2/company-domain-by-name/result

### Parameters
#### Query Parameters
- **task_hash** (string) - Required - Unique request ID you received from the `POST /v2/company-domain-by-name/start` request.

### Request Example
```json
{
  "task_hash": "959c0f60facb8629bba746e091a26f7b"
}
```

### Response
#### Success Response (200)
- **status** (string) - Request’s status. Could either be `completed` or `in_progress`.
- **data** (array of objects) - An array containing the search results for each company.
  - **name** (string) - Company name for which you requested a domain address.
  - **result.domain** (string) - Company's domain.
- **meta.names** (array of strings) - An array of company names you provided.
- **meta.task_hash** (string) - Unique ID for this search task.

#### Response Example
```json
{
  "status": "completed",
  "data": [
    {
      "name": "Snov.io",
      "result": {
        "domain": "snov.io"
      }
    },
    {
      "name": "Sendpulse",
      "result": {
        "domain": "sendpulse.com"
      }
    }
  ],
  "meta": {
    "names": [
      "Snov.io",
      "Sendpulse"
    ],
    "task_hash": "959c0f60facb8629bba746e091a26f7b"
  }
}
```
```

--------------------------------

### Get Domain Search Results - PHP

Source: https://snov.io/api/index

Retrieves the results of a previously started domain search using the Snov.io API. Requires the task hash obtained from the 'start' endpoint. Returns detailed company information.

```PHP
<?php
function companyInfoResult()
{
    $token = getAccessToken();

    $task_hash = 'b10e4c47693dbf87cc8de16edcc8ae22';
    $headers = [
        'Authorization: Bearer ' . $token,
    ];

    $options = [
        CURLOPT_URL            => 'https://api.snov.io/v2/domain-search/result/$task_hash',
        CURLOPT_HTTPHEADER     => $headers,
        CURLOPT_RETURNTRANSFER => true,
        CURLOPT_FOLLOWLOCATION => true
    ];

    $ch = curl_init();

    curl_setopt_array($ch, $options);

    $response = json_decode(curl_exec($ch), true);

    curl_close($ch);

    return $response;
}
?>
```

--------------------------------

### POST /v2/domain-search/generic-contacts/start

Source: https://snov.io/api/index

Initiates a search for generic contact emails for a given company domain. This endpoint starts an asynchronous task.

```APIDOC
## POST /v2/domain-search/generic-contacts/start

### Description
Initiates a search for generic contact emails for a given company domain. This endpoint starts an asynchronous task.

### Method
POST

### Endpoint
https://api.snov.io/v2/domain-search/generic-contacts/start

### Parameters
#### Query Parameters
- **domain** (string) - Required - The company's domain name for which you want to find generic emails (e.g., "snov.io").

### Request Body
This endpoint does not use a request body. Parameters are sent as query parameters.

### Request Example
```json
{
  "domain": "snov.io"
}
```

### Response
#### Success Response (200)
This endpoint initiates a task and returns a task hash to retrieve results later. The exact response structure for the start endpoint is similar to the domain emails start endpoint, containing `meta` and `links` objects, including a `task_hash`.

#### Response Example
```json
{
  "data": [],
  "meta": {
    "domain": "snov.io",
    "tab": "service",
    "task_hash": "a1b2c3d4e5f678901234567890abcdef",
    "next": ""
  },
  "links": {
    "result": "https://api.snov.io/v2/domain-search/generic-contacts/result/a1b2c3d4e5f678901234567890abcdef"
  }
}
```
```

--------------------------------

### GET /v1/get-emails-replies

Source: https://snov.io/api/index

Retrieves campaign replies, including prospect details. Supports pagination with offset.

```APIDOC
## GET /v1/get-emails-replies

### Description
This method returns the campaign replies with all the information, including the prospect’s name, ID, campaign, etc.

### Method
GET

### Endpoint
https://api.snov.io/v1/get-emails-replies

### Parameters
#### Query Parameters
- **access_token** (string) - Required - Your API access token.
- **campaignId** (integer) - Required - Unique identifier of the campaign you want to view replies from.
- **offset** (integer) - Optional - Skips a specified number of previous replies. Useful for paginating through large reply sets.

### Request Example
```json
{
  "access_token": "YOUR_ACCESS_TOKEN",
  "campaignId": 1234567,
  "offset": 10000
}
```

### Response
#### Success Response (200)
- **campaignId** (integer) - Campaign's unique identifier.
- **campaign** (string) - Campaign name.
- **prospectName** (string) - Prospect's full name.
- **emailSubject** (string) - Subject line of the email that received a reply.
- **emailBody** (string) - Contents of the email that received a reply.
- **visitedAt** (object) - Timestamp when the prospect was visited.
- **prospectId** (string) - Prospect's unique identifier.
- **sourcePage** (string) - Source page of the prospect.
- **source** (string) - Source of the prospect.
- **locality** (string) - Locality of the prospect.
- **industry** (string) - Industry of the prospect.
- **country** (string) - Country of the prospect.
- **prospectEmail** (string) - Prospect's email address.
- **hash** (string) - Hash value.
- **skills** (string) - Skills of the prospect.
- **links** (string) - Links associated with the prospect.
- **customFields** (object) - Custom fields for the prospect.
- **id** (string) - Unique identifier for the reply.
- **customField_Phone** (string) - Custom field for phone.
- **customField_Birthday** (string) - Custom field for birthday.

#### Response Example
```json
[
    {
        "visitedAt": {
            "date": "2020-07-14 13:10:46.000000",
            "timezone_type": 3,
            "timezone": "UTC"
        },
        "campaignId": 1234567,
        "campaign": "My top campaign",
        "prospectId": "7a941739b09f1187532d52a684df545f3a223e432c7f53662264db8d33db80ee5fc19e573416a",
        "prospectFirstName": "John",
        "prospectLastName": "Doe",
        "prospectName": "John Doe",
        "sourcePage": null,
        "source": "copy",
        "locality": null,
        "industry": "Airlines/Aviation",
        "country": null,
        "prospectEmail": "Johndoe@snov.io",
        "hash": "6745f8162ecadbe325693345d1a53976",
        "emailSubject": "\"Special content for you\"",
        "emailBody": "<\p>Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua.</p>",
        "skills": "",
        "links": null,
        "customFields": null,
        "id": "f676edc5de58f341dc7bf4e75c0c8580",
        "customField_Phone": "",
        "customField_Birthday": ""
    }
]
```
```

--------------------------------

### POST /v2/domain-search/generic-contacts/start

Source: https://snov.io/api/index

Initiates a search for generic contacts associated with a specific domain. This endpoint starts a task that can be later queried for results.

```APIDOC
## POST /v2/domain-search/generic-contacts/start

### Description
Initiates a search for generic contacts associated with a specific domain. This endpoint starts a task that can be later queried for results.

### Method
POST

### Endpoint
https://api.snov.io/v2/domain-search/generic-contacts/start

### Parameters
#### Query Parameters
- **domain** (string) - Required - The domain for which you're retrieving generic emails.
- **tab** (string) - Optional - Specifies the type of results requested. Options: 'prospects', 'emails', 'service'. Defaults to 'service'.

### Request Example
```json
{
  "domain": "snov.io"
}
```

### Response
#### Success Response (200)
- **data** (array) - An empty array initially.
- **meta** (object) - Contains metadata about the search task.
  - **domain** (string) - The domain searched.
  - **tab** (string) - The type of results requested.
  - **task_hash** (string) - A unique ID for the search task.
  - **next** (string) - An empty string initially, used for pagination.
- **links** (object) - Contains links for further actions.
  - **result** (string) - The URL to use to retrieve the search results using the task_hash.

#### Response Example
```json
{
  "data": [],
  "meta": {
    "domain": "snov.io",
    "tab": "service",
    "task_hash": "0e36e43b9b91a9b20d14b82c1ee141f2",
    "next": ""
  },
  "links": {
    "result": "https://api.snov.io/v2/domain-search/generic-contacts/result/0e36e43b9b91a9b20d14b82c1ee141f2"
  }
}
```
```

--------------------------------

### GET /v1/get-user-lists

Source: https://snov.io/api/index

Retrieves all lists created by the user. This method can be used to review lists for email drip campaigns.

```APIDOC
## GET /v1/get-user-lists

### Description
This method returns all lists created by the user. You can use this method to review lists that can be used for an email drip campaign.

### Method
GET

### Endpoint
https://api.snov.io/v1/get-user-lists

### Parameters
#### Query Parameters
- **access_token** (string) - Required - Your API access token.

### Request Example
```
GET https://api.snov.io/v1/get-user-lists?access_token=YOUR_ACCESS_TOKEN
```

### Response
#### Success Response (200)
- **id** (integer) - User’s list unique identifier.
- **name** (string) - List name.
- **contacts** (integer) - The number of prospects in the list.
- **isDeleted** (boolean) - List’s status. Is true if the list has been deleted.
- **creationDate** (object) - The date and time of list creation (includes date, time, and time zone info).
- **deletionDate** (object|null) - If the list has been deleted, contains the date and time of list deletion (includes date, time, and time zone info).

#### Response Example
```json
[
    {
        "id": 1818597,
        "name": "FirstSend",
        "contacts": 1,
        "isDeleted": false,
        "creationDate": {
            "date": "2020-04-07 08:25:44.000000",
            "timezone_type": 3,
            "timezone": "UTC"
        },
        "deletionDate": null
    },
    {
        "id": 1505383,
        "name": "All prospects",
        "contacts": 10,
        "isDeleted": true,
        "creationDate": {
            "date": "2019-12-17 15:07:30.000000",
            "timezone_type": 3,
            "timezone": "UTC"
        },
        "deletionDate": {
            "date": "2020-02-17 14:05:44.000000",
            "timezone_type": 3,
            "timezone": "UTC"
        }
    }
]
```
```

--------------------------------

### GET /v2/emails-by-domain-by-name/result

Source: https://snov.io/api/index

Retrieves the results of an email search task initiated by the /start endpoint.

```APIDOC
## GET /v2/emails-by-domain-by-name/result

### Description
Retrieves the results of an email search task initiated by the /start endpoint.

### Method
GET

### Endpoint
https://api.snov.io/v2/emails-by-domain-by-name/result

### Parameters
#### Query Parameters
- **task_hash** (string) - Required - Unique request ID received from the previous request.

### Response
#### Success Response (200)
- **status** (string) - The status of the task (e.g., "completed").
- **data** (array of objects)
  - **people** (string) - The name of the person.
  - **result** (array of objects) - An array of found email addresses and their details.
    - **email** (string) - The found email address.
    - **smtp_status** (string) - The SMTP verification status (e.g., "valid", "unknown").
    - **is_valid_format** (boolean) - Indicates if the email format is valid.
    - **is_disposable** (boolean) - Indicates if the email is from a disposable email provider.
    - **is_webmail** (boolean) - Indicates if the email is from a webmail provider.
    - **is_gibberish** (boolean) - Indicates if the email appears to be gibberish.

#### Response Example
```json
{
  "status": "completed",
  "data": [
    {
      "people": "John Doe",
      "result": [
        {
          "email": "john.doe@yourdomain.com",
          "smtp_status": "valid",
          "is_valid_format": true,
          "is_disposable": false,
          "is_webmail": false,
          "is_gibberish": false
        }
      ]
    },
    {
      "people": "Jane Doe",
      "result": [
        {
          "email": "jane.doe@yourdomain.com",
          "smtp_status": "unknown",
          "is_valid_format": true,
          "is_disposable": false,
          "is_webmail": false,
          "is_gibberish": false
        }
      ]
    }
  ]
}
```
```

--------------------------------

### Get All User Campaigns (PHP)

Source: https://snov.io/api/index

Retrieves a list of all campaigns created by the user, including those from their team if permissions allow. Requires an access token.

```php
<?php
function userCampaigns()
{
    $token = getAccessToken();

    $params = [
        'access_token' => $token
    ];

    $params = http_build_query($params);

    $options = [
        CURLOPT_URL            => 'https://api.snov.io/v1/get-user-campaigns?'.$params,
        CURLOPT_RETURNTRANSFER => true,
        CURLOPT_FOLLOWLOCATION => true,
    ];

    $ch = curl_init();

    curl_setopt_array($ch, $options);

    $res = json_decode(curl_exec($ch), true);

    curl_close($ch);

    return $res;

}
?>
```

--------------------------------

### Get All User Campaigns (Python)

Source: https://snov.io/api/index

Retrieves a list of all campaigns created by the user, including those from their team if permissions allow. Requires an access token, which is passed in the Authorization header.

```python
def user_lists():
token = get_access_token()

headers = {'Authorization': token}

url = 'https://api.snov.io/v1/get-user-campaigns'

response = requests.request('GET', url, headers=headers)

return json.loads(res.text)
```

--------------------------------

### Get Completed Prospects (PHP, Python)

Source: https://snov.io/api/index

Retrieves a list of prospects for whom a campaign has been completed. Requires an access token and a campaign ID. Returns an array of prospect objects.

```php
<?php
function finishedProspects()
{
    $token = getAccessToken();

    $params = [
        'access_token' => $token,
        'campaignId'   => 1234567
    ];

    $params = http_build_query($params);

    $options = [
        CURLOPT_URL            => 'https://api.snov.io/v1/prospect-finished?'.$params,
        CURLOPT_RETURNTRANSFER => true,
        CURLOPT_FOLLOWLOCATION => true,
    ];

    $ch = curl_init();

    curl_setopt_array($ch, $options);

    $res = json_decode(curl_exec($ch), true);

    curl_close($ch);

    return $res;

}
?>
```

```python
def user_lists():
token = get_access_token()
params = {'access_token':token,
        'campaignId':1234567
}

res = requests.get('https://api.snov.io/v1/prospect-finished', data=params)

return json.loads(res.text)
```

--------------------------------

### GET /v2/domain-search/result/{task_hash}

Source: https://snov.io/api/index

Retrieves the results of a previously initiated domain search using the provided task hash. This endpoint is used to get the company information after starting the search.

```APIDOC
## GET /v2/domain-search/result/{task_hash}

### Description
Retrieves the results of a previously initiated domain search using the provided task hash. This endpoint is used to get the company information after starting the search.

### Method
GET

### Endpoint
https://api.snov.io/v2/domain-search/result/{task_hash}

### Parameters
#### Path Parameters
- **task_hash** (string) - Required - The unique ID for the search task obtained from the `/v2/domain-search/start` endpoint.

### Response
#### Success Response (200)
- **data** (object) - Contains detailed company information.
  - **company_name** (string) - The company name associated with the domain.
  - **city** (string) - The city in which the company's headquarters are located.
  - **founded** (string) - The year when the company was founded.
  - **website** (string) - Company's website address.
  - **hq_phone** (string) - The phone number of the company's headquarters.
  - **industry** (string) - Company's industry.
  - **size** (string) - The number of employees the company has.
  - **related_domains** (array) - Domains with the same SLD as the requested domain.
- **meta** (object) - Contains metadata about the search.
  - **domain** (string) - The domain name for which the API has provided the company information.
  - **task_hash** (string) - Unique ID for the search task.
  - **prospects_count** (integer) - The number of prospect profiles retrieved.
  - **emails_count** (integer) - The number of domain emails retrieved.
  - **generic_contacts_count** (integer) - The number of generic emails retrieved.
- **links** (object) - Contains links for further actions.
  - **prospects** (string) - URL to start searching for prospects.
  - **domain_emails** (string) - URL to start searching for domain emails.
  - **generic_contacts** (string) - URL to start searching for generic contacts.
- **status** (string) - The status of the search task (e.g., "completed").

#### Response Example
```json
{
  "data": {
    "company_name": "Snov.io",
    "city": "New York",
    "founded": "2017",
    "website": "snov.io",
    "hq_phone": "13477050819",
    "industry": "Computer Software",
    "size": "51-200",
    "related_domains": [
      "snov.me",
      "snov.com",
      "snov.nl",
      "snov.com.ua",
      "snov.cl"
    ]
  },
  "meta": {
    "domain": "snov.io",
    "task_hash": "6f15de14db954c761f8e7507547b3bd7",
    "prospects_count": 196,
    "emails_count": 108,
    "generic_contacts_count": 9
  },
  "links": {
    "prospects": "https://api.snov.io/v2/domain-search/prospects/start?domain=snov.io",
    "domain_emails": "https://api.snov.io/v2/domain-search/domain-emails/start?domain=snov.io",
    "generic_contacts": "https://api.snov.io/v2/domain-search/generic-contacts/start?domain=snov.io"
  },
  "status": "completed"
}
```
```

--------------------------------

### POST /v2/domain-search/start

Source: https://snov.io/api/index

Initiates a domain search to retrieve company information, emails, and prospect profiles. This endpoint costs 1 credit per unique request and 1 credit for every prospect profile with an email.

```APIDOC
## POST /v2/domain-search/start

### Description
Initiates a domain search to retrieve company information, emails, and prospect profiles. This endpoint costs 1 credit per unique request and 1 credit for every prospect profile with an email.

### Method
POST

### Endpoint
https://api.snov.io/v2/domain-search/start

### Parameters
#### Query Parameters
- **domain** (string) - Required - The domain name for which you want to receive company information. For example, "snov.io".

### Request Example
```json
{
  "domain": "snov.io"
}
```

### Response
#### Success Response (200)
- **data** (array) - An empty array, as results are retrieved via a separate endpoint.
- **meta** (object) - Contains metadata about the search task.
  - **domain** (string) - The domain name searched.
  - **task_hash** (string) - Unique ID for the search task.
- **links** (object) - Contains links for retrieving results.
  - **result** (string) - URL to retrieve the search results.

#### Response Example
```json
{
  "data": [],
  "meta": {
    "domain": "snov.io",
    "task_hash": "6f15de14db954c761f8e7507547b3bd7"
  },
  "links": {
    "result": "https://api.snov.io/v2/domain-search/result/6f15de14db954c761f8e7507547b3bd7"
  }
}
```
```

--------------------------------

### POST /v2/domain-search/prospects/start

Source: https://snov.io/api/index

Initiates a search for prospect profiles associated with a given domain. This endpoint allows filtering by job positions and pagination.

```APIDOC
## POST /v2/domain-search/prospects/start

### Description
Initiates a search for prospect profiles associated with a given domain. This endpoint allows filtering by job positions and pagination.

### Method
POST

### Endpoint
https://api.snov.io/v2/domain-search/prospects/start

### Parameters
#### Query Parameters
- **domain** (string) - Required - The domain name you want to find prospect profiles for. For example, "snov.io".
- **positions[]** (array of strings) - Optional - Use this parameter to filter prospects by job position, for example, "Software Developer". To filter by multiple positions, input an array of necessary positions. You can filter by up to 10 positions per request.
- **page** (integer) - Optional - Page number that contains prospect profiles. Each page shows up to 20 profiles. If the page is not indicated, the first page will be returned by default.

### Request Example
```json
{
  "domain": "snov.io",
  "page": 1,
  "positions": ["Web developer", "QA Engineer"]
}
```

### Response
#### Success Response (200)
- **data** (array) - Contains the list of prospect profiles found.
- **meta** (object) - Contains metadata about the search request, including domain, tab, task_hash, page, and positions.
- **links** (object) - Contains a link to retrieve the full results using the task_hash.

#### Response Example
```json
{
  "data": [],
  "meta": {
    "domain": "snov.io",
    "tab": "prospects",
    "task_hash": "3384369c16aad810f58609a40ad65089",
    "page": 1,
    "positions": [
      "Web developer",
      "QA Engineer"
    ]
  },
  "links": {
    "result": "https://api.snov.io/v2/domain-search/prospects/result/3384369c16aad810f58609a40ad65089"
  }
}
```
```

--------------------------------

### Get Domain Search Results - Python

Source: https://snov.io/api/index

Retrieves the results of a previously started domain search using the Snov.io API. Requires the task hash obtained from the 'start' endpoint. Returns detailed company information.

```Python
import requests
import json

def company_info_result():
    token = get_access_token()
    task_hash = '86586db9ac64ae5471eb18fc71b0dd5e'
    headers = {'authorization': f'Bearer {token}'}

    res = requests.get(f'https://api.snov.io/v2/domain-search/result/{task_hash}', headers=headers)

    return json.loads(res.text)
```

--------------------------------

### Start Domain Search - PHP

Source: https://snov.io/api/index

Initiates a domain search using the Snov.io API to retrieve company information, emails, and prospect profiles. Requires an access token and the domain name as input. Returns a task hash to retrieve results later.

```PHP
<?php
function companyInfoSearch()
{
    $token = getAccessToken();

    $params = [
        'domain' => 'snov.io',
    ];
    $headers = [
        'Authorization: Bearer ' . $token,
    ];

    $options = [
        CURLOPT_URL            => 'https://api.snov.io/v2/domain-search/start',
        CURLOPT_HTTPHEADER     => $headers,
        CURLOPT_RETURNTRANSFER => true,
        CURLOPT_POST           => true,
        CURLOPT_POSTFIELDS     => $params,
        CURLOPT_FOLLOWLOCATION => true
    ];

    $ch = curl_init();

    curl_setopt_array($ch, $options);

    $response = json_decode(curl_exec($ch), true);

    curl_close($ch);

    return $response;
}
?>
```

--------------------------------

### Start Domain Search - Python

Source: https://snov.io/api/index

Initiates a domain search using the Snov.io API to retrieve company information, emails, and prospect profiles. Requires an access token and the domain name as input. Returns a task hash to retrieve results later.

```Python
import requests
import json

def company_info_search():
    token = get_access_token()
    headers = {'authorization': f'Bearer {token}'}
    params = {
      'domain': 'snov.io',
    }

    res = requests.post('https://api.snov.io/v2/domain-search/start', params=params, headers=headers)

    return json.loads(res.text)
```

--------------------------------

### Start Prospect Email Search (PHP)

Source: https://snov.io/api/index

Initiates a search for a prospect's email address using the Snov.io API. Requires an access token and a task hash. Returns a response containing metadata and links for further actions.

```php
<?php
function searchProspectEmailsStart()
{
    $token = getAccessToken();

    $headers = [
        'Authorization: Bearer ' . $token,
    ];
    $task = '41627edbfff8ba9c0819a1aa51d232baf3fa1763e5813dc86e027ccbbefd7a16b0522391086776b8764c94d02bab1257df392';

    $options = [
        CURLOPT_URL            => 'https://api.snov.io/v2/domain-search/prospects/search-emails/start/$task',
        CURLOPT_HTTPHEADER     => $headers,
        CURLOPT_RETURNTRANSFER => true,
        CURLOPT_POST           => true,
        CURLOPT_FOLLOWLOCATION => true
    ];

    $ch = curl_init();

    curl_setopt_array($ch, $options);

    $response = json_decode(curl_exec($ch), true);

    curl_close($ch);

    return $response;
}
?>
```

--------------------------------

### GET /v2/domain-search/prospects/result/{task_hash}

Source: https://snov.io/api/index

Retrieves the prospect profiles for a previously initiated search task. Requires the task_hash obtained from the start endpoint.

```APIDOC
## GET /v2/domain-search/prospects/result/{task_hash}

### Description
Retrieves the prospect profiles for a previously initiated search task. Requires the task_hash obtained from the start endpoint.

### Method
GET

### Endpoint
https://api.snov.io/v2/domain-search/prospects/result/{task_hash}

### Parameters
#### Path Parameters
- **task_hash** (string) - Required - The unique ID for the search task you started.

#### Query Parameters
- **page** (integer) - Optional - Page number that contains prospect profiles. Each page shows up to 20 profiles. If the page is not indicated, the first page will be returned by default.

### Response
#### Success Response (200)
- **data** (array) - List of prospect profiles, each containing first_name, last_name, position, source_page, and search_emails_start.
- **meta** (object) - Metadata about the search, including domain, tab, task_hash, page, positions, and total_count.
- **links** (object) - Contains a link to the next page of results, if available.
- **status** (string) - The status of the search task (e.g., "completed").

#### Response Example
```json
{
  "data": [
    {
      "first_name": "John",
      "last_name": "Doe",
      "position": "Web developer",
      "source_page": "https://www.linkedin.com/in/john-doe/",
      "search_emails_start": "https://api.snov.io/v2/domain-search/prospects/search-emails/start/41627edbfff8ba9c0819a1aa51d232baf3fa1763e5813dc86e027ccbbefd7a16b0522391086776b8764c94d02bab1257df392"
    }
  ],
  "meta": {
    "domain": "snov.io",
    "tab": "prospects",
    "task_hash": "3384369c16aad810f58609a40ad65089",
    "page": 1,
    "positions": [
      "Web developer",
      "QA Engineer"
    ],
    "total_count": 18
  },
  "links": {
    "next": ""
  },
  "status": "completed"
}
```
```

--------------------------------

### Start Prospect Email Search (Python)

Source: https://snov.io/api/index

Initiates a search for a prospect's email address using the Snov.io API. Requires an access token and a task hash. Returns a response containing metadata and links for further actions.

```python
def search_prospect_emails_start():
 token = get_access_token()
 headers = {'authorization': f'Bearer {token}'}

 res = requests.post(f'https://api.snov.io/v2/domain-search/prospects/search-emails/start/'
  f'a811d72df2e52bd447621c4a1326e540102f3b70ba39a81bd597020ed0b9f812ee8de7e0f4ecad312716d03576fdf0af6d8277e1', headers=headers)

 return json.loads(res.text)
```

--------------------------------

### GET /v2/domain-search/generic-contacts/result/{task_hash}

Source: https://snov.io/api/index

Retrieves the results of a previously started generic contact search task. You can paginate through results using the 'next' parameter.

```APIDOC
## GET /v2/domain-search/generic-contacts/result/{task_hash}

### Description
Retrieves the results of a previously started generic contact search task. You can paginate through results using the 'next' parameter.

### Method
GET

### Endpoint
https://api.snov.io/v2/domain-search/generic-contacts/result/{task_hash}

### Parameters
#### Path Parameters
- **task_hash** (string) - Required - The unique ID for the search task obtained from the start endpoint.

#### Query Parameters
- **next** (string) - Optional - ID for the next page request, if available. If no more pages are available, it will be empty.

### Request Example
```json
{
  "task_hash": "0e36e43b9b91a9b20d14b82c1ee141f2"
}
```

### Response
#### Success Response (200)
- **data** (array) - A list of generic email addresses found. Each object contains an 'email' field.
  - **email** (string) - The generic contact's email address (unverified).
- **meta** (object) - Contains metadata about the search results.
  - **domain** (string) - The domain searched.
  - **tab** (string) - The type of results returned.
  - **task_hash** (string) - The unique ID for the search task.
  - **next** (string) - An ID for the next page request, if available.
  - **total_count** (integer) - The total number of generic emails found for the domain.
- **links** (object) - Contains links for further actions.
  - **next** (string) - The URL to retrieve results from the next page.
- **status** (string) - The status of the request. Can be 'completed' or 'in progress'.

#### Response Example
```json
{
  "data": [
    {
      "email": "orders@snov.io"
    },
    {
      "email": "sales@snov.io"
    }
  ],
  "meta": {
    "domain": "snov.io",
    "tab": "service",
    "task_hash": "0e36e43b9b91a9b20d14b82c1ee141f2",
    "next": "",
    "total_count": 9
  },
  "links": {
    "next": ""
  },
  "status": "completed"
}
```
```

--------------------------------

### Get Generic Contacts Result (PHP, Python)

Source: https://snov.io/api/index

Retrieves the results of a previously started generic contact search using the task hash. The response contains a list of generic email addresses found for the domain.

```php
<?php
function genericContactsResult()
{
    $token = getAccessToken();

    $task_hash = '0e36e43b9b91a9b20d14b82c1ee141f2';
    $headers = [
        'Authorization: Bearer ' . $token,
    ];

    $options = [
        CURLOPT_URL            => 'https://api.snov.io/v2/domain-search/generic-contacts/result/$task_hash',
        CURLOPT_HTTPHEADER     => $headers,
        CURLOPT_RETURNTRANSFER => true,
        CURLOPT_FOLLOWLOCATION => true
    ];

    $ch = curl_init();

    curl_setopt_array($ch, $options);

    $response = json_decode(curl_exec($ch), true);

    curl_close($ch);

    return $response;
}
?>
```

```python
import requests
import json

def generic_contacts_result():
    token = get_access_token()
    task_hash = '0e36e43b9b91a9b20d14b82c1ee141f2'
    headers = {'authorization': f'Bearer {token}'}

    res = requests.get(f'https://api.snov.io/v2/domain-search/generic-contacts/result/{task_hash}', headers=headers)

    return json.loads(res.text)
```

--------------------------------

### POST /v2/emails-by-domain-by-name/start

Source: https://snov.io/api/index

Initiates a search for email addresses based on provided names and a company domain. This endpoint costs 1 credit per email with a valid or unknown status.

```APIDOC
## POST /v2/emails-by-domain-by-name/start

### Description
Initiates a search for email addresses based on provided names and a company domain. This endpoint costs 1 credit per email with a valid or unknown status.

### Method
POST

### Endpoint
https://api.snov.io/v2/emails-by-domain-by-name/start

### Parameters
#### Request Body
- **rows** (array of objects) - Required - An array of objects containing prospect details.
  - **first_name** (string) - Required - Prospect's first name.
  - **last_name** (string) - Required - Prospect's last name.
  - **domain** (string) - Required - The domain of the company the prospect works for.
- **webhook_url** (string) - Optional - Your webhook URL to receive results instantly.

### Request Example
```json
{
  "rows": [
    {
      "first_name": "John",
      "last_name": "Doe",
      "domain": "yourdomain.com"
    },
    {
      "first_name": "Jane",
      "last_name": "Doe",
      "domain": "yourdomain.com"
    }
  ],
  "webhook_url": "https://hooks.yourdomain.com"
}
```

### Response
#### Success Response (200)
- **data** (object)
  - **task_hash** (string) - Unique ID for the search task.
- **meta** (object)
  - **rows** (array of objects) - Details of the submitted rows.

#### Response Example
```json
{
  "data": {
    "task_hash": "005ffad65aad581943cf65a45112ca7a"
  },
  "meta": {
    "rows": [
      {
        "first_name": "John",
        "last_name": "Doe",
        "domain": "yourdomain.com"
      },
      {
        "first_name": "Jane",
        "last_name": "Doe",
        "domain": "yourdomain.com"
      }
    ]
  }
}
```
```

--------------------------------

### Start Prospect Search - PHP

Source: https://snov.io/api/index

Initiates a search for prospect profiles for a given domain. It requires an access token and allows filtering by job positions and page number. The function uses cURL to send a POST request to the Snov.io API.

```php
<?php
function prospectsSearch()
{
    $token = getAccessToken();

    $params = [
        'domain'       => 'snov.io',
        'page'         => 1,
        'positions'    => ['Web developer','QA Engineer']
    ];

    $headers = [
        'Authorization: Bearer ' . $token,
    ];

    $options = [
        CURLOPT_URL            => 'https://api.snov.io/v2/domain-search/start',
        CURLOPT_HTTPHEADER     => $headers,
        CURLOPT_RETURNTRANSFER => true,
        CURLOPT_POST           => true,
        CURLOPT_POSTFIELDS     => http_build_query($params),
        CURLOPT_FOLLOWLOCATION => true
    ];

    $ch = curl_init();

    curl_setopt_array($ch, $options);

    $response = json_decode(curl_exec($ch), true);

    curl_close($ch);

    return $response;
}
?>
```

--------------------------------

### Retrieve Prospect Search Results - PHP

Source: https://snov.io/api/index

Retrieves the results of a previously started prospect search using a task hash. It requires an access token and the task hash obtained from the initial search request. The function uses cURL to send a GET request to the Snov.io API.

```php
<?php
function prospectsResult()
{
    $token = getAccessToken();

    $task_hash = '3384369c16aad810f58609a40ad65089';
    $headers = [
        'Authorization: Bearer ' . $token,
    ];

    $options = [
        CURLOPT_URL            => 'https://api.snov.io/v2/domain-search/prospects/result/$task_hash',
        CURLOPT_HTTPHEADER     => $headers,
        CURLOPT_RETURNTRANSFER => true,
        CURLOPT_FOLLOWLOCATION => true
    ];

    $ch = curl_init();

    curl_setopt_array($ch, $options);

    $response = json_decode(curl_exec($ch), true);

    curl_close($ch);

    return $response;
}
?>
```

--------------------------------

### Retrieve Prospect Search Results - Python

Source: https://snov.io/api/index

Retrieves the results of a previously started prospect search using a task hash. It requires an access token and the task hash obtained from the initial search request. The function uses the requests library to send a GET request to the Snov.io API.

```python
def prospects_result():
token = get_access_token()
task_hash = '3384369c16aad810f58609a40ad65089'
headers = {'authorization': f'Bearer {token}'}

res = requests.get(f'https://api.snov.io/v2/domain-search/prospects/result/{task_hash}', headers=headers)

return json.loads(res.text)
```

--------------------------------

### Start Prospect Search - Python

Source: https://snov.io/api/index

Initiates a search for prospect profiles for a given domain using the requests library. It requires an access token and allows filtering by job positions and page number. The function sends a POST request to the Snov.io API.

```python
def prospects_search():
token = get_access_token()
headers = {'authorization': f'Bearer {token}'}
params = {
  'domain': 'snov.io',
  'page': 1,
  'positions[]': ['Web developer', 'QA Engineer']
}

res = requests.post('https://api.snov.io/v2/domain-search/prospects/start', params=params, headers=headers)

return json.loads(res.text)
```

--------------------------------

### Get LinkedIn Profile Retrieval Results by Task Hash (PHP, Python)

Source: https://snov.io/api/index

Retrieves the LinkedIn profile information for a previously initiated task using its unique task hash. This endpoint is used to fetch the actual profile data after the task has been processed. Requires the task_hash obtained from the start endpoint.

```php
<?php
function linkedInProfilesByUrlsResult()
{
    $token = getAccessToken();

    $task_hash = 'ef005a4f6d82e7e88384de7c72ee198d';

    $headers = [
        'Authorization: Bearer ' . $token,
    ];

    $options = [
        CURLOPT_URL            => 'https://api.snov.io/v2/li-profiles-by-urls/result?task_hash=$task_hash',
        CURLOPT_HTTPHEADER     => $headers,
        CURLOPT_RETURNTRANSFER => true,
        CURLOPT_FOLLOWLOCATION => true
    ];

    $ch = curl_init();

    curl_setopt_array($ch, $options);

    $response = json_decode(curl_exec($ch), true);

    curl_close($ch);

    return $response;
}
?>

```

```python
import requests
import json

def linkedin_profiles_by_urls_result():
    token = get_access_token()
    task_hash = '879788bd889b0b9aa447278ce184e2ad'
    headers = {'authorization': f'Bearer {token}'}
    params = {
      'task_hash': task_hash
    }

    res = requests.get(f'https://api.snov.io/v2/li-profiles-by-urls/result', params=params, headers=headers)

    return json.loads(res.text)

```

--------------------------------

### Start Email Verification (PHP, Python)

Source: https://snov.io/api/index

Initiates an email verification task for a list of email addresses. Supports up to 10 emails per request and can optionally use a webhook URL for instant results. Requires an access token for authentication.

```php
<?php
function emailVerificationStart()
{
    $token = getAccessToken();

    $params = [
        'emails'    => ['gavin.vanrooyen@octagon.com','lizi.hamer@octagon.com','admin@snov.io','test@snov.io','ivalid_format_snov.io'],
        'webhook_url'         => 'https://hooks.yourdomain.com',
    ];

    $headers = [
        'Authorization: Bearer ' . $token,
    ];

    $options = [
        CURLOPT_URL            => 'https://api.snov.io/v2/email-verification/start',
        CURLOPT_HTTPHEADER     => $headers,
        CURLOPT_RETURNTRANSFER => true,
        CURLOPT_POST           => true,
        CURLOPT_POSTFIELDS     => http_build_query($params),
        CURLOPT_FOLLOWLOCATION => true
    ];

    $ch = curl_init();

    curl_setopt_array($ch, $options);

    $response = json_decode(curl_exec($ch), true);

    curl_close($ch);

    return $response;
}
?>

```

```python
import requests
import json

def email_verification_start():
    token = get_access_token()
    headers = {'authorization': f'Bearer {token}'}
    params = {
      'emails[]': ['gavin.vanrooyen@octagon.com', 'lizi.hamer@octagon.com', 'admin@snov.io', 'test@snov.io', 'ivalid_format_snov.io'],
      'webhook_url': 'https://hooks.yourdomain.com',
    }
    res = requests.post('https://api.snov.io/v2/email-verification/start', params=params, headers=headers)

    return json.loads(res.text)

```

--------------------------------

### POST /v1/lists

Source: https://snov.io/api/index

Creates a new prospect list within the user's account.

```APIDOC
## POST /v1/lists

### Description
Creates a new prospect list within the user's account.

### Method
POST

### Endpoint
https://api.snov.io/v1/lists

### Parameters
#### Query Parameters
- **access_token** (string) - Required - The API access token.
- **name** (string) - Required - The name of the new prospect list.

### Request Example
```json
{
  "access_token": "YOUR_ACCESS_TOKEN",
  "name": "New list"
}
```

### Response
#### Success Response (200)
- **success** (boolean) - Indicates if the request was successful.
- **data** (object) - Contains information about the created list.
  - **id** (integer) - The ID of the newly created prospect list.

#### Response Example
```json
[
  {
    "success": true,
    "data": {
      "id": 1234567
    }
  }
]
```
```
Tokens:
Raw