Edges

https://docs.edges.run/v1/
Admin
Edges is an API for LinkedIn automation, data enrichment, and lead generation that enables profile...
Tokens:623,169
Snippets:1,528
Trust Score:4.8
Update:11 months ago
Show doc for...
Tokens:
Raw
### Install Edges SDK using npm or yarn

Source: https://docs.edges.run/v1/sdk

Instructions for installing the Edges SDK using package managers like npm or yarn. This is the first step to integrate the SDK into your project.

```bash
npm install @edgesrun/sdk --save
# or
yarn add @edgesrun/sdk
# or for this version
npm install {{npmName}}@{{npmVersion}} --save
```

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

### Error Response Examples

Source: https://docs.edges.run/v1/api/callbacks/list

Examples of error responses for different status codes.

```APIDOC
## Error Response Examples

### 400 Bad Request

#### Response Example
```json
{
  "error_label": "<string>",
  "error_scope": "input",
  "error_ref": "ERR-12345",
  "message": "<string>",
  "status_code": 400,
  "params": {},
  "data": {}
}
```

### 500 Internal Server Error

#### Response Example
```json
{
  "error_label": "<string>",
  "error_scope": "input",
  "error_ref": "ERR-12345",
  "message": "<string>",
  "status_code": 500,
  "params": {},
  "data": {}
}
```
```

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

### Example Default Run Response

Source: https://docs.edges.run/v1/api/actions/linkedin-extract-company-employees-insights-async

An example of a complete default response for a run operation. This illustrates the expected format and fields for a successful run, including IDs, status, and timestamps.

```json
{
  "run_id": 123,
  "run_uid": "<string>",
  "workspace_uid": "<string>",
  "user_uid": "<string>",
  "action_name": "<string>",
  "status": "pending",
  "postponed_until": "2023-11-07T05:31:56Z",
  "created_at": "2023-11-07T05:31:56Z",
  "synced_at": "2023-11-07T05:31:56Z",
  "updated_at": "2023-11-07T05:31:56Z"
}
```

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

### Example LinkedinExtractCompanyOutput Data Structure

Source: https://docs.edges.run/v1/api/actions/linkedin-extract-company

Provides a concrete example of the data that conforms to the LinkedinExtractCompanyOutput schema. This illustrates the expected format for various fields, including nested objects and arrays.

```json
{
  "company_name": "<string>",
  "specialties": [
    "<string>"
  ],
  "tagline": "<string>",
  "linkedin_company_id": 123,
  "description": "<string>",
  "type": "<string>",
  "founded_on": 123,
  "linkedin_company_url": "<string>",
  "website": "<string>",
  "linkedin_company_phone": "<string>",
  "sales_navigator_company_url": "<string>",
  "industries": [
    "<string>"
  ],
  "industries_v1": [
    "<string>"
  ],
  "industry": "<string>",
  "linkedin_job_search_url": "<string>",
  "followers_count": 123,
  "number_employees": 123,
  "employees_range": "<string>",
  "linkedin_employees_url": "<string>",
  "sales_navigator_employees_url": "<string>",
  "country": "<string>",
  "geographic_area": "<string>",
  "city": "<string>",
  "postal_code": "<string>",
  "headquarters": "<string>",
  "locations": [
    {
      "address": "<string>",
      "geographic_area": "<string>",
      "street": "<string>",
      "postal_code": "<string>",
      "city": "<string>",
      "country": "<string>"
    }
  ],
  "number_of_locations": 123,
  "last_funding_investors": [
    {
      "name": "<string>",
      "crunchbase_company_url": "<string>"
    }
  ],
  "crunchbase_company_url": "<string>",
  "last_funding_date": "2023-12-25",
  "last_funding_type": "<string>",
  "last_funding_raised": 123
}
```

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

### Run Object Example Response

Source: https://docs.edges.run/v1/api/actions/linkedin-inmail-profile-async

Provides an example of a successful run object response. This illustrates the expected format and data types for fields like run UID, workspace UID, user UID, action name, status, and various timestamps.

```json
{
  "run_id": "123",
  "run_uid": "<string>",
  "workspace_uid": "<string>",
  "user_uid": "<string>",
  "action_name": "<string>",
  "status": "pending",
  "postponed_until": "2023-11-07T05:31:56Z",
  "created_at": "2023-11-07T05:31:56Z",
  "synced_at": "2023-11-07T05:31:56Z",
  "updated_at": "2023-11-07T05:31:56Z"
}
```

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

### OpenAPI Specification for Get Workspace

Source: https://docs.edges.run/v1/api/workspace/get

This OpenAPI specification defines the GET /workspaces endpoint for retrieving workspace details. It includes authentication requirements (X-API-Key header), request parameters, and detailed schemas for successful (200) and error (404) responses, including example payloads.

```yaml
paths:
  path: /workspaces
  method: get
  servers:
    - url: https://api.edges.run/v1/
  request:
    security:
      - title: APIKeyHeader
        parameters:
          query: {}
          header:
            X-API-Key:
              type: apiKey
              description: >-
                API key required for authentication. Add your API key in the
                X-API-Key header.
          cookie: {}
    parameters:
      path: {}
      query: {}
      header: {}
      cookie: {}
    body: {}
  response:
    '200':
      application/json:
        schemaArray:
          - type: object
            properties:
              uid:
                allOf:
                  - type: string
                    format: uuid
                    title: Uid
              name:
                allOf:
                  - type: string
                    maxLength: 55
                    title: Name
                    description: The name of the workspace (maximum 55 characters)
              credits_left:
                allOf:
                  - type: number
                    title: Credits Left
                    default: 0
              credits_max:
                allOf:
                  - type: integer
                    title: Credits Max
                    default: 0
              credits_used:
                allOf:
                  - type: number
                    title: Credits Used
                    default: 0
              plan_name:
                allOf:
                  - anyOf:
                      - type: string
                      - type: 'null'
                    title: Plan Name
              current_month_start:
                allOf:
                  - anyOf:
                      - type: string
                        format: date-time
                      - type: 'null'
                    title: Current Month Start
              current_month_end:
                allOf:
                  - anyOf:
                      - type: string
                        format: date-time
                      - type: 'null'
                    title: Current Month End
              identities_included:
                allOf:
                  - type: integer
                    title: Identities Included
                    default: 0
              identities_synced:
                allOf:
                  - type: integer
                    title: Identities Synced
                    default: 0
              identities_remaining:
                allOf:
                  - type: integer
                    title: Identities Remaining
                    default: 0
            title: GenericResponse[WorkspaceConsumptionPublicModel]
            refIdentifier: '#/components/schemas/WorkspaceConsumptionPublicModel'
            requiredProperties:
              - name
        examples:
          example:
            value:
              name: Example Workspace
              uid: 123e4567-e89b-12d3-a456-426614174000
              credits_left: 50
              credits_max: 100
              credits_used: 50
              plan_name: Growth
              current_month_start: '2023-10-01T00:00:00Z'
              current_month_end: '2023-10-31T23:59:59Z'
              identities_included: 10
              identities_synced: 2
              identities_remaining: 8
        description: Successfully retrieved the current workspace consumption.
    '404':
      application/json:
        schemaArray:
          - type: any
        examples:
          workspace-not-found:
            summary: Couldn't find the targeted user.
            value:
              message: Workspace not found
              error_label: WORKSPACE_404_NOT_FOUND
              addtional_info:
                details: >-
                  Could not find Workspace that has
                  workspace_uid=123e4567-e89b-12d3-a456-426614174000
          workspace-admin-not-found:
            summary: Couldn't find admin in workspace
            value:
              message: Couldn't find admin in workspace
              error_label: WORKSPACE_ADMIN_404_NOT_FOUND
        description: Couldn't find workspace.
  deprecated: false
  type: path
components:
  schemas: {}
```

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

### Initialize Edges SDK and use Core, LinkedIn, and Sales Navigator clients

Source: https://docs.edges.run/v1/sdk

Demonstrates how to initialize the Edges SDK with an API key and subsequently use its clients for interacting with the core API, extracting LinkedIn profiles, and performing Sales Navigator searches. Requires an active LinkedIn Sales Navigator subscription for the latter.

```typescript
import { Edges } from '@edgesrun/sdk';

// Initialize the SDK with your API Key
const EDGES_API_KEY = "your_api_key"; // for production code, you should use environment variables and add proper check

const ed = new Edges({ apiKey: EDGES_API_KEY });

// Example: Use the Core client
const workspaceResponse = await ed.core.getWorkspaces();
console.log(workspaceResponse.data);

// Example: Use the LinkedIn client
const { data: profile } = await ed.linkedin.extractPeople({ input: {linkedin_profile_url: "https://uk.linkedin.com/in/philip-wookey-8642939b"} });
console.log(profile);

// Example: Use the Sales Navigator client
// !!!You need a linkedin account with an active Sales Navigator subscription!!!
const params = {
    input: {
        sales_navigator_profile_search_url: "https://www.linkedin.com/sales/search/people?query=(...)"
    },
    parameters: {
        exclude_crm_contacts: true,
        exclude_viewed_leads: true
    }
}

const searchResults = await ed.salesnavigator.searchPeople(params);
console.log(searchResults);
```

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

### Initialize Edges SDK with API Key

Source: https://docs.edges.run/v1/sdk

Creates an Edges client instance with authentication and demonstrates accessing scoped clients for different integrations. The client provides access to core platform endpoints and integration-specific actions through lower-case alpha identifiers.

```typescript
const ed = new Edges({ apiKey: 'your_api_key_here' });

ed.core            // Core platform endpoints (identities, workspaces, etc.)
ed.linkedin        // LinkedIn-specific actions
ed.salesnavigator  // Sales Navigator-specific actions
```

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

### OpenAPI Request Example - LinkedIn Extract People Comment Activity

Source: https://docs.edges.run/v1/api/actions/linkedin-extract-people-comment-activity-async

JSON request example for the LinkedIn extract people comment activity async endpoint showing required fields, identity configuration, input parameters, and callback URL setup.

```json
{
  "parameters": {},
  "identity_ids": [
    "44444444-4444-4444-4444-444444444444"
  ],
  "identity_mode": "direct",
  "inputs": [
    {
      "linkedin_profile_url": "<string>",
      "custom_data": {}
    }
  ],
  "callback": {
    "url": "https://example.com/callback",
    "headers": {}
  }
}
```

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

### POST /websites/edges_run_v1

Source: https://docs.edges.run/v1/api/actions/salesnavigator-search-metrics-async

Initiates a new run on the edges platform. You can specify various inputs, identity modes, and a callback URL for notifications.

```APIDOC
## POST /websites/edges_run_v1

### Description
Initiates a new run on the edges platform. This endpoint allows for detailed configuration of the run, including identity matching and input data.

### Method
POST

### Endpoint
/websites/edges_run_v1

### Parameters
#### Request Body
- **identity_ids** (array of strings) - Required - A list of identity IDs to associate with the run.
- **identity_mode** (string) - Required - The mode for identity matching. Example: `direct`.
- **inputs** (array of objects) - Required - An array of input objects, each containing specific data for the run.
  - **sales_navigator_company_id** (string) - Optional - The Sales Navigator company ID.
  - **sales_navigator_profile_search_url** (string) - Optional - The Sales Navigator profile search URL.
  - **custom_data** (object) - Optional - A key-value object for custom data.
- **callback** (object) - Optional - Configuration for the callback.
  - **url** (string) - Required - The URL to send callback notifications to.
  - **headers** (object) - Optional - Headers to include in the callback request.

### Request Example
```json
{
  "identity_ids": ["44444444-4444-4444-4444-444444444444"],
  "identity_mode": "direct",
  "inputs": [
    {
      "sales_navigator_company_id": "<string>",
      "sales_navigator_profile_search_url": "<string>",
      "custom_data": {}
    }
  ],
  "callback": {
    "url": "https://example.com/callback",
    "headers": {}
  }
}
```

### Response
#### Success Response (200)
- **run_id** (integer) - The ID of the run.
- **run_uid** (string) - The UID of the run.
- **workspace_uid** (string) - The UID of the workspace.
- **user_uid** (string) - The UID of the user.
- **action_name** (string) - The name of the action.
- **status** (string) - The status of the run. Enum: `pending`, `running`, `completed`, `failed`.
- **postponed_until** (string, nullable) - If the run is postponed, this field indicates when it will be retried (format: date-time).
- **created_at** (string) - The date and time when the run was created (format: date-time).
- **synced_at** (string, nullable) - The date and time when the run was synced (format: date-time).
- **updated_at** (string, nullable) - The date and time when the run was last updated (format: date-time).

#### Response Example
```json
{
  "run_id": 123,
  "run_uid": "<string>",
  "workspace_uid": "<string>",
  "user_uid": "<string>",
  "action_name": "<string>",
  "status": "pending",
  "postponed_until": "2023-11-07T05:31:56Z",
  "created_at": "2023-11-07T05:31:56Z",
  "synced_at": "2023-11-07T05:31:56Z",
  "updated_at": "2023-11-07T05:31:56Z"
}
```

#### Error Response (400)
- **error_label** (string, nullable)
- **error_scope** (string, nullable) - Enum: `input`, `integ`, `param`, `config`.
- **error_ref** (string, nullable) - Example: `ERR-12345`.
- **message** (string)
- **status_code** (integer, nullable)
- **params** (object, nullable) - Key-value pairs for additional parameter information.
- **data** (object, nullable) - Additional data about the error.

#### Error Response Example
```json
{
  "error_label": "<string>",
  "error_scope": "input",
  "error_ref": "ERR-12345",
  "message": "<string>",
  "status_code": 123,
  "params": {},
  "data": {}
}
```
```

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

### SalesNavigator Extract Employees Count Request Payload Example - JSON

Source: https://docs.edges.run/v1/api/actions/salesnavigator-extract-employees-count-async

Example JSON request payload for the SalesNavigator extract employees count async action. Demonstrates identity configuration with direct mode, bulk input array with company URLs and custom data, and callback webhook setup with optional headers.

```json
{
  "identity_ids": [
    "44444444-4444-4444-4444-444444444444"
  ],
  "identity_mode": "direct",
  "inputs": [
    {
      "sales_navigator_company_url": "<string>",
      "custom_data": {}
    }
  ],
  "callback": {
    "url": "https://example.com/callback",
    "headers": {}
  }
}
```

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

### POST /websites/edges_run_v1

Source: https://docs.edges.run/v1/api/actions/salesnavigator-search-company-employees-async

Initiates a new run on the Edges platform. You can specify the inputs, identity mode, and a callback URL for results.

```APIDOC
## POST /websites/edges_run_v1

### Description
Initiates a new run on the Edges platform. You can specify the inputs, identity mode, and a callback URL for results.

### Method
POST

### Endpoint
/websites/edges_run_v1

### Parameters
#### Query Parameters
- **identity_ids** (array[string]) - Optional - A list of identity IDs to use for the run. If not provided and identity_mode is 'auto', all identities from the current workspace will be used.

#### Request Body
- **identity_mode** (string) - Optional - The mode for identity selection. Options: "direct", "auto", "managed". Defaults to "direct".
- **inputs** (array[object]) - Required - An array of input objects for the action. Each object must conform to the `SalesnavigatorSearchCompanyEmployeesInput` schema. Minimum 1 item, maximum 100000 items.
  - **sales_navigator_company_url** (string) - Required - The Sales Navigator company URL.
  - **custom_data** (object) - Optional - Custom data to be associated with the input.
- **callback** (object) - Required - Configuration for sending results via callback.
  - **url** (string) - Required - URL to send the results to. Must be a valid HTTP or HTTPS URL.
  - **headers** (object) - Optional - Headers to include in the callback request. Keys and values must be strings.

### Request Example
```json
{
  "parameters": {},
  "identity_ids": [
    "44444444-4444-4444-4444-444444444444"
  ],
  "identity_mode": "direct",
  "inputs": [
    {
      "sales_navigator_company_url": "<string>",
      "custom_data": {}
    }
  ],
  "callback": {
    "url": "https://example.com/callback",
    "headers": {}
  }
}
```

### Response
#### Success Response (200)
- **run_id** (integer) - The ID of the run.
- **run_uid** (string) - The UID of the run.
- **workspace_uid** (string) - The UID of the workspace.
- **user_uid** (string) - The UID of the user.
- **action_name** (string) - The name of the action.
- **status** (string) - The status of the run. Enum: "pending", "running", "completed", "failed".
- **postponed_until** (string, date-time, nullable) - If the run is postponed, this field indicates when it will be retried.
- **created_at** (string, date-time) - The date and time when the run was created.
- **synced_at** (string, date-time, nullable) - The date and time when the run was synced.
- **updated_at** (string, date-time, nullable) - The date and time when the run was last updated.

#### Response Example
```json
{
  "run_id": 123,
  "run_uid": "<string>",
  "workspace_uid": "<string>",
  "user_uid": "<string>",
  "action_name": "<string>",
  "status": "pending",
  "postponed_until": "2023-11-07T05:31:56Z",
  "created_at": "2023-11-07T05:31:56Z",
  "synced_at": "2023-11-07T05:31:56Z",
  "updated_at": "2023-11-07T05:31:56Z"
}
```

#### Error Response (400)
- **error_label** (string) - A label describing the error.
```

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

### Example Request for Scheduled Run (YAML)

Source: https://docs.edges.run/v1/api/actions/linkedin-extract-group-members-schedule

An example of a request payload to schedule a run. This example uses a cron expression for recurring execution and specifies identity, inputs, callback, and timezone.

```yaml
example:
  value:
    cron: <string>
    parameters: {}
    identity_ids:
      - 44444444-4444-4444-4444-444444444444
    identity_mode: direct
    inputs:
      - linkedin_group_url: <string>
        custom_data: {}
    callback:
      url: https://example.com/callback
      headers: {}
    timezone: <string>
    schedule_at: '2023-11-07T05:31:56Z'
```

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

### Initialize Edges TypeScript SDK

Source: https://docs.edges.run/v1/api/introduction

Shows how to initialize the Edges TypeScript SDK, which simplifies API interactions. The SDK handles authentication and provides access to various endpoints and integrations like LinkedIn and Sales Navigator.

```typescript
import { Edges } from "@edgesrun/sdk";

const apiKey = "<your_api_key>";
const edges = new Edges(apiKey);

// Now you can use 'edges' to interact with the API...
```

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

### Schedule Action Example Request

Source: https://docs.edges.run/v1/api/actions/linkedin-search-content-schedule

An example of a request payload for scheduling an action using a cron expression and specifying an immediate schedule time.

```json
{
  "cron": "<string>",
  "parameters": {},
  "identity_ids": [
    "44444444-4444-4444-4444-444444444444"
  ],
  "identity_mode": "direct",
  "inputs": [
    {
      "linkedin_content_search_url": "<string>",
      "custom_data": {}
    }
  ],
  "callback": {
    "url": "https://example.com/callback",
    "headers": {}
  },
  "timezone": "<string>",
  "schedule_at": "2023-11-07T05:31:56Z"
}
```

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

### POST /actions/salesnavigator-connect-profile/run/live

Source: https://docs.edges.run/v1/api/actions/salesnavigator-connect-profile

Connects to a Sales Navigator profile and runs an action live. You can provide a custom message and specify the target identity IDs.

```APIDOC
## POST /actions/salesnavigator-connect-profile/run/live

### Description
This endpoint connects to a Sales Navigator profile and executes an action live. It allows for customization of messages and targeting specific user identities.

### Method
POST

### Endpoint
https://api.edges.run/v1/actions/salesnavigator-connect-profile/run/live

### Parameters
#### Header Parameters
- **X-API-Key** (apiKey) - Required - Your API key for authentication.

#### Request Body
- **parameters** (object) - Optional - Contains custom parameters for the action. 
  - **message** (string) - Optional - Your custom message for the connection. Maximum length is 300 characters. Defaults to a pre-defined message.
- **identity_ids** (array of strings) - Optional - An array of Identity UUIDs (user_uid) to execute the Action. At least one valid UID with integration access is required.
- **input** (object) - Required - Input data for the action.
  - **sales_navigator_profile_url** (string) - Required - The URL of the Sales Navigator profile.
  - **custom_data** (object) - Optional - Additional custom data.

### Request Example
```json
{
  "parameters": {
    "message": "Hello {{first_name}}, I'm a huge fan of XXX. Would you be willing to share your best techniques regarding XXX? Have a nice day, John"
  },
  "identity_ids": [
    "44444444-4444-4444-4444-444444444444"
  ],
  "input": {
    "sales_navigator_profile_url": "<string>",
    "custom_data": {}
  }
}
```

### Response
#### Success Response (200)
- **sales_navigator_profile_id** (string) - The ID of the Sales Navigator profile.
- **connected** (boolean) - Indicates if the connection was successful.
- **pending** (boolean) - Indicates if the action is pending.
- **message** (string) - A message related to the action status.

#### Response Example
```json
{
  "sales_navigator_profile_id": "<string>",
  "connected": true,
  "pending": true,
  "message": "<string>"
}
```

#### Error Response (400)
- **error_label** (string) - Optional - A label for the error.
- **error_scope** (string) - Optional - The scope of the error (e.g., input, integ, param, config).
- **error_ref** (string) - Optional - A reference code for the error.
- **message** (string) - A detailed error message.
- **status_code** (integer) - Optional - The HTTP status code.
- **params** (object) - Optional - Additional parameters related to the error.
- **data** (object) - Optional - Additional data about the error.

#### Error Response Example
```json
{
  "error_label": null,
  "error_scope": "input",
  "error_ref": "ERR-12345",
  "message": "Invalid Sales Navigator URL provided.",
  "status_code": 400,
  "params": {
    "sales_navigator_profile_url": "invalid_url"
  },
  "data": null
}
```
```

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

### GET /workspaces

Source: https://docs.edges.run/v1/api/workspace/get

Retrieves information about the current workspace, including credit consumption details and plan information.

```APIDOC
## GET /workspaces

### Description
Retrieves information about the current workspace, including credit consumption details and plan information. This endpoint requires an API key for authentication.

### Method
GET

### Endpoint
/workspaces

### Parameters
#### Query Parameters
None

#### Header Parameters
- **X-API-Key** (apiKey) - Required - API key required for authentication. Add your API key in the X-API-Key header.

### Request Example
```yaml
GET /workspaces HTTP/1.1
Host: api.edges.run
X-API-Key: YOUR_API_KEY
```

### Response
#### Success Response (200)
- **uid** (string) - The unique identifier of the workspace.
- **name** (string) - The name of the workspace (maximum 55 characters).
- **credits_left** (number) - The number of credits remaining for the current billing cycle.
- **credits_max** (integer) - The maximum number of credits allowed for the current plan.
- **credits_used** (number) - The number of credits used in the current billing cycle.
- **plan_name** (string | null) - The name of the current subscription plan.
- **current_month_start** (string) - The start date of the current billing month (ISO 8601 format).
- **current_month_end** (string) - The end date of the current billing month (ISO 8601 format).
- **identities_included** (integer) - The number of identities included in the current plan.
- **identities_synced** (integer) - The number of identities currently synced.
- **identities_remaining** (integer) - The number of remaining identities that can be synced.

#### Response Example (200)
```json
{
  "name": "Example Workspace",
  "uid": "123e4567-e89b-12d3-a456-426614174000",
  "credits_left": 50,
  "credits_max": 100,
  "credits_used": 50,
  "plan_name": "Growth",
  "current_month_start": "2023-10-01T00:00:00Z",
  "current_month_end": "2023-10-31T23:59:59Z",
  "identities_included": 10,
  "identities_synced": 2,
  "identities_remaining": 8
}
```

#### Error Response (404)
- **message** (string) - Error message indicating the workspace was not found.
- **error_label** (string) - A specific error code (e.g., WORKSPACE_404_NOT_FOUND).
- **additional_info** (object) - Additional details about the error.

#### Response Example (404)
```json
{
  "message": "Workspace not found",
  "error_label": "WORKSPACE_404_NOT_FOUND",
  "additional_info": {
    "details": "Could not find Workspace that has workspace_uid=123e4567-e89b-12d3-a456-426614174000"
  }
}
```
```

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

### POST /v1/actions/{action}/run/live - Standard Pagination (Page 1)

Source: https://docs.edges.run/v1/runs/pagination

Make an initial request to fetch the first page of results using standard page-based pagination. This endpoint initiates a search action and returns paginated results with navigation headers.

```APIDOC
## POST /v1/actions/{action}/run/live

### Description
Execute an Edges Run action in live mode and retrieve the first page of results using standard pagination.

### Method
POST

### Endpoint
https://api.edges.run/v1/actions/{action}/run/live?page=1

### Parameters
#### Path Parameters
- **action** (string) - Required - The action identifier (e.g., "salesnavigator-search-company-employees")

#### Query Parameters
- **page** (integer) - Optional - Page number to retrieve (default: 1)

#### Request Body
- **parameters** (object) - Required - Action-specific parameters
- **identity_mode** (string) - Required - Identity mode setting (e.g., "auto")

### Request Example
```bash
curl -i --request POST \
  --url 'https://api.edges.run/v1/actions/salesnavigator-search-company-employees/run/live?page=1' \
  --header 'Content-Type: application/json' \
  --header 'X-API-Key: <your-api-key>' \
  --data '{
    "parameters": {},
    "identity_mode": "auto"
  }'
```

### Response
#### Success Response (200)
- **X-Pagination-Previous** (string|null) - URL for previous page or null if on first page
- **X-Pagination-Next** (string|null) - URL for next page or null if on last page
- **results** (array) - Array of result objects from the action

#### Response Headers
- `X-Pagination-Previous`: null (first page) or URL for previous page
- `X-Pagination-Next`: URL for next page or null if last page
```

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

### Example Schedule Run Request

Source: https://docs.edges.run/v1/api/actions/linkedin-extract-messages-schedule

An example of a request body for scheduling a run, specifying cron, parameters, identity IDs, inputs, callback URL, and timezone.

```json
{
  "cron": "<string>",
  "parameters": {},
  "identity_ids": [
    "44444444-4444-4444-4444-444444444444"
  ],
  "inputs": [
    {
      "linkedin_thread_url": "<string>",
      "custom_data": {}
    }
  ],
  "callback": {
    "url": "https://example.com/callback",
    "headers": {}
  },
  "timezone": "<string>",
  "schedule_at": "2023-11-07T05:31:56Z"
}
```

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

### POST /actions/salesnavigator-extract-employees-distribution/run/live

Source: https://docs.edges.run/v1/api/actions/salesnavigator-extract-employees-distribution

Executes a live extraction of employee distribution data from Sales Navigator for a specified company. Requires an API key for authentication.

```APIDOC
## POST /actions/salesnavigator-extract-employees-distribution/run/live

### Description
This endpoint triggers a live data extraction to get the employee distribution details for a given Sales Navigator company URL. It supports specifying identity modes and providing specific identity IDs for execution.

### Method
POST

### Endpoint
https://api.edges.run/v1/actions/salesnavigator-extract-employees-distribution/run/live

### Parameters
#### Query Parameters
(No query parameters defined)

#### Header Parameters
- **X-API-Key** (apiKey) - Required - Your API key for authentication.

#### Request Body
- **identity_ids** (array[string]) - Optional - An array of Identity UUIDs (user_uid) to execute the Action. Must provide at least one valid UID with integration access.
- **identity_mode** (string) - Optional - Specifies the identity mode. Options: 'direct' (default), 'auto' (uses any identities from the current workspace), 'managed' (uses Edges pool of identities for an extra credit cost).
- **input** (object) - Required - The input object for the action.
  - **sales_navigator_company_url** (string) - Required - The URL of the Sales Navigator company page.
  - **custom_data** (object) - Optional - Custom data fields to be included in the request.

### Request Example
```json
{
  "identity_ids": ["44444444-4444-4444-4444-444444444444"],
  "identity_mode": "direct",
  "input": {
    "sales_navigator_company_url": "<string>",
    "custom_data": {}
  }
}
```

### Response
#### Success Response (200)
- **sales_navigator_company_id** (string) - The ID of the Sales Navigator company.
- **total_employee_count** (integer) - The total number of employees.
- **departments** (array[object]) - An array of department objects.
  - **name** (string) - The name of the department.
  - **headcount_total** (integer) - The total headcount for the department.
  - **headcount_percentage** (number) - The percentage of total headcount in the department.
  - **headcount_growth_3_months** (integer) - Employee growth in the last 3 months.
  - **headcount_growth_6_months** (integer) - Employee growth in the last 6 months.
  - **headcount_growth_12_months** (integer) - Employee growth in the last 12 months.

#### Response Example
```json
{
  "sales_navigator_company_id": "<string>",
  "total_employee_count": 123,
  "departments": [
    {
      "name": "<string>",
      "headcount_total": 123,
      "headcount_percentage": 123,
      "headcount_growth_3_months": 123,
      "headcount_growth_6_months": 123,
      "headcount_growth_12_months": 123
    }
  ]
}
```

#### Error Response (400)
- **error_label** (string) - A label describing the error.
- **error_scope** (string) - The scope of the error (e.g., 'input', 'integ', 'param', 'config').
- **error_ref** (string) - A reference code for the error.
- **message** (string) - A detailed error message.
- **status_code** (integer) - The HTTP status code.
- **params** (object) - Additional parameters related to the error.
```

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

### GET /websites/edges_run_v1

Source: https://docs.edges.run/v1/api/actions/linkedin-extract-sent-invitations-async

Retrieves details about a specific edge run. This endpoint allows you to get information about a run, including its status, creation time, and any postponement details.

```APIDOC
## GET /websites/edges_run_v1

### Description
Retrieves details about a specific edge run. This endpoint allows you to get information about a run, including its status, creation time, and any postponement details.

### Method
GET

### Endpoint
/websites/edges_run_v1

### Parameters
#### Path Parameters
None

#### Query Parameters
* **run_id** (integer) - Required - The unique identifier of the run to retrieve.

### Request Example
Not applicable for GET requests without query parameters.

### Response
#### Success Response (200)
- **run_id** (integer) - The unique identifier of the run.
- **run_uid** (string) - The unique identifier of the run.
- **workspace_uid** (string) - The unique identifier of the workspace.
- **user_uid** (string) - The unique identifier of the user who initiated the run.
- **action_name** (string) - The name of the action performed during the run.
- **status** (string) - The current status of the run (e.g., 'pending', 'completed', 'failed').
- **postponed_until** (string, nullable) - The date and time when the run will be retried if postponed.
- **created_at** (string) - The date and time when the run was created.
- **synced_at** (string, nullable) - The date and time when the run was synced.
- **updated_at** (string, nullable) - The date and time when the run was last updated.

#### Response Example
```json
{
  "run_id": 123,
  "run_uid": "<string>",
  "workspace_uid": "<string>",
  "user_uid": "<string>",
  "action_name": "<string>",
  "status": "pending",
  "postponed_until": "2023-11-07T05:31:56Z",
  "created_at": "2023-11-07T05:31:56Z",
  "synced_at": "2023-11-07T05:31:56Z",
  "updated_at": "2023-11-07T05:31:56Z"
}
```

#### Error Response (400 Bad Request)
- **error_label** (string, nullable) - A label describing the error.
- **error_scope** (string, nullable) - The scope of the error (e.g., 'input', 'integ', 'param', 'config').
- **error_ref** (string, nullable) - A reference code for the error.
- **message** (string) - A detailed message explaining the error.
- **status_code** (integer, nullable) - The HTTP status code associated with the error.
- **params** (object, nullable) - Additional parameters related to the error.
- **data** (object, nullable) - Additional data about the error.

#### Error Response Example (400)
```json
{
  "error_label": "<string>",
  "error_scope": "input",
  "error_ref": "ERR-12345",
  "message": "<string>",
  "status_code": 123,
  "params": {},
  "data": {}
}
```

#### Error Response (424 Failed Dependency)
- **error_label** (string, nullable) - A label describing the error.
- **error_scope** (string, nullable) - The scope of the error (e.g., 'input', 'integ', 'param', 'config').
- **error_ref** (string, nullable) - A reference code for the error.
- **message** (string) - A detailed message explaining the error.
- **status_code** (integer, nullable) - The HTTP status code associated with the error.
- **params** (object, nullable) - Additional parameters related to the error.
- **data** (object, nullable) - Additional data about the error.

#### Error Response Example (424)
```json
{
  "error_label": "<string>",
  "error_scope": "input",
  "error_ref": "ERR-12345",
  "message": "<string>",
  "status_code": 123,
  "params": {},
  "data": {}
}
```
```

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

### POST /actions/salesnavigator-visit-profile/run/async

Source: https://docs.edges.run/v1/api/actions/salesnavigator-visit-profile-async

Initiates an asynchronous run for the Sales Navigator visit profile action. This endpoint accepts identity IDs, input data (including the Sales Navigator profile URL), and a callback URL to receive the results.

```APIDOC
## POST /actions/salesnavigator-visit-profile/run/async

### Description
Initiates an asynchronous run for the Sales Navigator visit profile action. This endpoint accepts identity IDs, input data (including the Sales Navigator profile URL), and a callback URL to receive the results.

### Method
POST

### Endpoint
https://api.edges.run/v1/actions/salesnavigator-visit-profile/run/async

### Parameters
#### Header Parameters
- **X-API-Key** (apiKey) - Required - API key for authentication.

#### Request Body
- **identity_ids** (array[string]) - Required - An array of Identity UUIDs to execute the Action. Use user_uid, not account_uid.
- **inputs** (array[object]) - Required - An array of input objects, each containing `sales_navigator_profile_url` and optional `custom_data`. Minimum 1, maximum 100000 items.
  - **sales_navigator_profile_url** (string) - Required - The URL of the Sales Navigator profile.
  - **custom_data** (object) - Optional - Custom data to be associated with the input.
- **parameters** (object) - Optional - Additional parameters for the action.
  - **extract_interests** (boolean) - Optional - Whether to extract interests. Defaults to false.
- **callback** (object) - Required - Callback configuration for receiving results.
  - **url** (string) - Required - URL to send the results to. Must be a valid HTTP or HTTPS URL.
  - **headers** (object) - Optional - Headers to include in the callback request.

### Request Example
```json
{
  "identity_ids": ["44444444-4444-4444-4444-444444444444"],
  "inputs": [
    {
      "sales_navigator_profile_url": "<string>",
      "custom_data": {}
    }
  ],
  "callback": {
    "url": "https://example.com/callback",
    "headers": {}
  }
}
```

### Response
#### Success Response (200)
- **run_id** (integer) - The ID of the run.
- **run_uid** (string) - The UID of the run.
- **workspace_uid** (string) - The UID of the workspace.
- **user_uid** (string) - The UID of the user.
- **action_name** (string) - The name of the action.
- **status** (string) - The status of the run (pending, running, completed, failed).
- **postponed_until** (string, date-time, nullable) - If the run is postponed, this field indicates when it will be retried.
- **created_at** (string, date-time) - The date and time when the run was created.

#### Response Example
```json
{
  "run_id": 12345,
  "run_uid": "a1b2c3d4-e5f6-7890-1234-567890abcdef",
  "workspace_uid": "w1x2y3z4-a5b6-c7d8-e9f0-1234567890ab",
  "user_uid": "u1v2w3x4-y5z6-a7b8-c9d0-1234567890ef",
  "action_name": "salesnavigator-visit-profile",
  "status": "pending",
  "postponed_until": null,
  "created_at": "2023-10-27T10:00:00Z"
}
```
```

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

### Example API Error Response (400 Bad Request)

Source: https://docs.edges.run/v1/api/actions/linkedin-extract-company-employees-insights-async

An example of a 'Bad Request' error response from the API. This demonstrates the structure with placeholder values for error details.

```json
{
  "error_label": "<string>",
  "error_scope": "input",
  "error_ref": "ERR-12345",
  "message": "<string>",
  "status_code": 123,
  "params": {},
  "data": {}
}
```

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

### POST /websites/edges_run_v1

Source: https://docs.edges.run/v1/api/actions/salesnavigator-extract-leads-list-schedule

Creates a new website entry with Sales Navigator profile list URL and custom data.

```APIDOC
## POST /websites/edges_run_v1

### Description
Creates a new website entry. Requires a Sales Navigator Leads List URL and allows for optional custom data.

### Method
POST

### Endpoint
/websites/edges_run_v1

### Parameters
#### Request Body
- **sales_navigator_profile_list_url** (string) - Required - A Sales Navigator Leads List URL. Must start with 'https://www.linkedin.com/sales/lists/people'.
- **custom_data** (object) - Optional - Custom data (e.g., metadata).

### Request Example
```json
{
  "sales_navigator_profile_list_url": "https://www.linkedin.com/sales/lists/people/12345",
  "custom_data": {
    "source": "manual_entry",
    "campaign_id": "spring_promo"
  }
}
```

### Response
#### Success Response (201)
- **message** (string) - Confirmation message of successful creation.

#### Response Example
```json
{
  "message": "Website entry created successfully."
}
```
```
Tokens:
Raw