> ## Documentation Index
> Fetch the complete documentation index at: https://docs.edges.run/llms.txt
> Use this file to discover all available pages before exploring further.
# Search Sales Navigator Company Employees Schedule
> Schedule a Sales Navigator company employees search at a specific time or on a recurring basis.
To run LinkedIn actions, you must first create an identity and connect a LinkedIn
account, either using our [Chrome
Extension](https://chromewebstore.google.com/detail/edges-labs/bippgnolleoecnhaninlfmdapbakklpf),
[username/password login](/v1/api/linkedin/authentication), or [Managed
Accounts](/v1/identities/sync-vs-managed) for a hassle-free setup.
Async action calls automatically handle pagination through the `X-AUTO-PAGINATE` header, iterating over all pages of results and sending batches to your callback URL.
You can limit the total number of results with the `parameters.max_results` param (see "Body" section).
**Callback Delivery**: Both `async` and `schedule` modes deliver results via the callback URL provided in your request.
**Consistent Format**: All execution modes use the same action logic, so inputs and results are identical regardless of mode.
**Error Handling**: Errors follow the [standard API error format](/v1/faq-troubleshooting#troubleshooting-errors).
Using `async` and `schedule` modes, you have to implement some kind of callback management. Be sure to check the [Managing Callbacks](/v1/runs/callbacks) guide to better understand how it works and what your can do.
## Inputs
* `sales_navigator_company_url` **or** `linkedin_company_id`— Identifies the company whose employees you want to search.
* `sales_navigator_profile_search_url`(optional) is a Sales Navigator **people search** URL (`https://www.linkedin.com/sales/search/people...`) to **reuse an existing search**. When provided, the action applies the filters (and optionally `keywords`) from that URL to the company’s employees.
## Reusing a People Search
When you pass **`sales_navigator_profile_search_url`**:
1. The action force the **current\_company** filter in the request with the company id.
2. It **merges** the `query=` from your people search URL with the base query.
3. **Keywords** from the people search are **kept or added** if not already in the base query.
**When to use `sales_navigator_profile_search_url`:** If you provide this URL, the action **relies mainly on the filters from that URL**. Use it to reuse a saved or existing people search and apply it to the company’s employees.
## Notes
* Maximum results : up to 2,500 results.
* Various filters are supported, including **exclusion** fields (e.g. `function_excluded`, `geography_excluded`, `current_job_title_excluded`) and exclusion booleans (`exclude_saved_leads`, `exclude_viewed_leads`, etc.). See the API schema for the full list.
## OpenAPI
````yaml v1/api/actions.json post /actions/salesnavigator-search-company-employees/run/schedule
openapi: 3.1.0
info:
title: ED Automation External API
description: This is the External API documentation for ED Automation
version: dev
servers:
- url: https://api.edges.run/v1
security:
- XApiKeyAuth: []
paths:
/actions/salesnavigator-search-company-employees/run/schedule:
post:
tags:
- actions / salesnavigator
summary: Schedule salesnavigator-search-company-employees action
operationId: salesnavigatorSearchCompanyEmployeesSchedule
parameters: []
requestBody:
content:
application/json:
schema:
type: object
properties:
parameters:
type: object
properties:
max_results:
type: integer
title: Maxmium number of employees
default: 1000
maximum: 2500
description: >-
Maximum number of employees to extract per input
(company profile).
x-display-widget: numeric
geo:
type: string
title: Geography
default: ''
description: >-
Filter by locations URN (e.g. 103644278 for United
States). To select multiple locations, separate each
number with a comma without spaces.
x-display-widget: textbox
function:
type: string
title: Function
default: ''
description: >-
Filter by function URN (e.g. 25 for Sales). To select
multiple functions, separate each number with a comma
without spaces.
x-display-widget: textbox
relationship:
type: string
enum:
- F
- S
- O
- A
- ET
- T
title: Connections (network)
description: 'Filter employees by network: 1st, 2nd or 3rd.'
x-display-widget: select
employees_title:
type: string
title: Job Title
default: ''
description: Filter employees by title.
x-display-widget: textbox
bing_postal_code:
type: string
title: Postal Code
default: ''
description: Filter by postal code.
x-display-widget: textbox
industry:
type: string
title: Industry
default: ''
description: >-
Filter by industry URN (e.g. 12 for Biotechnology
Research). To select multiple industries, separate each
number with a comma without spaces.
x-display-widget: textbox
seniority:
type: array
items:
type: string
enum:
- owner
- partner
- cxo
- vp
- director
- manager
- senior
- entry_manager
- entry
- training
title: Seniority Level
default: []
description: Filter employees by their seniority level.
x-display-widget: select
function_excluded:
type: array
items:
type: number
enum:
- 1
- 2
- 3
- 4
- 5
- 6
- 7
- 8
- 9
- 10
- 11
- 12
- 13
- 14
- 15
- 16
- 17
- 18
- 19
- 20
- 21
- 22
- 23
- 24
- 25
- 26
title: Function Excluded
default: []
description: Filter by function URN (e.g. 25 for Sales).
x-display-widget: textbox
keywords:
type: string
title: Keywords
default: ''
description: Filter employees by keywords.
x-display-widget: textbox
geography_excluded:
type: array
items:
type: number
title: Geography Excluded
default: []
description: >-
Filter by locations URN (e.g. 103644278 for United
States).
x-display-widget: textbox
current_job_title_excluded:
type: array
items:
type: string
title: Job Title Excluded
default: []
description: Filter employees by title.
x-display-widget: textbox
industry_excluded:
type: array
items:
type: number
title: Industry Excluded
default: []
description: >-
Filter by industry URN (e.g. 12 for Biotechnology
Research).
x-display-widget: textbox
seniority_level_excluded:
type: array
items:
type: string
enum:
- owner
- partner
- cxo
- vp
- director
- manager
- senior
- entry_manager
- entry
- training
title: Seniority Level Excluded
default: []
description: Filter employees by their seniority level.
x-display-widget: select
exclude_saved_leads:
type: boolean
title: Remove Saved Leads from Search
default: false
description: Remove Saved Leads from Search
x-display-widget: checkbox
exclude_viewed_leads:
type: boolean
title: Remove Viewed Leads from Search
default: false
description: Remove Viewed Leads from Search
x-display-widget: checkbox
exclude_contacted_leads:
type: boolean
title: Remove Contacted Leads from Search
default: false
description: Remove Contacted Leads from Search
x-display-widget: checkbox
search_within_my_accounts:
type: boolean
title: Search Within Saved Accounts
default: false
description: Search Within Saved Accounts
x-display-widget: checkbox
additionalProperties: false
default: {}
name:
type: string
description: Optional user-defined label for the run.
maxLength: 255
nullable: true
identity_ids:
type: array
description: >-
An array of Identity UUIDs linked to identities (e.g.
LinkedIn) used to execute the Action. You must provide at
least one valid UID with access to the integration. Do not
use account_uid values — only user_uid is supported.
items:
type: string
format: uuid
nullable: true
example:
- 44444444-4444-4444-4444-444444444444
identity_mode:
type: string
enum:
- direct
- auto
- managed
default: direct
nullable: true
description: >-
If "auto", the Action will use any identities from the
current workspace (unless you have provided a list of
identity_ids). "managed" will use the Edges pool of
identities for an extra credit cost
inputs:
type: array
items:
$ref: >-
#/components/schemas/SalesnavigatorSearchCompanyEmployeesInput
minItems: 1
maxItems: 100
callback:
type: object
properties:
url:
type: string
description: >-
URL to send the results to. The Action will send a POST
request with the results to this URL. The request will
include a JSON body with the results of the Action.
nullable: true
pattern: ^(https?:\/\/[^\s]+)$
example: https://example.com/callback
headers:
type: object
description: Headers to include in the callback request.
additionalProperties:
type: string
'on':
type: string
description: >-
Define when you want to receive callbacks. "all" will
send callbacks to stream outputs, "final" will send a
single callback when all inputs are processed or an
error occured on the run.
enum:
- all
- final
default: all
required:
- url
timezone:
type: string
minLength: 1
maxLength: 64
description: >-
The timezone to use for the cron expression (IANA timezone
format, e.g., "America/New_York" or "Europe/Paris"). If not
provided, the UTC timezone will be used.
cron:
type: string
minLength: 1
maxLength: 256
description: >-
Cron expression for scheduling the action. If provided, the
action will be scheduled to run at the specified intervals.
schedule_at:
type: string
format: date-time
description: >-
This is for one shot or 1st programmation calls. If not
provided, the run will be scheduled immediately.
additionalProperties: false
anyOf:
- properties:
cron:
type: string
minLength: 1
maxLength: 256
description: >-
Cron expression for scheduling the action. If provided,
the action will be scheduled to run at the specified
intervals.
required:
- cron
- properties:
schedule_at:
type: string
format: date-time
description: >-
This is for one shot or 1st programmation calls. If not
provided, the run will be scheduled immediately.
required:
- schedule_at
required:
- inputs
- callback
responses:
'200':
$ref: '#/components/responses/ActionScheduleResponse'
'400':
$ref: '#/components/responses/BadRequest'
'424':
$ref: '#/components/responses/FailedDependency'
'500':
$ref: '#/components/responses/InternalServerError'
callbacks:
onSave:
'{$request.body#/callback/url}':
post:
responses:
'200':
description: Callback successfully processed
parameters:
- name: X-Callback-Ref
in: header
required: true
schema:
type: string
format: uuid
description: >-
Stable identifier for the callback event. Remains the same
across retries.
- name: X-Run-Callback
in: header
required: true
schema:
type: string
format: uuid
description: Unique identifier for each delivery attempt of the webhook.
requestBody:
required: true
content:
application/json:
schema:
type: object
properties:
callback_ref_uid:
type: string
format: uuid
description: >-
Stable callback identifier (remains identical across
retries). Used by clients for deduplication.
run:
type: object
properties:
run_uid:
type: string
format: uuid
description: Unique identifier of the run.
batch_uid:
type: string
format: uuid
description: >-
Unique identifier of the batch associated with
this run (internal use).
status:
type: string
enum:
- CREATED
- INVALID
- QUEUED
- SCHEDULED
- BLOCKED
- STOPPED
- RUNNING
- FAILED
- PARTIAL_SUCCEEDED
- SUCCEEDED
description: >-
Status of the run at the time this callback was
generated. This value does not change on retries
and may differ from the run’s current status.
scheduled_run_uid:
type: string
format: uuid
description: >-
Unique identifier of the scheduled run, if
applicable.
required:
- run_uid
- batch_uid
- status
input:
$ref: >-
#/components/schemas/SalesnavigatorSearchCompanyEmployeesInput
error:
$ref: '#/components/schemas/APIError'
results_count:
type: integer
description: Number of results included in this callback.
results:
type: array
items:
$ref: >-
#/components/schemas/SalesnavigatorSearchCompanyEmployeesOutput
description: Results of the current callback
required:
- callback_ref_uid
- run
method: post
type: path
path: '{$request.body#/callback/url}'
components:
schemas:
SalesnavigatorSearchCompanyEmployeesInput:
type: object
properties:
sales_navigator_profile_search_url:
pattern: >-
/^https:\/\/(?:(www|[a-z]{2})\.)?linkedin\.com\/sales\/search\/people.+/
type: string
format: uri
description: >-
A Sales Navigator Profile Search URL should start with
'https://www.linkedin.com/sales/search/people'
x-help: >-
A Sales Navigator Profile Search URL should start with
'https://www.linkedin.com/sales/search/people'
x-variations:
- sales_navigator_employees_url
custom_data:
type: object
additionalProperties: true
description: Custom data (ex-metadata)
anyOf:
- type: object
required:
- sales_navigator_company_url
properties:
sales_navigator_company_url:
pattern: >-
/^^https:\/\/(?:(www|[a-z]{2})\.)?linkedin\.com\/sales\/company\/.+/
type: string
format: uri
description: >-
A Sales Navigator Company URL should start with
'https://www.linkedin.com/sales/company/'
x-primary: true
x-help: >-
A Sales Navigator Company URL should start with
'https://www.linkedin.com/sales/company/'
x-variations:
- sales_navigator_company_url
- company_url
x-required-variations:
- linkedin_company_id
- type: object
required:
- linkedin_company_id
properties:
linkedin_company_id:
type: string
x-variations:
- company_id
- sales_navigator_company_id
additionalProperties: false
APIError:
title: APIError
description: >-
Represents an error returned by the API. This schema defines the
standard structure of error messages to ensure consistent error handling
across the application.
type: object
properties:
error_label:
type: string
nullable: true
error_scope:
type: string
enum:
- input
- integ
- param
- config
nullable: true
error_ref:
type: string
examples:
- ERR-12345
nullable: true
message:
type: string
status_code:
type: integer
nullable: true
params:
type: object
patternProperties:
^[^_].*:
anyOf:
- type: string
- type: number
- type: boolean
- type: 'null'
- type: array
items:
type: string
additionalProperties: false
nullable: true
data:
type: object
nullable: true
additionalProperties: true
description: Additional data about the error
additionalProperties: false
SalesnavigatorSearchCompanyEmployeesOutput:
type: object
properties:
full_name:
type: string
first_name:
type: string
last_name:
type: string
company_name:
type: string
sales_navigator_company_id:
type: string
linkedin_profile_id:
type: integer
connection_degree:
type: integer
job_title:
type: string
summary:
type: string
profile_image_url:
type: string
format: uri
sales_navigator_search_url:
type: string
format: uri
sales_navigator_profile_url:
type: string
format: uri
linkedin_profile_url:
type: string
format: uri
sales_navigator_profile_id:
type: string
sales_navigator_company_url:
type: string
format: uri
location:
type: string
position_started_at:
type: string
linkedin_people_post_search_url:
type: string
format: uri
viewed:
type: boolean
tenure_start:
type: string
tenure_end:
type: string
tenure_length:
type: string
recently_hired:
type: boolean
recently_promoted:
type: boolean
current_company:
type: string
BadRequest:
title: APIError
description: >-
Represents an error returned by the API. This schema defines the
standard structure of error messages to ensure consistent error handling
across the application.
type: object
properties:
error_label:
type: string
nullable: true
error_scope:
type: string
enum:
- input
- integ
- param
- config
nullable: true
error_ref:
type: string
nullable: true
example: ERR-12345
message:
type: string
status_code:
type: integer
nullable: true
params:
type: object
additionalProperties:
anyOf:
- type: string
- type: number
- type: boolean
- type: 'null'
- type: array
items:
type: string
nullable: true
data:
type: object
nullable: true
additionalProperties: true
description: Additional data about the error
additionalProperties: false
FailedDependency:
title: APIError
description: >-
Represents an error returned by the API. This schema defines the
standard structure of error messages to ensure consistent error handling
across the application.
type: object
properties:
error_label:
type: string
nullable: true
error_scope:
type: string
enum:
- input
- integ
- param
- config
nullable: true
error_ref:
type: string
nullable: true
example: ERR-12345
message:
type: string
status_code:
type: integer
nullable: true
params:
type: object
additionalProperties:
anyOf:
- type: string
- type: number
- type: boolean
- type: 'null'
- type: array
items:
type: string
nullable: true
data:
type: object
nullable: true
additionalProperties: true
description: Additional data about the error
additionalProperties: false
InternalServerError:
title: APIError
description: >-
Represents an error returned by the API. This schema defines the
standard structure of error messages to ensure consistent error handling
across the application.
type: object
properties:
error_label:
type: string
nullable: true
error_scope:
type: string
enum:
- input
- integ
- param
- config
nullable: true
error_ref:
type: string
nullable: true
example: ERR-12345
message:
type: string
status_code:
type: integer
nullable: true
params:
type: object
additionalProperties:
anyOf:
- type: string
- type: number
- type: boolean
- type: 'null'
- type: array
items:
type: string
nullable: true
data:
type: object
nullable: true
additionalProperties: true
description: Additional data about the error
additionalProperties: false
responses:
ActionScheduleResponse:
description: Default Response
content:
application/json:
schema:
type: object
properties:
schedule_uid:
type: string
description: The UID of the scheduled run.
status:
type: string
enum:
- ACTIVE
- CANCELLED
- PAUSED
- COMPLETED
description: The status of the scheduled run.
cron:
type: string
description: Cron expression for the scheduled run (POSIX format)
nullable: true
timezone:
type: string
description: Timezone for the scheduled run (IANA timezone format)
nullable: true
next_execution_at:
type: string
format: date-time
nullable: true
description: Next execution at
created_at:
type: string
format: date-time
description: The date and time when the run was created.
BadRequest:
description: Bad Request
content:
application/json:
schema:
$ref: '#/components/schemas/BadRequest'
FailedDependency:
description: Failed Dependency
content:
application/json:
schema:
$ref: '#/components/schemas/FailedDependency'
InternalServerError:
description: Internal Server Error
content:
application/json:
schema:
$ref: '#/components/schemas/InternalServerError'
securitySchemes:
XApiKeyAuth:
type: apiKey
in: header
name: X-API-Key
````