> ## 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 Conversations Async
> Extract LinkedIn messaging conversations asynchronously with automatic pagination. Results are delivered via callback.
No credits required when executed with an Engagement Identity. Set type: "engagement" when creating an Identity via API.
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.
## OpenAPI
````yaml v1/api/actions.json post /actions/linkedin-extract-conversations/run/async
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-conversations/run/async:
post:
tags:
- actions / linkedin
summary: Run linkedin-extract-conversations action asynchronously
operationId: linkedinExtractConversationsAsync
parameters: []
requestBody:
content:
application/json:
schema:
type: object
properties:
parameters:
type: object
properties:
max_results:
type: integer
title: Maximum Conversations
default: 100
maximum: 15000
minimum: 1
description: >-
The maximum number of conversations to extract per
input.
xAutoPaginate: true
x-display-widget: numeric
read:
type: boolean
title: Read
default: true
description: >-
Set read to true to retrieve both read and unread
messages; set it to false to retrieve only unread
messages.
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
inputs:
type: array
items:
type: object
additionalProperties: false
properties:
custom_data:
type: object
additionalProperties: true
nullable: true
description: Custom data (ex-metadata)
default: {}
minItems: 1
maxItems: 1
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
additionalProperties: false
required:
- inputs
responses:
'200':
$ref: '#/components/responses/ActionAsyncResponse'
'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/EmptyInput'
error:
$ref: '#/components/schemas/APIError'
results_count:
type: integer
description: Number of results included in this callback.
results:
type: array
items:
$ref: >-
#/components/schemas/LinkedinExtractConversationsOutput
description: Results of the current callback
required:
- callback_ref_uid
- run
method: post
type: path
path: '{$request.body#/callback/url}'
components:
responses:
ActionAsyncResponse:
description: Default Response
content:
application/json:
schema:
type: object
properties:
run_id:
type: integer
description: The ID of the run.
run_uid:
type: string
description: The UID of the run.
workspace_uid:
type: string
description: The UID of the workspace.
user_uid:
type: string
description: The UID of the user.
action_name:
type: string
description: The name of the action.
status:
type: string
enum:
- pending
- running
- completed
- failed
description: The status of the run.
postponed_until:
type: string
format: date-time
nullable: true
description: >-
If the run is postponed, this field indicates when it will be
retried.
created_at:
type: string
format: date-time
description: The date and time when the run was created.
updated_at:
type: string
format: date-time
nullable: true
description: The date and time when the run was last updated.
name:
type: string
description: Optional user-defined label for the flow run.
maxLength: 255
nullable: true
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'
schemas:
EmptyInput:
type: object
properties: {}
additionalProperties: false
default: {}
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
LinkedinExtractConversationsOutput:
type: object
properties:
participants:
type: array
items:
type: object
additionalProperties: false
properties:
linkedin_profile_id:
type: number
sales_navigator_profile_id:
type: string
linkedin_profile_url:
type: string
format: uri
first_name:
type: string
last_name:
type: string
job_title:
type: string
linkedin_people_post_search_url:
type: string
format: uri
linkedin_thread_id:
type: string
linkedin_thread_url:
type: string
format: uri
read:
type: boolean
total_received_messages:
type: string
created_at:
type: string
format: date-time
last_activity_at:
type: string
format: date-time
last_message:
type: object
properties:
delivered_at:
type: string
format: date-time
first_name:
type: string
last_name:
type: string
linkedin_profile_id:
type: number
sales_navigator_profile_id:
type: string
job_title:
type: string
message_id:
type: string
content:
type: string
attachments:
type: array
items:
type: object
oneOf:
- type: object
additionalProperties: false
properties:
type:
type: string
enum:
- audio
duration:
type: number
download_url:
type: string
format: uri
required:
- type
- type: object
additionalProperties: false
properties:
type:
type: string
enum:
- video
thumbnail:
type: object
additionalProperties: false
properties:
digitalmedia_asset:
type: string
attribution:
type: object
focal_point:
type: object
artifacts:
type: array
items:
type: string
root_url:
type: string
format: uri
download_url:
type: string
format: uri
expires_at:
type: number
size:
type: number
duration:
type: number
entity_urn:
type: string
prev_media:
type: object
next_media:
type: object
required:
- type
- type: object
additionalProperties: false
properties:
type:
type: string
enum:
- file
asset_urn:
type: string
byte_size:
type: number
media_type:
type: string
name:
type: string
download_url:
type: string
format: uri
required:
- type
- type: object
additionalProperties: false
properties:
type:
type: string
enum:
- vectorImage
digitalmedia_asset:
type: string
attribution:
type: object
focal_point:
type: object
artifacts:
type: array
items:
type: string
download_url:
type: string
format: uri
required:
- type
- type: object
additionalProperties: false
properties:
type:
type: string
enum:
- externalMedia
entity_urn:
type: string
title:
type: string
preview_url:
type: string
format: uri
download_url:
type: string
format: uri
required:
- type
- type: object
additionalProperties: false
properties:
type:
type: string
enum:
- forwardedMessageContent
body_text:
type: string
footer_text:
type: string
original_send_at:
type: number
original_sender:
type: object
additionalProperties: false
properties:
backend_urn:
type: string
entity_urn:
type: string
participant:
type: object
additionalProperties: false
properties:
first_name:
type: string
headline:
type: string
last_name:
type: string
profile_image_url:
type: string
format: uri
required:
- type
- type: object
additionalProperties: false
properties:
type:
type: string
enum:
- messageAdRenderContent
activity_type:
type: string
required:
- type
- type: object
additionalProperties: false
properties:
type:
type: string
enum:
- conversationAdsMessageContent
sponsored_message_content_urn:
type: string
texts:
type: array
items:
type: string
required:
- type
- type: object
additionalProperties: false
properties:
type:
type: string
enum:
- hostUrnData
host_urn:
type: string
host_urn_type:
type: string
required:
- type
- type: object
additionalProperties: false
properties:
type:
type: string
enum:
- repliedMessageContent
body_text:
type: string
original_message_urn:
type: string
original_send_at:
type: number
original_sender:
type: object
additionalProperties: false
properties:
backend_urn:
type: string
entity_urn:
type: string
participant:
type: object
additionalProperties: false
properties:
first_name:
type: string
headline:
type: string
last_name:
type: string
profile_image_url:
type: string
format: uri
required:
- type
additionalProperties: false
unread_count:
type: integer
sponsored:
type: boolean
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
securitySchemes:
XApiKeyAuth:
type: apiKey
in: header
name: X-API-Key
````