API Actions and Workflows Documentation

https://linkedapi.io/docs
Admin
Documentation for various API actions, workflow building, and administrative functions.
Tokens:83,969
Snippets:580
Trust Score:7.2
Update:4 months ago
Show doc for...
Tokens:
Raw
### Action Parameters Example

Source: https://linkedapi.io/docs/actions-overview

This example shows the common parameters for defining an action, including actionType, label, and then.

```json
{
  "actionType": "st.checkConnectionStatus",
  "label": "person1",
  "personUrl": "https://www.linkedin.com/in/person1",
  "then": { ... }
}
```

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

### Example: Search and Open Person Page

Source: https://linkedapi.io/docs/action-st-do-for-people

Demonstrates searching for people and then opening the basic information page for the first two results.

```json
{
  "actionType": "st.searchPeople",
  "term": "John Doe",
  "limit": 2,
  "filter": {
    "position": "CEO",
    "locations": ["New York", "San Francisco", "London"]
  },
  "then": {
    "actionType": "st.doForPeople",
    "then": {
      "actionType": "st.openPersonPage",
      "basicInfo": true
    }
  }
}
```

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

### st.openCompanyPage Action Parameters

Source: https://linkedapi.io/docs/action-st-open-company-page

This snippet shows the parameters required to initiate the st.openCompanyPage action. Ensure the 'companyUrl' is provided for root starts.

```json
{
  "actionType": "st.openCompanyPage",
  "label": "company1",
  "companyUrl": "https://www.linkedin.com/company/company1",
  "basicInfo": true,
  "then": { ... }
}
```

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

### Example: Retrieve Company DMs and Send Connection Requests

Source: https://linkedapi.io/docs/action-st-do-for-people

Shows how to open a company page, retrieve its decision-makers, and send a connection request to each.

```json
{
  "actionType": "st.openCompanyPage",
  "companyUrl": "https://www.linkedin.com/company/techcorp",
  "then": {
    "actionType": "st.retrieveCompanyDMs",
    "then": {
      "actionType": "st.doForPeople",
      "then": {
        "actionType": "st.openPersonPage",
        "then": {
          "actionType": "st.sendConnectionRequest"
        }
      }
    }
  }
}
```

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

### nv.syncConversation Parameters

Source: https://linkedapi.io/docs/action-nv-sync-conversation

This snippet shows the required and optional parameters for the nv.syncConversation action, including the personUrl for root start.

```json
{
  "actionType": "nv.syncConversation",
  "label": "sync1",
  "personUrl": "https://www.linkedin.com/in/person1"
}
```

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

### nv.openPersonPage Action Parameters

Source: https://linkedapi.io/docs/action-nv-open-person-page

This snippet shows the parameters required to initiate the nv.openPersonPage action. The personHashedUrl is mandatory for root starts.

```json
{
  "actionType": "nv.openPersonPage",
  "label": "person1",
  "personHashedUrl": "https://www.linkedin.com/in/SInQBmjJ015eLr8",
  "basicInfo": true,
  "then": { ... }
}
```

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

### Example Completion for Retrieving Connections

Source: https://linkedapi.io/docs/managing-existing-connections

This is a sample response structure for the `st.retrieveConnections` action, showing the data format for retrieved connections including name, public URL, headline, and location.

```json
{
  "actionType": "st.retrieveConnections",
  "success": true,
  "data": [
    {
      "name": "John Doe",
      "publicUrl": "https://www.linkedin.com/in/johndoe",
      "headline": "Founder & CEO at Example Company",
      "location": "Lisbon, Portugal"
    },
    {
      "name": "Jane Smith",
      "publicUrl": "https://www.linkedin.com/in/janesmith",
      "headline": "CEO at Tech Solutions",
      "location": "San Francisco Bay Area"
    },
    {
      "name": "Carlos Santos",
      "publicUrl": "https://www.linkedin.com/in/carlossantos",
      "headline": "Project Manager at Startup Hub",
      "location": "Madrid"
    }
  ]
}
```

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

### Start a Workflow POST Request

Source: https://linkedapi.io/docs/executing-workflows

Make a POST request to the /workflows endpoint to initiate a workflow. Include a JSON body describing the desired action and parameters.

```http
POST https://api.linkedapi.io/workflows
```

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

### st.retrievePendingRequests Result Example

Source: https://linkedapi.io/docs/action-st-retrieve-pending-requests

This JSON object shows an example of the result returned by the st.retrievePendingRequests action when there are pending connection requests. It includes success status and an array of request data.

```json
{
  "actionType": "st.retrievePendingRequests",
  "label": "listPending1",
  "success": true,
  "data": [
    {
      "name": "John Doe",
      "publicUrl": "https://www.linkedin.com/in/johndoe",
      "headline": "Founder & CEO at Example Company",
      "sentTime": "2 weeks ago"
    },
    {
      "name": "Jane Smith",
      "publicUrl": "https://www.linkedin.com/in/janesmith",
      "headline": "CTO at Tech Solutions",
      "sentTime": "1 month ago"
    },
    {
      "name": "Carlos Santos",
      "publicUrl": "https://www.linkedin.com/in/carlossantos",
      "headline": "Product Manager at Startup Hub",
      "sentTime": "3 months ago"
    }
  ]
}
```

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

### Commenting on the Latest Person Post Workflow

Source: https://linkedapi.io/docs/action-st-do-for-posts

This example illustrates how to open a person's profile, retrieve their latest post, and then comment on it using st.doForPosts.

```json
{
  "actionType": "st.openPersonPage",
  "companyUrl": "https://www.linkedin.com/in/person1",
  "then": {
    "actionType": "st.retrievePersonPosts",
    "limit": 1,
    "then": {
      "actionType": "st.doForPosts",
      "then": {
        "actionType": "st.openPost",
        "basicInfo": false,
        "then": {
          "actionType": "st.commentOnPost",
          "text": "Great post! Thanks for sharing."
        }
      }
    }
  }
}
```

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

### Liking the Latest 3 Company Posts Workflow

Source: https://linkedapi.io/docs/action-st-do-for-posts

This example demonstrates how to open a company page, retrieve the latest 3 posts, and then like each of those posts using st.doForPosts.

```json
{
  "actionType": "st.openCompanyPage",
  "companyUrl": "https://www.linkedin.com/company/company1",
  "then": {
    "actionType": "st.retrieveCompanyPosts",
    "limit": 3,
    "then": {
      "actionType": "st.doForPosts",
      "then": {
        "actionType": "st.openPost",
        "basicInfo": false,
        "then": {
          "actionType": "st.reactToPost",
          "type": "like"
        }
      }
    }
  }
}
```

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

### Start Workflow

Source: https://linkedapi.io/docs/executing-workflows

Initiates the execution of a specified workflow by sending a POST request to the /workflows endpoint. It requires a JSON payload describing the workflow action and parameters, and returns a workflow ID and status upon success.

```APIDOC
## POST /workflows

### Description
Starts the execution of a workflow.

### Method
POST

### Endpoint
https://api.linkedapi.io/workflows

### Parameters
#### Request Body
- **actionType** (string) - Required - The type of action to perform (e.g., "st.checkConnectionStatus").
- **personUrl** (string) - Required - The LinkedIn profile URL for the action.

### Request Example
```json
{
  "actionType": "st.checkConnectionStatus",
  "personUrl": "https://www.linkedin.com/in/person1"
}
```

### Response
#### Success Response (200)
- **success** (boolean) - Indicates if the request was successful.
- **result** (object) - Contains workflow details upon success.
  - **workflowId** (string) - Unique identifier for the workflow.
  - **workflowStatus** (string) - Current status of the workflow (e.g., "pending", "running").
  - **message** (string) - Human-readable message about the workflow's status.

#### Response Example
```json
{
  "success": true,
  "result": {
    "workflowId": "wf-64835e7c-a0gc-40ae-8338-108f02sSe643",
    "workflowStatus": "pending",
    "message": "This workflow is scheduled and will start after 2 other workflows already scheduled ahead of it."
  }
}
```

#### Error Response
- **success** (boolean) - Indicates if the request was successful (will be false on error).
- **error** (object) - Contains error details.
  - **type** (string) - The type of error (e.g., "linkedApiTokenRequired", "invalidWorkflow").
  - **message** (string) - A human-readable description of the error.
```

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

### Retrieve Company Basic Info Workflow

Source: https://linkedapi.io/docs/building-workflows

Build a single-action workflow to fetch basic information about a company. The 'basicInfo' parameter must be set to true. Ensure the action allows root start.

```json
{
  "actionType": "st.openCompanyPage",
  "companyUrl": "https://www.linkedin.com/company/company1",
  "basicInfo": true
}
```

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

### Retrieve Basic Company Info

Source: https://linkedapi.io/docs/retrieving-company-data

Use `st.openСompanyPage` with `basicInfo: true` to get fundamental details about a company. This action is suitable for general company profiling.

```json
{
  "actionType": "st.openCompanyPage",
  "companyUrl": "https://www.linkedin.com/company/company1",
  "basicInfo": true
}
```

```json
{
  "actionType": "st.openCompanyPage",
  "success": true,
  "data": {
    "name": "TechCorp",
    "publicUrl": "https://www.linkedin.com/company/company1",
    "description": "TechCorp is a leading provider of innovative technology solutions for businesses worldwide.",
    "location": "Cupertino, California",
    "headquarters": "US",
    "industry": "Information Technology",
    "specialties": "Cloud Computing, AI, Software Development",
    "website": "https://techcorp.com",
    "employeesCount": 500,
    "yearFounded": 2019,
    "ventureFinancing": true,
    "jobsCount": 12
  }
}
```

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

### Get Default Limits

Source: https://linkedapi.io/docs/admin-limits

Retrieve the system's default rate limits. These are applied when no custom limits are set or after resetting to defaults.

```bash
curl -X POST https://api.linkedapi.io/admin/limits.getDefaults \
  -H "Content-Type: application/json" \
  -H "linked-api-token: linked_your_token_here"
```

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

### Retrieve Basic Company Info with nv.doForCompanies

Source: https://linkedapi.io/docs/action-nv-do-for-companies

Use this workflow to search for companies and then retrieve basic information for each company found. This is useful for getting a quick overview of potential leads.

```json
{
  "actionType": "nv.searchCompanies",
  "term": "Tech Inc",
  "filter": {
    "sizes": ["51-200", "2001-500"],
    "locations": ["San Francisco", "New York"],
    "industries": ["Software Development", "Robotics Engineering"],
    "annualRevenue": {
      "min": "0",
      "max": "2.5"
    }
  },
  "then": {
    "actionType": "nv.doForCompanies",
    "then": {
      "actionType": "nv.openCompanyPage",
      "basicInfo": true
    }
  }
}
```

```json
{
  "actionType": "nv.searchCompanies",
  "success": true,
  "data": [
    {
      "name": "TechCorp",
      "hashedUrl": "https://www.linkedin.com/company/12345678",
      "industry": "Information Technology",
      "employeeCount": 500,
      "then": {
        "actionType": "nv.openCompanyPage",
        "success": true,
        "data": {
          "name": "TechCorp",
          "publicUrl": "https://www.linkedin.com/company/techcorp",
          "description": "TechCorp is a leading provider of innovative technology solutions for businesses worldwide.",
          "location": "Cupertino, California",
          "headquarters": "US",
          "industry": "Information Technology",
          "website": "https://techcorp.com",
          "employeeCount": 500,
          "yearFounded": 2019
        }
      }
    },
    {
      "name": "Techical Life",
      "hashedUrl": "https://www.linkedin.com/company/12345678",
      "industry": "Software Development",
      "employeeCount": 230,
      "then": {
        "actionType": "nv.openCompanyPage",
        "success": true,
        "data": {
          "name": "Techical Life",
          "publicUrl": "https://www.linkedin.com/company/techlife",
          "description": "TechLife is a worldwide leader in software development for sustainability.",
          "location": "Mountain View",
          "headquarters": "US",
          "industry": "Software Development",
          "website": "https://techlife.com",
          "employeeCount": 230,
          "yearFounded": 2016
        }
      }
    }
  ]
}
```

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

### Get Available Pricing Options

Source: https://linkedapi.io/docs/admin-subscription

Retrieve the available pricing options for Linked API subscriptions, detailing product IDs, seat types, billing periods, prices, and currency.

```bash
curl -X POST https://api.linkedapi.io/admin/subscription.getPricing \
  -H "Content-Type: application/json" \
  -H "linked-api-token: linked_your_token_here"
```

```json
{
  "success": true,
  "result": {
    "products": [
      {
        "id": "price_...",
        "seatType": "core",
        "billingPeriod": "month",
        "unitPrice": 6900,
        "currency": "usd"
      },
      {
        "id": "price_...",
        "seatType": "plus",
        "billingPeriod": "year",
        "unitPrice": 88800,
        "currency": "usd"
      }
    ]
  }
}
```

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

### st.checkConnectionStatus Action Parameters

Source: https://linkedapi.io/docs/action-st-check-connection-status

Defines the parameters required to initiate a connection status check. The 'personUrl' is mandatory when starting from the root, and an optional 'label' can be provided for tracking.

```json
{
  "actionType": "st.checkConnectionStatus",
  "label": "person1",
  "personUrl": "https://www.linkedin.com/in/person1"
}
```

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

### st.retrievePersonExperience Result Example

Source: https://linkedapi.io/docs/action-st-retrieve-person-experience

This JSON object represents the successful result of the st.retrievePersonExperience action. It includes the 'actionType', 'label' (if provided), and a 'data' array containing details of the person's work experience.

```json
{
  "actionType": "st.retrievePersonExperience",
  "label": "person1Experience",
  "success": true,
  "data": [
    {
      "position": "Software Engineer",
      "companyName": "TechCorp",
      "companyHashedUrl": "https://www.linkedin.com/company/12345678",
      "employmentType": "fullTime",
      "locationType": "onSite",
      "description": "Developing innovative software solutions.",
      "duration": 24,
      "startTime": "2021-01-01T00:00:00Z",
      "endTime": null,
      "location": "San Francisco, USA"
    },
    {
      "position": "Junior Developer",
      "companyName": "CodeBase Inc.",
      "companyHashedUrl": "https://www.linkedin.com/company/87654321",
      "employmentType": "internship",
      "locationType": "remote",
      "description": "Worked on front-end development tasks.",
      "duration": 12,
      "startTime": "2020-01-01T00:00:00Z",
      "endTime": "2020-12-31T00:00:00Z",
      "location": null
    }
  ]
}
```

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

### Retrieve Basic Company Information

Source: https://linkedapi.io/docs/action-st-do-for-companies

Use this workflow to search for companies and then retrieve their basic information. This is useful for getting a quick overview of companies matching specific criteria.

```json
{
  "actionType": "st.searchCompanies",
  "term": "Tech Inc",
  "filter": {
    "sizes": ["51-200", "2001-500"],
    "locations": ["San Francisco", "New York"],
    "industries": ["Software Development", "Robotics Engineering"]
  },
  "then": {
    "actionType": "st.doForCompanies",
    "then": {
      "actionType": "st.openCompanyPage",
      "basicInfo": true
    }
  }
}
```

```json
{
  "actionType": "st.searchCompanies",
  "success": true,
  "data": [
    {
      "name": "TechCorp",
      "publicUrl": "https://www.linkedin.com/company/techcorp",
      "industry": "Information Technology",
      "location": "California",
      "then": {
        "actionType": "st.openCompanyPage",
        "success": true,
        "data": {
          "name": "TechCorp",
          "publicUrl": "https://www.linkedin.com/company/techcorp",
          "description": "TechCorp is a leading provider of innovative technology solutions for businesses worldwide.",
          "location": "California",
          "headquarters": "US",
          "industry": "Information Technology",
          "specialties": "Cloud Computing, AI, Software Development",
          "website": "https://techcorp.com",
          "employeeCount": 500,
          "yearFounded": 2019,
          "ventureFinancing": true,
          "jobsCount": 12
        }
      }
    },
    {
      "name": "Techical Life",
      "publicUrl": "https://www.linkedin.com/company/techlife",
      "industry": "Software Development",
      "location": "Mountain View",
      "then": {
        "actionType": "st.openCompanyPage",
        "success": true,
        "data": {
          "name": "Techical Life",
          "publicUrl": "https://www.linkedin.com/company/techlife",
          "description": "TechLife is a worldwide leader in software development for sustainability.",
          "location": "Mountain View",
          "headquarters": "US",
          "industry": "Software Development",
          "specialties": "Software Development, AI",
          "website": "https://techlife.com",
          "employeeCount": 163,
          "yearFounded": 2016,
          "ventureFinancing": false,
          "jobsCount": 4
        }
      }
    }
  ]
}
```

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

### Connection Session Status Response

Source: https://linkedapi.io/docs/admin-accounts

This is an example of a successful response when checking a connection session's status. It includes the session ID, its current status, and type.

```json
{
  "success": true,
  "result": {
    "session": {
      "sessionId": "990eef7a-...",
      "status": "pending",
      "type": "initial"
    }
  }
}
```

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

### Multiple Connection Status Checks Workflow

Source: https://linkedapi.io/docs/building-workflows

Construct an array workflow to efficiently check the connection status for multiple people sequentially. This is faster than individual single-action workflows for identical operations. Ensure the action allows root start.

```json
[
  {
    "actionType": "st.checkConnectionStatus",
    "personUrl": "https://www.linkedin.com/in/person1"
  },
  {
    "actionType": "st.checkConnectionStatus",
    "personUrl": "https://www.linkedin.com/in/person2"
  },
  {
    "actionType": "st.checkConnectionStatus",
    "personUrl": "https://www.linkedin.com/in/person3"
  },
  {
    "actionType": "st.checkConnectionStatus",
    "personUrl": "https://www.linkedin.com/in/person4"
  },
  {
    "actionType": "st.checkConnectionStatus",
    "personUrl": "https://www.linkedin.com/in/person5"
  }
]
```

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

### st.openPersonPage Action Parameters

Source: https://linkedapi.io/docs/account-api/action-st-open-person-page

This snippet shows the required and optional parameters for the st.openPersonPage action. The personUrl is mandatory for root starts, while basicInfo controls the inclusion of detailed profile data.

```json
{
  "actionType": "st.openPersonPage",
  "label": "person1",
  "personUrl": "https://www.linkedin.com/in/person1",
  "basicInfo": true,
  "then": { ... }
}
```

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

### Retrieve API Actions Statistics

Source: https://linkedapi.io/docs/api-usage-statistics

Make a GET request to this endpoint to retrieve statistics for actions executed within a specified time range. The difference between start and end timestamps must not exceed 30 days.

```bash
GET https://api.linkedapi.io/stats/actions?start={}&end={}
```

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

### Checking for result

Source: https://linkedapi.io/docs/executing-workflows

After starting your workflow and receiving the workflowId, you need to periodically check the workflow result by sending a GET request to the specified endpoint. The response will indicate the workflow's status (pending, running, completed, or failed) and provide relevant messages or completion/failure details.

```APIDOC
## GET /workflows/{workflowId}

### Description
Retrieves the current status and results of a specific workflow execution.

### Method
GET

### Endpoint
https://api.linkedapi.io/workflows/{workflowId}

### Parameters
#### Path Parameters
- **workflowId** (string) - Required - The unique identifier of the workflow to check.

### Response
#### Success Response (200)
- **success** (boolean) - Indicates if the request was successful.
- **result** (object) - Contains the workflow status and related information.
  - **workflowStatus** (string) - The current status of the workflow (e.g., "pending", "running", "completed", "failed").
  - **message** (string) - Optional - A message providing more details about the workflow status.
  - **completion** (object) - Optional - Present if the workflow completed successfully, containing details about the actions performed.
    - **actionType** (string) - The type of action that was completed.
    - **success** (boolean) - Indicates if the action was successful.
    - **data** (object) - Optional - Data resulting from the action.
  - **failure** (object) - Optional - Present if the workflow failed, containing details about the failure.
    - **reason** (string) - The reason for the workflow failure (e.g., "linkedinAccountSignedOut", "languageNotSupported").
    - **message** (string) - A message explaining the failure reason.

### Response Example
```json
{
  "success": true,
  "result": {
    "workflowStatus": "pending",
    "message": "This workflow is scheduled and will start after 2 other workflows already scheduled ahead of it."
  }
}
```
```

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

### Successful Workflow Start Response

Source: https://linkedapi.io/docs/executing-workflows

Upon a successful request to start a workflow, the API returns a JSON object containing the workflow ID, its initial status, and a message.

```json
{
  "success": true,
  "result": {
    "workflowId": "wf-64835e7c-a0gc-40ae-8338-108f02sSe643",
    "workflowStatus": "pending",
    "message": "This workflow is scheduled and will start after 2 other workflows already scheduled ahead of it."
  }
}
```

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

### Get Account Limits

Source: https://linkedapi.io/docs/admin-limits

Retrieve the current rate limits configured for a specific LinkedIn account.

```bash
curl -X POST https://api.linkedapi.io/admin/limits.get \
  -H "Content-Type: application/json" \
  -H "linked-api-token: linked_your_token_here" \
  -d '{"accountId": "f9b4346a-..."}'
```

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

### Search Companies and Retrieve Information

Source: https://linkedapi.io/docs/building-workflows

Build a workflow to search for companies using filters and keywords, then retrieve basic information for each company found. This demonstrates chaining 'st.searchCompanies', 'st.doForCompanies', and 'st.openCompanyPage' actions.

```json
{
  "actionType": "st.searchCompanies",
  "term": "Tech Inc",
  "filter": {
    "sizes": ["51-200", "2001-500"],
    "locations": ["San Francisco", "New York"],
    "industries": ["Software Development", "Robotics Engineering"],
    "annualRevenue": {
      "min": "0",
      "max": "2.5"
    }
  },
  "then": {
    "actionType": "st.doForCompanies",
    "then": {
      "actionType": "st.openCompanyPage",
      "basicInfo": true
    }
  }
}
```

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

### Search Companies Completion

Source: https://linkedapi.io/docs/searching-for-companies

This is an example of a successful completion for the st.searchCompanies action, showing the data returned for found companies.

```json
{
  "actionType": "st.searchCompanies",
  "success": true,
  "data": [
    {
      "name": "TechCorp",
      "publicUrl": "https://www.linkedin.com/company/techcorp",
      "industry": "Information Technology",
      "location": "California"
    },
    {
      "name": "Techical Life",
      "publicUrl": "https://www.linkedin.com/company/techlife",
      "industry": "Software Development",
      "location": "Mountain View"
    }
  ]
}
```

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

### Workflow: Search and Open Person Page

Source: https://linkedapi.io/docs/action-nv-do-for-people

Demonstrates a workflow to search for people and then open the basic info page for each of the first two results using nv.doForPeople.

```json
{
  "actionType": "nv.searchPeople",
  "term": "John Doe",
  "limit": 2,
  "filter": {
    "position": "CEO",
    "locations": ["New York", "San Francisco", "London"]
  },
  "then": {
    "actionType": "nv.doForPeople",
    "then": {
      "actionType": "nv.openPersonPage",
      "basicInfo": true
    }
  }
}
```

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

### st.removeConnection Action Parameters

Source: https://linkedapi.io/docs/action-st-remove-connection

This snippet shows the required parameters for the st.removeConnection action. The personUrl is required when starting the action from the root.

```json
{
  "actionType": "st.removeConnection",
  "label": "remove1",
  "personUrl": "https://www.linkedin.com/in/person1"
}
```

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

### Completion of People Search Workflow

Source: https://linkedapi.io/docs/searching-for-people

This is an example of the successful completion of a people search workflow, showing the data returned for the found individuals.

```json
{
  "actionType": "st.searchPeople",
  "success": true,
  "data": [
    {
      "name": "John Doe",
      "publicUrl": "https://www.linkedin.com/in/johndoe",
      "headline": "Founder & CEO at Example Company",
      "location": "London"
    },
    {
      "name": "John Doe",
      "publicUrl": "https://www.linkedin.com/in/johnyd",
      "headline": "Product Manager at Semsoft",
      "location": "New York"
    }
  ]
}
```

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

### st.syncConversation

Source: https://linkedapi.io/docs/action-st-sync-conversation

Allows you to sync a conversation so you can start polling it. This action can be initiated as a root action when a `personUrl` is provided, or as a child action to `st.openPersonPage`.

```APIDOC
## st.syncConversation

### Description
This action allows you to sync a conversation so you can start polling it. It is useful for initiating polling on a specific person's conversation.

### Method
N/A (This is an SDK action, not an HTTP endpoint)

### Endpoint
N/A

### Parameters
#### Action Parameters
- **actionType** (string) - Required - Must be "st.syncConversation".
- **label** (string) - Optional - Custom label for tracking this action in workflow completion.
- **personUrl** (string) - Required for root start, forbidden for parent start - Public or hashed LinkedIn URL of the person whose conversation you want to synchronize.

### Request Example
```json
{
  "actionType": "st.syncConversation",
  "label": "sync1",
  "personUrl": "https://www.linkedin.com/in/person1"
}
```

### Response
#### Success Response
- **actionType** (string) - The type of action performed.
- **label** (string) - Included only if specified in the action parameters.
- **success** (boolean) - Indicates if the syncing was successful.

```json
{
  "actionType": "st.syncConversation",
  "label": "sync1",
  "success": true
}
```

#### Failed Response
- **actionType** (string) - The type of action performed.
- **label** (string) - Included only if specified in the action parameters.
- **success** (boolean) - Indicates if the syncing was successful.
- **error** (object) - Contains details about the error.
  - **type** (string) - Enum with possible values: `personNotFound`, `selfProfileNotAllowed`.
  - **message** (string) - A message describing the error.

```json
{
  "actionType": "st.syncConversation",
  "label": "sync1",
  "success": false,
  "error": {
    "type": "personNotFound",
    "message": "The provided URL is not an existing LinkedIn person."
  }
}
```
```

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

### st.doForCompanies Action Configuration

Source: https://linkedapi.io/docs/action-st-do-for-companies

This JSON configuration shows the structure for the st.doForCompanies action, including the 'then' parameter for child actions.

```json
{
  "actionType": "st.doForCompanies",
  "then": { ... }
}
```

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

### Successful st.openCompanyPage with basicInfo: true

Source: https://linkedapi.io/docs/action-st-open-company-page

This is the result when the company page is successfully opened and `basicInfo` is set to true. It includes detailed company data.

```json
{
  "actionType": "st.openCompanyPage",
  "label": "company1",
  "success": true,
  "data": {
    "name": "TechCorp",
    "publicUrl": "https://www.linkedin.com/company/company1",
    "description": "TechCorp is a leading provider of innovative technology solutions for businesses worldwide.",
    "location": "Cupertino, California",
    "headquarters": "US",
    "industry": "Information Technology",
    "specialties": "Cloud Computing, AI, Software Development",
    "website": "https://techcorp.com",
    "employeesCount": 500,
    "yearFounded": 2019,
    "ventureFinancing": true,
    "jobsCount": 12,
    "then": { ... }
  }
}
```

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

### Get Active Subscription Seats

Source: https://linkedapi.io/docs/admin-subscription

Retrieve information about the active seats for your subscription, including seat type, quantity, and billing period.

```bash
curl -X POST https://api.linkedapi.io/admin/subscription.getSeats \
  -H "Content-Type: application/json" \
  -H "linked-api-token: linked_your_token_here"
```

```json
{
  "success": true,
  "result": {
    "seats": [
      {
        "seatType": "plus",
        "quantity": 10,
        "billingPeriod": "year"
      }
    ]
  }
}
```

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

### Get All Connected LinkedIn Accounts

Source: https://linkedapi.io/docs/admin-accounts

Retrieves all active and pending LinkedIn accounts and connection sessions. Requires authentication with a valid token.

```bash
curl -X POST https://api.linkedapi.io/admin/accounts.getAll \
  -H "Content-Type: application/json" \
  -H "linked-api-token: linked_your_token_here"
```

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

### Successful Page Opening without Basic Info

Source: https://linkedapi.io/docs/action-nv-open-company-page

This JSON object represents a successful nv.openCompanyPage action where 'basicInfo' was set to false. The result includes the action type, label, success status, and a 'data' object containing only the results of any specified child actions ('then').

```json
{
  "actionType": "nv.openCompanyPage",
  "label": "company1",
  "success": true,
  "data": {
    "then": { ... }
  }
}
```

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

### Cancel Connection Session Response

Source: https://linkedapi.io/docs/admin-accounts

This is an example of a successful response after cancelling a connection session. An empty 'result' object indicates the cancellation was processed.

```json
{
  "success": true,
  "result": {}
}
```

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

### nv.openCompanyPage Action Parameters

Source: https://linkedapi.io/docs/action-nv-open-company-page

This JSON object defines the parameters for the nv.openCompanyPage action. It includes the action type, an optional label, the company's hashed URL, and a flag to include basic information. The 'then' property can specify subsequent child actions.

```json
{
  "actionType": "nv.openCompanyPage",
  "label": "company1",
  "companyHashedUrl": "https://www.linkedin.com/company/12345678",
  "basicInfo": true,
  "then": { ... }
}
```

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

### Successful Page Opening with Basic Info

Source: https://linkedapi.io/docs/action-nv-open-company-page

This is the result of a successful nv.openCompanyPage action when 'basicInfo' is true. It includes the action type, label, a success flag, and a 'data' object containing detailed company information.

```json
{
  "actionType": "nv.openCompanyPage",
  "label": "company1",
  "success": true,
  "data": {
    "name": "TechCorp",
    "publicUrl": "https://www.linkedin.com/company/company1",
    "description": "TechCorp is a leading provider of innovative technology solutions for businesses worldwide.",
    "location": "Cupertino, California",
    "headquarters": "US",
    "industry": "Information Technology",
    "website": "https://techcorp.com",
    "employeesCount": 500,
    "yearFounded": 2019,
    "then": { ... }
  }
}
```

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

### st.retrievePersonPosts

Source: https://linkedapi.io/docs/action-st-retrieve-person-posts

Retrieves posts published by a person. This action can be constrained by a root start and can have parent actions like st.openPersonPage and child actions like st.doForPosts.

```APIDOC
## st.retrievePersonPosts

### Description
This action allows you to retrieve posts published by a person and perform additional post-related actions if needed. It supports filtering by a timestamp and limiting the number of results.

### Method
This is an action-based API, not HTTP. The operation is invoked by calling the `st.retrievePersonPosts` function or method.

### Parameters
#### Action Parameters
- **actionType** (string) - Required - Must be `"st.retrievePersonPosts"`.
- **label** (string) - Optional - Custom label for tracking this action in workflow completion.
- **limit** (integer) - Optional - Number of posts to retrieve. Defaults to 20, with a maximum value of 20.
- **since** (string) - Optional - Timestamp to filter posts published after the specified time (ISO 8601 format).
- **then** (object or array) - Optional - Object or array of child actions to be executed within this action.

**Note**: Both `limit` and `since` conditions are applied simultaneously.

### Request Example
```json
{
  "actionType": "st.retrievePersonPosts",
  "label": "person1Posts",
  "limit": 10,
  "since": "2023-01-01T00:00:00Z",
  "then": { ... }
}
```

### Response
#### Success Response
This action always completes successfully. Even if the person has no posts, it returns an empty array.
- **actionType** (string) - The type of action performed, which is `"st.retrievePersonPosts"`.
- **label** (string) - Included only if specified in the action parameters.
- **success** (boolean) - Indicates if the action was successful. Always `true` for this action.
- **data** (array) - Array of person posts.
  - **url** (string) - URL of the post.
  - **time** (string) - Timestamp when the post was published (ISO 8601 format).
  - **type** (string) - Type of the post. Enum with possible values: `original`, `repost`.
  - **repostText** (string or null) - Additional text added during repost, if applicable.
  - **text** (string or null) - Text content of the post, if available.
  - **images** (array) - Array of top 3 preview image URLs, if available.
  - **hasVideo** (boolean) - Boolean indicating if the post contains a video.
  - **hasPoll** (boolean) - Boolean indicating if the post contains a poll.
  - **reactionsCount** (integer) - Number of reactions on the post.
  - **commentsCount** (integer) - Number of comments on the post.
  - **repostsCount** (integer) - Number of reposts on the post.
  - **then** (object or array) - Results of child actions execution.

#### Response Example
```json
{
  "actionType": "st.retrievePersonPosts",
  "label": "person1Posts",
  "success": true,
  "data": [
    {
      "url": "https://www.linkedin.com/posts/post1",
      "time": "2023-01-02T12:30:00Z",
      "type": "original",
      "repostText": null,
      "text": "Check out our latest product launch!",
      "images": [
        "https://static.linkedin.com/image1.jpg",
        "https://static.linkedin.com/image2.jpg"
      ],
      "hasVideo": false,
      "hasPoll": false,
      "reactionsCount": 27,
      "commentsCount": 8,
      "repostsCount": 12,
      "then": { ... }
    },
    {
      "url": "https://www.linkedin.com/posts/post2",
      "time": "2023-01-01T09:15:00Z",
      "type": "repost",
      "repostText": "Thank you to everyone who joined our webinar!",
      "text": "Original post content about the webinar",
      "images": [],
      "hasVideo": true,
      "hasPoll": false,
      "reactionsCount": 6,
      "commentsCount": 0,
      "repostsCount": 1,
      "then": { ... }
    }
  ]
}
```
```

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

### nv.searchCompanies Parameters

Source: https://linkedapi.io/docs/action-nv-search-companies

This JSON object demonstrates the parameters for the nv.searchCompanies action, including search terms, limits, and detailed filtering criteria for company size, location, industry, and annual revenue. It also shows how to use a custom search URL.

```json
{
  "actionType": "nv.searchCompanies",
  "label": "techIncSearch1",
  "term": "Tech Inc",
  "limit": 2,
  "filter": {
    "sizes": ["51-200", "2001-500"],
    "locations": ["San Francisco", "New York"],
    "industries": ["Software Development", "Robotics Engineering"],
    "annualRevenue": {
      "min": "0",
      "max": "2.5"
    }
  },
  "customSearchUrl": "https://www.linkedin.com/sales/search/company?query=(spellCorrectionEnabled%3Atrue%2Ckeywords%3ALinked%2520API)",
  "then": { ... }
}
```

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

### Check Workflow Status

Source: https://linkedapi.io/docs/executing-workflows

Send a GET request to this endpoint to retrieve the current status of a workflow using its ID. This is useful for polling the execution progress.

```http
GET https://api.linkedapi.io/workflows/{workflowId}
```

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

### nv.doForPeople Action Parameters

Source: https://linkedapi.io/docs/action-nv-do-for-people

Defines the structure for the nv.doForPeople action, including the 'then' parameter for child actions.

```json
{
  "actionType": "nv.doForPeople",
  "then": { ... }
}
```

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

### Get Subscription Status

Source: https://linkedapi.io/docs/admin-subscription

Retrieve the current status of your Linked API subscription. This includes whether it's active, eligible for a trial, or scheduled for cancellation.

```bash
curl -X POST https://api.linkedapi.io/admin/subscription.getStatus \
  -H "Content-Type: application/json" \
  -H "linked-api-token: linked_your_token_here"
```

```json
{
  "success": true,
  "result": {
    "status": "active",
    "eligibleForTrial": false,
    "cancelAtPeriodEnd": false
  }
}
```

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

### nv.doForCompanies Action Configuration

Source: https://linkedapi.io/docs/action-nv-do-for-companies

This JSON structure defines the nv.doForCompanies action and its 'then' parameter, which specifies child actions to be executed for each company.

```json
{
  "actionType": "nv.doForCompanies",
  "then": { ... }
}
```

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

### st.openPersonPage

Source: https://linkedapi.io/docs/account-api/action-st-open-person-page

Opens a person's LinkedIn page to retrieve basic information and perform related actions. It can be used as a root start action when a `personUrl` is provided.

```APIDOC
## st.openPersonPage

### Description
This action allows you to open a person page to retrieve their basic information and perform additional person-related actions if needed.

### Method
N/A (This is an action, not an HTTP endpoint)

### Endpoint
N/A

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
- **actionType** (string) - Required - Must be "st.openPersonPage".
- **label** (string) - Optional - Custom label for tracking this action in workflow completion.
- **personUrl** (string) - Required for root start, forbidden for parent start - Public or hashed LinkedIn URL of the person.
- **basicInfo** (boolean) - Optional, default: `false` - When set to `true`, the action includes basic person information in the results.
- **then** (object or array) - Optional - Object or array of child actions to be executed within this action.

### Request Example
```json
{
  "actionType": "st.openPersonPage",
  "label": "person1",
  "personUrl": "https://www.linkedin.com/in/person1",
  "basicInfo": true,
  "then": { ... }
}
```

### Response
#### Success Response (with `basicInfo` set to `true`)
- **actionType** (string) - The type of action performed.
- **label** (string) - Included only if specified in the action parameters.
- **success** (boolean) - Indicates if the action was successful.
- **data** (object) - Basic information about the person and results of child actions execution.
  - **name** (string) - Full name of the person.
  - **publicUrl** (string) - Public LinkedIn URL of the person.
  - **hashedUrl** (string) - Hashed LinkedIn URL of the person.
  - **headline** (string) - Headline of the person.
  - **location** (string) - Free-form string indicating the person's location.
  - **countryCode** (string) - Two-character code of the person's country.
  - **position** (string) - Current job position of the person.
  - **about** (string) - "About" section text from the person's profile.
  - **companyName** (string) - Name of the person's current company.
  - **companyHashedUrl** (string) - Hashed LinkedIn URL of the person's current company.
  - **followersCount** (integer) - Number of followers the person has.
  - **then** (object or array) - Results of child actions execution.

#### Success Response (with `basicInfo` set to `false`)
- **actionType** (string) - The type of action performed.
- **label** (string) - Included only if specified in the action parameters.
- **success** (boolean) - Indicates if the action was successful.
- **data** (object)
  - **then** (object or array) - Results of child actions execution.

#### Failed page opening
- **actionType** (string) - The type of action performed.
- **label** (string) - Included only if specified in the action parameters.
- **success** (boolean) - Indicates if the action was successful.
- **error** (object)
  - **type** (string) - Enum with possible values: `personNotFound`, `selfProfileNotAllowed`.
  - **message** (string) - A message describing the error.

### Response Example (Success with basicInfo: true)
```json
{
  "actionType": "st.openPersonPage",
  "label": "person1",
  "success": true,
  "data": {
    "name": "John Doe",
    "publicUrl": "https://www.linkedin.com/in/person1",
    "hashedUrl": "https://www.linkedin.com/in/SInQBmjJ015eLr8",
    "headline": "Software Engineer at TechCorp",
    "location": "San Francisco, USA",
    "countryCode": "US",
    "position": "Software Engineer",
    "about": "Software Engineer with 8+ years of experience building scalable web applications.",
    "companyName": "TechCorp",
    "companyHashedUrl": "https://www.linkedin.com/company/12345678",
    "followersCount": 37,
    "then": { ... }
  }
}
```

### Response Example (Success with basicInfo: false)
```json
{
  "actionType": "st.openPersonPage",
  "label": "person1",
  "success": true,
  "data": {
    "then": { ... }
  }
}
```

### Response Example (Failure)
```json
{
  "actionType": "st.openPersonPage",
  "label": "person1",
  "success": false,
  "error": {
    "type": "personNotFound",
    "message": "The provided URL is not an existing LinkedIn person."
  }
}
```
```
Tokens:
Raw