> ## 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.
# Extract LinkedIn People Schedule
> Schedule extraction of detailed LinkedIn profile information 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.
**Fields deprecated** — The following output fields may be omitted or `null`:
* `birth_date`
* `linkedin_thread_id`
* `connected_at`
When enabled, returns the first **5 companies' experiences** (count varies by profile). For full work history, use [`linkedin-extract-people-experiences`](/v1/api/actions/linkedin-extract-people-experiences).
| Field | Description |
| -------------- | ------------------------------------------------------------------------------ |
| `date` | Employment date ranges only — e.g. `Sep 2024 - Present`, `Sep 2005 - Aug 2008` |
| `title` | Job title |
| `company_name` | Company name |
When enabled, returns **one or two skills** (varies by profile). For full skills list, use [`linkedin-extract-people-skills`](/v1/api/actions/linkedin-extract-people-skills).
When enabled, returns optional profile sections:
`education` · `languages` · `volunteer_experiences` · `summary` · `company_name` · `job_title` · `linkedin_company_url`
**Education fields** (when `education` is included):
| Field | Description |
| ---------------- | ---------------------------------------------------------------------------- |
| `title` | `degreeName` + `fieldOfStudy` (e.g. `Bachelor of Science, Computer Science`) |
| `degree_name` | First part of `title` when comma-separated; otherwise empty |
| `field_of_study` | Second part of `title` when comma-separated; otherwise empty |
When enabled, returns:
`linkedin_company_url` · `connection_degree` · `number_followers` · `number_connections`
**`profile_country`** — Inferred from recent experience locations when LinkedIn does not expose it directly. Remote and hybrid locations are excluded.
**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.
## OpenAPI
````yaml v1/api/actions.json post /actions/linkedin-extract-people/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/linkedin-extract-people/run/schedule:
post:
tags:
- actions / linkedin
summary: Schedule linkedin-extract-people action
operationId: linkedinExtractPeopleSchedule
parameters: []
requestBody:
content:
application/json:
schema:
type: object
properties:
parameters:
type: object
properties:
sections:
type: boolean
title: Sections
default: false
description: >-
Extract sections data. When enabled, returns:
`education`, `languages`, `volunteer_experiences`,
`summary`, `company_name`, `job_title`,
`linkedin_company_url`.
x-display-widget: checkbox
experiences:
type: boolean
title: Experiences
default: false
description: >-
Extract a partial list of professional experiences:
includes only the user's most recent or representative
experiences.
x-display-widget: checkbox
skills:
type: boolean
title: Skills
default: false
description: >-
Extract a partial list of skills: includes only a
selection of the user's main competencies, not the full
set - this list can be empty even if the user has skills
listed on their profile.
x-display-widget: checkbox
highlights:
type: boolean
title: Highlights
default: false
description: >-
Extract highlights data. When enabled, returns:
`linkedin_company_url`, `connection_degree`,
`number_followers`, `number_connections`,
`linkedin_thread_id`.
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/LinkedinExtractPeopleInput'
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/LinkedinExtractPeopleInput'
error:
$ref: '#/components/schemas/APIError'
results_count:
type: integer
description: Number of results included in this callback.
results:
type: array
items:
$ref: '#/components/schemas/LinkedinExtractPeopleOutput'
description: Results of the current callback
required:
- callback_ref_uid
- run
method: post
type: path
path: '{$request.body#/callback/url}'
components:
schemas:
LinkedinExtractPeopleInput:
type: object
properties:
linkedin_profile_url:
pattern: >-
/^https:\/\/(?:(www|[a-z]{2})\.)?linkedin\.com\/(?:in|pub|sales\/people|sales\/lead)\/[^\s/]+/
type: string
format: uri
description: >-
A LinkedIn Profile URL should start with
'https://www.linkedin.com/sales/people/',
'https://www.linkedin.com/sales/lead/',
'https://www.linkedin.com/pub/' or 'https://www.linkedin.com/in/'
x-primary: true
x-placeholder: LinkedIn People Profile URL
x-help: >-
A LinkedIn Profile URL should start with
'https://www.linkedin.com/sales/people/',
'https://www.linkedin.com/sales/lead/',
'https://www.linkedin.com/pub/' or 'https://www.linkedin.com/in/'
x-variations:
- url
- profile_url
- linkedin_url
custom_data:
type: object
additionalProperties: true
description: Custom data (ex-metadata)
additionalProperties: false
required:
- linkedin_profile_url
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
LinkedinExtractPeopleOutput:
type: object
properties:
linkedin_profile_handle:
type: string
first_name:
type: string
last_name:
type: string
full_name:
type: string
birth_date:
type: string
headline:
type: string
summary:
type: string
languages:
type: array
items:
type: string
skills:
type: array
description: >-
A partial list of skills: includes only a selection of the user's
main competencies, not the full set.
items:
additionalProperties: false
type: object
properties:
name:
type: string
sales_navigator_profile_id:
type: string
linkedin_profile_id:
type: integer
linkedin_profile_url:
type: string
format: uri
profile_country:
type: string
profile_language:
type: string
location:
type: string
profile_image_url:
type: string
format: uri
job_title:
type: string
education:
type: array
items:
type: object
additionalProperties: false
properties:
title:
type: string
school_name:
type: string
school_description:
type: string
linkedin_school_url:
type: string
date:
type: string
linkedin_school_id:
type: integer
degree_name:
type: string
field_of_study:
type: string
company_logo_url:
type: string
school_name:
type: string
linkedin_school_url:
type: string
format: uri
volunteer_experiences:
type: array
items:
type: object
additionalProperties: true
number_connections:
type: number
experiences:
type: array
description: >-
A partial list of professional experiences: includes only the user's
most recent experiences.
items:
type: object
additionalProperties: false
properties:
title:
type: string
company_name:
type: string
company_description:
type: string
linkedin_company_url:
type: string
format: uri
location:
type: string
linkedin_company_id:
type: integer
date:
type: string
job_time_period:
type: string
job_contract_type:
type: string
company_logo_url:
type: string
company_name:
type: string
linkedin_company_url:
type: string
format: uri
linkedin_company_id:
type: integer
number_followers:
type: number
linkedin_people_post_search_url:
type: string
format: uri
connection_degree:
type: string
open_to_work:
type: boolean
linkedin_thread_id:
type: string
past_company_name:
type: string
past_job_title:
type: string
past_sales_navigator_company_id:
type: string
past_linkedin_company_id:
type: integer
past_linkedin_company_url:
type: string
format: uri
connected_at:
type: string
format: date-time
number_shared_connections:
type: integer
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
````