Evaboot

https://docs.evaboot.com
Admin
Evaboot is an API platform for finding email addresses, verifying email deliverability, and...
Tokens:24,172
Snippets:118
Trust Score:10
Update:7 months ago
Show doc for...
Tokens:
Raw
### Email Finder Job Detail Response Example

Source: https://docs.evaboot.com/_bundle/schema.json?download=

This example shows the detailed results of a completed email finder job. It includes the job's ID, status, timestamps, progress, and any error messages. The 'prospects' array contains detailed information for each prospect processed during the job.

```json
{
  "id": "dcbcdb01-42a8-4efb-91a7-ce6a9ba01afb",
  "status": "complete",
  "created_at": "2023-01-01T12:00:00Z",
  "updated_at": "2023-01-01T12:05:00Z",
  "progress": 100,
  "error_message": "1 prospect failed.",
  "prospects": [
    {
      "id": "dcbcdb01-42a8-4efb-91a7-ce6a9ba01afb",
      "status": "complete",
      "created_at": "2023-01-01T12:00:00Z",
      "updated_at": "2023-01-01T12:05:00Z",
      "progress": 100,
      "error_message": "1 prospect failed.",
      "prospect_count": "3",
      "job_type": "email_finder"
    }
  ]
}
```

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

### Create Email Finder Job Request Example

Source: https://docs.evaboot.com/_bundle/schema.json?download=

This example demonstrates how to create a new job to find email addresses for a list of prospects. It includes prospect details such as first name, last name, company name, and optionally, the company domain. A webhook URL can be provided to receive notifications upon job completion.

```json
{
  "job_name": "Tech Startup Email Hunt",
  "webhook_url": "https://myapp.com/webhook/email-finder",
  "prospects": [
    {
      "first_name": "John",
      "last_name": "Doe",
      "company_name": "Example Corp",
      "company_domain": "example.com"
    },
    {
      "first_name": "Jane",
      "last_name": "Smith",
      "company_name": "TechStart Inc"
    }
  ]
}
```

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

### GET /v1/quota/

Source: https://docs.evaboot.com/schema.md

Retrieve user API usage quota information.

```APIDOC
## GET /v1/quota/

### Description
Retrieve information about the user's API usage quota including daily limits and credits.

### Method
GET

### Endpoint
/v1/quota/

### Response
#### Success Response (200)
- **daily_limit** (integer) - Remaining daily extraction limit
- **credits** (integer) - Remaining evaboot credits
- **accounts_available** (integer) - Available sales navigator accounts
```

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

### GET /v1/email-finder/

Source: https://docs.evaboot.com/schema/email-finder.md

List all email finder jobs created by the authenticated user.

```APIDOC
## GET /v1/email-finder/

### Description
List all email finder jobs created by the authenticated user.

### Method
GET

### Endpoint
/v1/email-finder/

### Parameters
#### Query Parameters
- **status** (string) - Optional - Filter jobs by status (e.g., 'pending', 'completed', 'failed').

### Response
#### Success Response (200)
- **jobs** (array) - A list of email finder jobs.
  - **id** (string) - The unique identifier for the job.
  - **status** (string) - The current status of the job.
  - **created_at** (string) - The timestamp when the job was created.

#### Response Example
```json
{
  "jobs": [
    {
      "id": "job_123",
      "status": "completed",
      "created_at": "2023-10-27T10:00:00Z"
    },
    {
      "id": "job_456",
      "status": "pending",
      "created_at": "2023-10-27T10:05:00Z"
    }
  ]
}
```
```

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

### GET /v1/email-finder/

Source: https://docs.evaboot.com/_bundle/schema.json?download=

Retrieves a list of all email finder jobs previously created by the authenticated user.

```APIDOC
## GET /v1/email-finder/

### Description
List all email finder jobs created by the authenticated user, including their current status and timestamps.

### Method
GET

### Endpoint
/v1/email-finder/

### Response
#### Success Response (200)
- **id** (string) - Unique identifier for the job.
- **status** (string) - Current status of the job (e.g., complete).
- **created_at** (string) - ISO timestamp of job creation.
- **updated_at** (string) - ISO timestamp of last update.

#### Response Example
[
  {
    "id": "dcbcdb01-42a8-4efb-91a7-ce6a9ba01afb",
    "status": "complete",
    "created_at": "2023-01-01T12:00:00Z",
    "updated_at": "2023-01-01T12:05:00Z"
  }
]
```

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

### GET /v1/email-validation/

Source: https://docs.evaboot.com/_bundle/schema.json?download=

List all email validation jobs created by the authenticated user.

```APIDOC
## GET /v1/email-validation/

### Description
List all email validation jobs created by the authenticated user.

### Method
GET

### Endpoint
/v1/email-validation/

### Response
#### Success Response (200)
- **id** (string) - The unique identifier for the email validation job.
- **status** (string) - The current status of the job (e.g., 'pending', 'processing', 'completed', 'failed').
- **created_at** (string) - The timestamp when the job was created.

#### Response Example
```json
[
  {
    "id": "a1b2c3d4-e5f6-7890-1234-567890abcdef",
    "status": "completed",
    "created_at": "2023-10-27T10:00:00Z"
  }
]
```
```

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

### GET /v1/quota/

Source: https://docs.evaboot.com/_bundle/schema.json?download=

Retrieves the current user's API usage statistics, including daily extraction limits, remaining credits, and the status of linked Sales Navigator accounts.

```APIDOC
## GET /v1/quota/

### Description
Retrieve information about the user's API usage quota: daily extraction limit, evaboot credits, and sales navigator accounts available.

### Method
GET

### Endpoint
/v1/quota/

### Parameters
None

### Request Example
GET /v1/quota/
Authorization: Bearer <token>

### Response
#### Success Response (200)
- **success** (boolean) - Indicates if the request was successful
- **quota** (object) - Object containing usage metrics
  - **daily_limit** (integer) - Total daily extraction limit
  - **used_today** (integer) - Amount used today
  - **remaining** (integer) - Remaining quota for the day
  - **credits** (integer) - Available evaboot credits
  - **salesnavs** (array) - List of linked Sales Navigator accounts

#### Response Example
{
  "success": true,
  "quota": {
    "daily_limit": 2500,
    "used_today": 250,
    "remaining": 2250,
    "credits": 1500,
    "salesnavs": [
      { "id": "123456789", "status": "valid" },
      { "id": "987654321", "status": "invalid" }
    ]
  }
}
```

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

### GET /v1/email-finder/

Source: https://docs.evaboot.com/schema/email-finder/email_finder_list

Retrieves a list of all email finder and validation jobs created by the authenticated user.

```APIDOC
## GET /v1/email-finder/

### Description
List all email finder and validation jobs created by the authenticated user. This endpoint returns the status, progress, and metadata for each job.

### Method
GET

### Endpoint
/v1/email-finder/

### Parameters
None

### Request Example
GET /v1/email-finder/ HTTP/1.1
Authorization: Bearer <token>

### Response
#### Success Response (200)
- **id** (string) - Unique identifier for the job
- **status** (string) - Current status: pending, running, complete, or failed
- **created_at** (string) - Timestamp of job creation
- **updated_at** (string) - Timestamp of last update
- **progress** (integer) - Completion percentage
- **error_message** (string, null) - Error details if the job failed
- **prospect_count** (string) - Number of prospects processed
- **job_type** (string) - Type of job: email_finder or email_validation

#### Response Example
[
  {
    "id": "job_123",
    "status": "complete",
    "created_at": "2023-10-01T10:00:00Z",
    "updated_at": "2023-10-01T10:05:00Z",
    "progress": 100,
    "error_message": null,
    "prospect_count": "50",
    "job_type": "email_finder"
  }
]
```

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

### Email Finder Job List Response Example

Source: https://docs.evaboot.com/_bundle/schema.json?download=

This JSON structure represents a list of email finder jobs. Each job entry includes its unique ID, current status, creation and update timestamps, progress percentage, any error messages, the total prospect count, and the job type. This response is typically received when querying for multiple jobs.

```json
{
  "jobs": [
    [
      {
        "id": "dcbcdb01-42a8-4efb-91a7-ce6a9ba01afb",
        "status": "complete",
        "created_at": "2023-01-01T12:00:00Z",
        "updated_at": "2023-01-01T12:05:00Z",
        "progress": 100,
        "error_message": "1 prospect failed.",
        "prospect_count": "3",
        "job_type": "email_finder"
      },
      {
        "id": "550e8400-e29b-41d4-a716-446655440001",
        "status": "running",
        "created_at": "2023-01-02T14:30:00Z",
        "updated_at": "2023-01-02T14:32:00Z",
        "progress": 45,
        "error_message": null,
        "prospect_count": "5",
        "job_type": "email_finder"
      }
    ]
  ]
}
```

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

### GET /v1/quota/

Source: https://docs.evaboot.com/schema/account.md

Retrieve the current API usage quota, including daily extraction limits, available credits, and Sales Navigator account status.

```APIDOC
## GET /v1/quota/

### Description
Retrieve information about the user's API usage quota: daily extraction limit, evaboot credits, and sales navigator accounts available.

### Method
GET

### Endpoint
/v1/quota/

### Parameters
None

### Request Example
GET /v1/quota/

### Response
#### Success Response (200)
- **daily_extraction_limit** (integer) - The maximum number of extractions allowed per day.
- **evaboot_credits** (integer) - The current balance of available credits.
- **sales_navigator_accounts** (integer) - The number of connected Sales Navigator accounts.

#### Response Example
{
  "daily_extraction_limit": 500,
  "evaboot_credits": 1250,
  "sales_navigator_accounts": 1
}
```

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

### Verify Account Connection via cURL

Source: https://docs.evaboot.com/troubleshooting.md

This command tests the validity of your API token and account status by querying the account endpoint. It requires a valid Bearer token in the Authorization header and returns account information if successful.

```bash
curl -H "Authorization: Bearer your_api_token_here" \
     https://api.evaboot.com/v1/account/
```

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

### GET /v1/quota/

Source: https://docs.evaboot.com/schema/account/quota_retrieve

Retrieve the current API usage quota, including daily extraction limits, remaining credits, and the status of associated Sales Navigator accounts.

```APIDOC
## GET /v1/quota/

### Description
Retrieve information about the user's API usage quota: daily extraction limit, evaboot credits, and sales navigator accounts available.

### Method
GET

### Endpoint
/v1/quota/

### Parameters
None

### Request Example
GET /v1/quota/ HTTP/1.1
Authorization: Bearer <token>

### Response
#### Success Response (200)
- **success** (boolean) - Indicates if the request was successful
- **quota** (object) - User quota information
- **quota.daily_limit** (integer) - Total daily extraction limit
- **quota.used_today** (integer) - Number of extractions used today
- **quota.remaining** (integer) - Number of extractions remaining today
- **quota.credits** (number) - Available credits for API operations
- **quota.salesnavs** (array) - List of SalesNav accounts associated with this user
- **quota.salesnavs.id** (string) - SalesNav account ID
- **quota.salesnavs.status** (string) - Status of the SalesNav account (valid or invalid)

#### Response Example
{
  "success": true,
  "quota": {
    "daily_limit": 100,
    "used_today": 20,
    "remaining": 80,
    "credits": 500.5,
    "salesnavs": [
      { "id": "sn_123", "status": "valid" }
    ]
  }
}
```

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

### GET /v1/extractions/

Source: https://docs.evaboot.com/_bundle/schema.json?download=

Retrieves a list of all LinkedIn extraction jobs associated with the authenticated user account.

```APIDOC
## GET /v1/extractions/

### Description
List all LinkedIn extractions for the authenticated user to track progress and retrieve job identifiers.

### Method
GET

### Endpoint
/v1/extractions/

### Response
#### Success Response (200)
- **data** (array) - List of extraction job objects.

#### Response Example
[
  {
    "search_id": "ext-12345",
    "search_name": "Tech Startup CEOs"
  }
]
```

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

### Get User Quota Information

Source: https://docs.evaboot.com/_bundle/schema.json?download=

Retrieves the current API usage statistics for the authenticated user. The response includes daily extraction limits, remaining credits, and the status of linked Sales Navigator accounts.

```json
{
  "success": true,
  "quota": {
    "daily_limit": 2500,
    "used_today": 250,
    "remaining": 2250,
    "credits": 1500,
    "salesnavs": [
      { "id": "123456789", "status": "valid" },
      { "id": "987654321", "status": "invalid" }
    ]
  }
}
```

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

### GET /v1/email-finder/{id}/

Source: https://docs.evaboot.com/_bundle/schema.json?download=

Retrieve the results of a specific email finder job using its ID.

```APIDOC
## GET /v1/email-finder/{id}/

### Description
Retrieve the results of a specific email finder job.

### Method
GET

### Endpoint
/v1/email-finder/{id}/

### Parameters
#### Path Parameters
- **id** (string) - Required - The ID of the email finder job.

### Response
#### Success Response (200)
- **id** (string) - The ID of the job.
- **status** (string) - The current status of the job (e.g., 'running', 'complete', 'failed').
- **created_at** (string) - The timestamp when the job was created.
- **updated_at** (string) - The timestamp when the job was last updated.
- **progress** (integer) - The completion progress of the job (0-100).
- **error_message** (string) - An error message if the job failed, otherwise null.
- **prospects** (array) - A list of prospects with their email finding results.
  - **first_name** (string) - The first name of the prospect.
  - **last_name** (string) - The last name of the prospect.
  - **company_name** (string) - The name of the company.
  - **company_domain** (string) - The domain of the company.
  - **email** (string) - The found email address, or null if not found.
  - **confidence_score** (number) - The confidence score for the found email.
  - **status** (string) - The status of email finding for this prospect.

#### Response Example
```json
{
  "id": "dcbcdb01-42a8-4efb-91a7-ce6a9ba01afb",
  "status": "complete",
  "created_at": "2023-01-01T12:00:00Z",
  "updated_at": "2023-01-01T12:05:00Z",
  "progress": 100,
  "error_message": "1 prospect failed.",
  "prospects": [
    {
      "first_name": "John",
      "last_name": "Doe",
      "company_name": "Example Corp",
      "company_domain": "example.com",
      "email": "john.doe@example.com",
      "confidence_score": 0.95,
      "status": "found"
    },
    {
      "first_name": "Jane",
      "last_name": "Smith",
      "company_name": "TechStart Inc",
      "company_domain": null,
      "email": null,
      "confidence_score": null,
      "status": "not_found"
    }
  ]
}
```
```

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

### GET /v1/extractions/{id}/

Source: https://docs.evaboot.com/_bundle/schema.json?download=

Retrieve the complete results of a LinkedIn extraction, including prospect details, company data, and professional insights.

```APIDOC
## GET /v1/extractions/{id}/

### Description
Retrieve the complete results of a LinkedIn extraction job. The response includes comprehensive data such as personal information, LinkedIn profile metrics, company details, and enriched contact information based on the extraction type.

### Method
GET

### Endpoint
/v1/extractions/{id}/

### Parameters
#### Path Parameters
- **id** (string) - Required - The unique identifier of the extraction job.

### Request Example
GET /v1/extractions/ext-12345/

### Response
#### Success Response (200)
- **search_id** (string) - Unique identifier for the search.
- **search_name** (string) - Name of the search job.
- **status** (string) - Current status of the extraction (e.g., EXECUTED).
- **prospects** (array) - List of extracted prospect objects.

#### Response Example
{
  "search_id": "ext-12345",
  "search_name": "Tech Startup CEOs",
  "status": "EXECUTED",
  "total_prospects": 2,
  "prospects": [
    {
      "First Name": "John",
      "Last Name": "Doe",
      "Email": "john.doe@example.com",
      "Company Name": "Example Corp"
    }
  ]
}
```

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

### GET /email-validation/jobs/{id}

Source: https://docs.evaboot.com/_bundle/schema.json?download=

Retrieve detailed information about a specific email validation job, including progress and individual prospect results.

```APIDOC
## GET /email-validation/jobs/{id}

### Description
Retrieves the full details of an email validation job, including the current progress percentage, status, and detailed results for all associated prospects.

### Method
GET

### Endpoint
/email-validation/jobs/{id}

### Parameters
#### Path Parameters
- **id** (string) - Required - The unique identifier of the job.

### Response
#### Success Response (200)
- **id** (string) - Job ID.
- **status** (string) - Current status.
- **progress** (integer) - Completion percentage.
- **prospects** (array) - List of validated prospects with their validity status.

#### Response Example
{
  "id": "job_12345",
  "status": "completed",
  "progress": 100,
  "prospects": [{"id": "uuid", "email": "test@example.com", "email_validity": "valid"}]
}
```

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

### GET /v1/email-finder/{id}/

Source: https://docs.evaboot.com/schema/email-finder.md

Retrieve the results of a specific email finder job.

```APIDOC
## GET /v1/email-finder/{id}/

### Description
Retrieve the results of a specific email finder job.

### Method
GET

### Endpoint
/v1/email-finder/{id}/

### Parameters
#### Path Parameters
- **id** (string) - Required - The unique identifier of the email finder job.

### Response
#### Success Response (200)
- **job_id** (string) - The unique identifier for the job.
- **status** (string) - The current status of the job.
- **results** (array) - A list of results for each prospect in the job.
  - **first_name** (string) - The first name of the prospect.
  - **last_name** (string) - The last name of the prospect.
  - **company_name** (string) - The name of the prospect's company.
  - **email** (string) - The found email address, if any.
  - **confidence_score** (number) - The confidence score of the found email.
  - **error** (string) - An error message if the email could not be found.

#### Response Example
```json
{
  "job_id": "job_789",
  "status": "completed",
  "results": [
    {
      "first_name": "Jane",
      "last_name": "Smith",
      "company_name": "Tech Solutions",
      "email": "jane.smith@techsolutions.com",
      "confidence_score": 0.92,
      "error": null
    },
    {
      "first_name": "Peter",
      "last_name": "Jones",
      "company_name": "Innovate Inc.",
      "email": null,
      "confidence_score": 0.0,
      "error": "Email not found"
    }
  ]
}
```
```

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

### Create Email Finder Job

Source: https://docs.evaboot.com/

Shows how to initiate an email finding job by sending a POST request with a JSON payload containing prospect details such as name and company information.

```shell
curl -X POST \
  -H "Authorization: Bearer your_api_token_here" \
  -H "Content-Type: application/json" \
  -d '{
    "prospects": [
      {
        "first_name": "John",
        "last_name": "Doe",
        "company_name": "Example Corp",
        "company_domain": "example.com"
      }
    ]
  }' \
  https://api.evaboot.com/v1/email-finder/
```

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

### POST /v1/email-finder/

Source: https://docs.evaboot.com/schema.md

Create a bulk job to find email addresses for multiple prospects.

```APIDOC
## POST /v1/email-finder/

### Description
Create a new job to find email addresses for the provided prospects. Supports webhooks for asynchronous processing.

### Method
POST

### Endpoint
/v1/email-finder/

### Parameters
#### Request Body
- **prospects** (array) - Required - List of objects with first_name, last_name, company_name
- **webhook_url** (string) - Optional - URL to receive job completion notification

### Request Example
{
  "prospects": [{"first_name": "John", "last_name": "Doe", "company_name": "Acme Corp"}],
  "webhook_url": "https://your-api.com/webhook"
}

### Response
#### Success Response (200)
- **job_id** (string) - Unique identifier for the created job
```

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

### GET /v1/email-validation/

Source: https://docs.evaboot.com/schema/email-verifier.md

Retrieve a list of all email validation jobs created by the authenticated user.

```APIDOC
## GET /v1/email-validation/

### Description
List all email validation jobs created by the authenticated user.

### Method
GET

### Endpoint
/v1/email-validation/

### Response
#### Success Response (200)
- **jobs** (array) - A list of validation job objects.

#### Response Example
{
  "jobs": [
    { "id": "job_123", "status": "completed" }
  ]
}
```

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

### POST /v1/email-finder/

Source: https://docs.evaboot.com/index.html.md

Creates an email finding and verification job for one or more prospects.

```APIDOC
## POST /v1/email-finder/

### Description
Creates an email finding job for a list of prospects to retrieve professional email addresses and verify their deliverability.

### Method
POST

### Endpoint
https://api.evaboot.com/v1/email-finder/

### Parameters
#### Request Body
- **prospects** (array) - Required - A list of prospect objects containing first_name, last_name, company_name, and company_domain.

### Request Example
{
  "prospects": [
    {
      "first_name": "John",
      "last_name": "Doe",
      "company_name": "Example Corp",
      "company_domain": "example.com"
    }
  ]
}

### Response
#### Success Response (200)
- **job_id** (string) - The unique identifier for the created email finding job.

#### Response Example
{
  "job_id": "job_123456789"
}
```

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

### POST /v1/email-finder/

Source: https://docs.evaboot.com/_bundle/schema.json?download=

Create a new job to find email addresses for the provided prospects. This endpoint supports webhooks for completion notifications.

```APIDOC
## POST /v1/email-finder/

### Description
Create a new job to find email addresses for the provided prospects. Each prospect requires first_name, last_name, and company_name. The company_domain field is optional and can help improve email finding accuracy if you know the company's web domain.

**Webhook Support:** This endpoint supports webhooks. Include a `webhook_url` in your request to receive a POST notification when the job completes. The webhook will receive the same data as the GET detail endpoint.

### Method
POST

### Endpoint
/v1/email-finder/

### Parameters
#### Request Body
- **job_name** (string) - Required - The name of the job.
- **webhook_url** (string) - Optional - The URL to send webhook notifications to upon job completion.
- **prospects** (array) - Required - A list of prospects to find emails for.
  - **first_name** (string) - Required - The first name of the prospect.
  - **last_name** (string) - Required - The last name of the prospect.
  - **company_name** (string) - Required - The name of the company the prospect works for.
  - **company_domain** (string) - Optional - The domain of the company's website.

### Request Example
```json
{
  "job_name": "Tech Startup Email Hunt",
  "webhook_url": "https://myapp.com/webhook/email-finder",
  "prospects": [
    {
      "first_name": "John",
      "last_name": "Doe",
      "company_name": "Example Corp",
      "company_domain": "example.com"
    },
    {
      "first_name": "Jane",
      "last_name": "Smith",
      "company_name": "TechStart Inc"
    }
  ]
}
```

### Response
#### Success Response (202)
- **message** (string) - A confirmation message indicating the job has been accepted.

#### Response Example
```json
{
  "message": "Job accepted and processing started"
}
```

#### Error Responses
- **400 Bad Request**: Invalid request data.
- **402 Insufficient Credits**: Not enough credits to perform the action.
```

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

### GET /v1/extractions/{id}/

Source: https://docs.evaboot.com/schema/linkedin-extraction.md

Retrieves the complete results of a specific LinkedIn extraction job.

```APIDOC
## GET /v1/extractions/{id}/

### Description
Retrieve the complete results of a LinkedIn extraction with extensive prospect and company data.

### Method
GET

### Endpoint
/v1/extractions/{id}/

### Parameters
#### Path Parameters
- **id** (string) - Required - The unique ID of the extraction job.

### Response
#### Success Response (200)
- **results** (array) - List of extracted profiles or company data.
- **metadata** (object) - Job status and completion details.
```

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

### Authenticate API Requests

Source: https://docs.evaboot.com/

Demonstrates how to include the required Authorization header with an API token for all requests to the Evaboot API endpoints.

```shell
curl -H "Authorization: Bearer your_api_token_here" \
     https://api.evaboot.com/v1/email-finder/
```

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

### GET /v1/extractions/

Source: https://docs.evaboot.com/schema/linkedin-extraction/extractions_list

Retrieves a list of all LinkedIn extraction jobs associated with the authenticated user.

```APIDOC
## GET /v1/extractions/

### Description
List all LinkedIn extractions for the authenticated user. This endpoint requires a Bearer Token for authentication.

### Method
GET

### Endpoint
/v1/extractions/

### Parameters
None

### Request Example
GET /v1/extractions/
Authorization: Bearer <token>

### Response
#### Success Response (200)
- **search_id** (string) - Required - Unique identifier for the search.
- **search_name** (string) - Optional - Name of the search.
- **status** (string) - Required - Current status of the extraction job.
- **extraction_type** (string) - Required - The type of extraction performed.
- **total_prospects** (integer) - Required - Total number of prospects in the search.
- **search_date_created** (string) - Optional - ISO timestamp of when the search was created.

#### Response Example
[
  {
    "search_id": "ext_12345",
    "search_name": "Sales Leads Q1",
    "status": "completed",
    "extraction_type": "linkedin_search",
    "total_prospects": 150,
    "search_date_created": "2023-10-01T10:00:00Z"
  }
]
```

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

### POST /v1/email-finder/

Source: https://docs.evaboot.com/schema/email-finder.md

Create a new job to find email addresses for the provided prospects. Each prospect requires first_name, last_name, and company_name. The company_domain field is optional and can help improve email finding accuracy if you know the company's web domain.

```APIDOC
## POST /v1/email-finder/

### Description
Create a new job to find email addresses for the provided prospects. Each prospect requires first_name, last_name, and company_name. The company_domain field is optional and can help improve email finding accuracy if you know the company's web domain. This endpoint supports webhooks.

### Method
POST

### Endpoint
/v1/email-finder/

### Parameters
#### Request Body
- **prospects** (array) - Required - A list of prospects for whom to find email addresses.
  - **first_name** (string) - Required - The first name of the prospect.
  - **last_name** (string) - Required - The last name of the prospect.
  - **company_name** (string) - Required - The name of the prospect's company.
  - **company_domain** (string) - Optional - The domain of the prospect's company.
- **webhook_url** (string) - Optional - A URL to receive webhook notifications when the job completes.

### Request Example
```json
{
  "prospects": [
    {
      "first_name": "Jane",
      "last_name": "Smith",
      "company_name": "Tech Solutions",
      "company_domain": "techsolutions.com"
    },
    {
      "first_name": "Peter",
      "last_name": "Jones",
      "company_name": "Innovate Inc."
    }
  ],
  "webhook_url": "https://example.com/webhook"
}
```

### Response
#### Success Response (200)
- **job_id** (string) - The unique identifier for the created job.
- **status** (string) - The initial status of the job.

#### Response Example
```json
{
  "job_id": "job_789",
  "status": "processing"
}
```
```

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

### GET /v1/email-validation/

Source: https://docs.evaboot.com/schema/email-verifier/email_validation_list.md

Retrieves a list of all email validation jobs created by the authenticated user.

```APIDOC
## GET /v1/email-validation/

### Description
List all email validation jobs created by the authenticated user. This endpoint requires Bearer Token authentication.

### Method
GET

### Endpoint
/v1/email-validation/

### Parameters
None

### Response
#### Success Response (200)
- **id** (string) - Unique identifier for the job
- **status** (string) - Current status of the job (pending, running, complete, failed)
- **created_at** (string) - Timestamp of job creation
- **updated_at** (string) - Timestamp of last update
- **progress** (integer) - Completion percentage
- **error_message** (string/null) - Error details if the job failed
- **prospect_count** (string) - Number of prospects in the job
- **job_type** (string) - Type of job (email_finder, email_validation)

#### Response Example
[
  {
    "id": "job_123",
    "status": "complete",
    "created_at": "2023-10-01T10:00:00Z",
    "updated_at": "2023-10-01T10:05:00Z",
    "progress": 100,
    "error_message": null,
    "prospect_count": "50",
    "job_type": "email_validation"
  }
]
```

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

### POST /v1/email-finder/

Source: https://docs.evaboot.com/

Find professional email addresses for prospects and validate that they won't bounce. Process multiple prospects in a single request.

```APIDOC
## POST /v1/email-finder/

### Description
This endpoint allows you to find email addresses for prospects and validate them. It supports processing multiple prospects in a single request.

### Method
POST

### Endpoint
`https://api.evaboot.com/v1/email-finder/`

### Headers
- **Authorization** (string) - Required - Bearer your_api_token_here
- **Content-Type** (string) - Required - application/json

### Request Body
- **prospects** (array) - Required - A list of prospect objects.
  - **first_name** (string) - Required - The first name of the prospect.
  - **last_name** (string) - Required - The last name of the prospect.
  - **company_name** (string) - Required - The name of the prospect's company.
  - **company_domain** (string) - Required - The domain of the prospect's company.

### Request Example
```json
{
  "prospects": [
    {
      "first_name": "John",
      "last_name": "Doe",
      "company_name": "Example Corp",
      "company_domain": "example.com"
    }
  ]
}
```

### Response
#### Success Response (200)
- **job_id** (string) - The ID of the email finding job.
- **status** (string) - The current status of the job (e.g., 'processing', 'completed').

#### Response Example
```json
{
  "job_id": "job_12345abc",
  "status": "processing"
}
```
```

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

### GET /v1/email-validation/{id}/

Source: https://docs.evaboot.com/schema/email-verifier.md

Retrieve the detailed results of a specific email validation job by its ID.

```APIDOC
## GET /v1/email-validation/{id}/

### Description
Retrieve the results of a specific email validation job.

### Method
GET

### Endpoint
/v1/email-validation/{id}/

### Parameters
#### Path Parameters
- **id** (string) - Required - The unique identifier of the validation job.

### Response
#### Success Response (200)
- **results** (array) - The validation status for each email in the job.

#### Response Example
{
  "job_id": "job_abc_789",
  "results": [
    { "email": "test1@example.com", "status": "valid" }
  ]
}
```

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

### GET /v1/email-validation/{id}/

Source: https://docs.evaboot.com/schema/email-verifier/email_validation_retrieve

Retrieve the results of a specific email validation job by providing its unique ID.

```APIDOC
## GET /v1/email-validation/{id}/

### Description
Retrieve the results of a specific email validation job.

### Method
GET

### Endpoint
/v1/email-validation/{id}/

### Parameters
#### Path Parameters
- **id** (string) - Required - The unique identifier of the email validation job.

### Response
#### Success Response (200)
- **id** (string) - The ID of the job.
- **status** (string) - The current status of the job. Enum: "pending", "running", "complete", "failed".
- **created_at** (string) - The timestamp when the job was created.
- **updated_at** (string) - The timestamp when the job was last updated.
- **progress** (integer) - The progress of the job in percentage.
- **error_message** (string,null) - An error message if the job failed.
- **prospects** (array) - A list of prospects processed in the job.
  - **prospects.email** (string,null) - The email address of the prospect.
  - **prospects.email_validity** (string) - The validity status of the email.
  - **prospects.status** (string) - The processing status for the prospect. Enum: "pending", "processing", "complete", "failed".
- **job_type** (string) - The type of job. Enum: "email_finder", "email_validation".

#### Response Example (200)
```json
{
  "id": "job_123",
  "status": "complete",
  "created_at": "2023-10-27T10:00:00Z",
  "updated_at": "2023-10-27T10:05:00Z",
  "progress": 100,
  "error_message": null,
  "prospects": [
    {
      "email": "test@example.com",
      "email_validity": "valid",
      "status": "complete"
    }
  ],
  "job_type": "email_validation"
}
```

#### Error Response (404)
- Not Found
```

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

### POST /v1/email-finder/

Source: https://docs.evaboot.com/schema/email-finder/email_finder_create

Creates a new job to find email addresses for a list of prospects. Supports optional webhook notifications upon job completion.

```APIDOC
## POST /v1/email-finder/

### Description
Initiates a bulk email finding job. Requires prospect details and supports optional webhook URLs for asynchronous notifications.

### Method
POST

### Endpoint
/v1/email-finder/

### Parameters
#### Request Body
- **job_name** (string) - Required - A name for the job.
- **webhook_url** (string) - Optional - URL to receive a POST notification upon completion.
- **prospects** (array) - Required - List of prospects to process.
- **prospects.first_name** (string) - Required - Prospect's first name.
- **prospects.last_name** (string) - Required - Prospect's last name.
- **prospects.company_name** (string) - Optional - Prospect's company name.
- **prospects.company_domain** (string) - Optional - Prospect's company website domain.

### Request Example
{
  "job_name": "Q3 Outreach",
  "webhook_url": "https://api.example.com/webhooks/evaboot",
  "prospects": [
    {
      "first_name": "John",
      "last_name": "Doe",
      "company_name": "Acme Corp",
      "company_domain": "acme.com"
    }
  ]
}

### Response
#### Success Response (202)
- **job_id** (string) - The unique identifier for the created job.
- **status** (string) - The current status of the job.

#### Response Example
{
  "job_id": "job_12345",
  "status": "accepted"
}
```

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

### POST /v1/extractions/single/

Source: https://docs.evaboot.com/_bundle/schema.json?download=

Extract comprehensive data from a single LinkedIn Sales Navigator profile or company page synchronously.

```APIDOC
## POST /v1/extractions/single/

### Description
Extract comprehensive data from a single LinkedIn Sales Navigator profile or company page. This endpoint runs synchronously and returns the complete extracted data immediately. It returns 70+ data fields including personal information, company details, professional background, skills, education, financial metrics, and enhanced insights. The exact fields depend on the profile type (LEAD vs ACCOUNT) and enrichment settings. Webhook support is also available.

**Key Data Categories:**
- Profile Information: Names, headlines, summaries, contact details
- Professional Data: Current role, tenure, skills, education, certifications
- Company Intelligence: Revenue, growth metrics, employee counts, technologies, funding stage
- Social Insights: Connections, posting frequency, languages, volunteer work
- Contact Data: Email addresses and validation (when enrichment enabled)

### Method
POST

### Endpoint
`/v1/extractions/single/`

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
- **profile_id** (string) - Required - The URL or ID of the LinkedIn profile or company page.
- **enrich_email** (string) - Optional - Specifies email enrichment level (e.g., `none`, `matching`).
- **webhook_url** (string) - Optional - A URL to receive webhook notifications upon completion.

### Request Example
```json
{
  "profile_id": "https://www.linkedin.com/sales/lead/ACwAAABcYZ8B...",
  "enrich_email": "none"
}
```

### Response
#### Success Response (200)
Returns the extracted profile or company data.

#### Response Example
```json
{
  "example": "response body"
}
```

#### Error Responses
- **400**: Invalid request data
- **401**: Authentication error
- **402**: Insufficient credits
- **403**: Permission denied
- **429**: Quota exceeded
```

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

### GET /v1/extractions/{id}/

Source: https://docs.evaboot.com/schema.md

Retrieve the complete results of a LinkedIn extraction job with extensive prospect and company data.

```APIDOC
## GET /v1/extractions/{id}/

### Description
Retrieve the complete results of a LinkedIn extraction with extensive prospect and company data. The response fields dynamically adjust based on extraction type and enrichment settings.

### Method
GET

### Endpoint
/v1/extractions/{id}/

### Parameters
#### Path Parameters
- **id** (string) - Required - The ID of the extraction job.

### Response
#### Success Response (200)
- **extraction_results** (object) - Comprehensive data fields including personal information, company details, professional background, skills, education, financial metrics, and enhanced insights.

#### Response Example
```json
{
  "extraction_results": {
    "personal_information": {
      "name": "Jane Smith",
      "job_title": "Marketing Manager",
      "email": "jane.smith@example.com"
    },
    "company_information": {
      "name": "Global Corp",
      "industry": "Technology",
      "revenue_range": "$1B - $5B"
    },
    "professional_details": {
      "current_role": "Marketing Manager",
      "tenure": "5 years"
    }
  }
}
```
```

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

### Authentication

Source: https://docs.evaboot.com/

All API requests must include an Authorization header with your API token.

```APIDOC
## Authentication

### Description
All API requests must include an **Authorization** header with your API token.

### Method
GET (example, actual method may vary for specific endpoints)

### Endpoint
`https://api.evaboot.com/v1/` (base endpoint, specific endpoints follow)

### Headers
- **Authorization** (string) - Required - Bearer your_api_token_here

### Request Example
```bash
curl -H "Authorization: Bearer your_api_token_here" \
     https://api.evaboot.com/v1/email-finder/
```
```

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

### GET /v1/email-finder/{id}/

Source: https://docs.evaboot.com/schema/email-finder/email_finder_retrieve

Retrieve the current status and detailed results of a specific email finder job by its unique identifier.

```APIDOC
## GET /v1/email-finder/{id}/

### Description
Retrieve the results of a specific email finder job. This endpoint returns the job status, progress, and a list of identified prospects with their email details.

### Method
GET

### Endpoint
/v1/email-finder/{id}/

### Parameters
#### Path Parameters
- **id** (string) - Required - The unique identifier of the email finder job.

### Request Example
GET /v1/email-finder/job_12345

### Response
#### Success Response (200)
- **id** (string) - Job ID
- **status** (string) - Job status (pending, running, complete, failed)
- **created_at** (string) - Creation timestamp
- **updated_at** (string) - Last update timestamp
- **progress** (integer) - Completion percentage
- **error_message** (string) - Error details if failed
- **prospects** (array) - List of found prospects
- **prospects.first_name** (string) - Prospect first name
- **prospects.last_name** (string) - Prospect last name
- **prospects.found_email** (string) - Discovered email address
- **prospects.email_validity** (string) - Validity status of the email

#### Response Example
{
  "id": "job_12345",
  "status": "complete",
  "progress": 100,
  "prospects": [
    {
      "first_name": "John",
      "last_name": "Doe",
      "found_email": "john.doe@example.com",
      "email_validity": "valid"
    }
  ]
}
```
Tokens:
Raw