> ## Documentation Index
> Fetch the complete documentation index at: https://www.outx.ai/docs/llms.txt
> Use this file to discover all available pages before exploring further.

# OutX API - LinkedIn Social Listening & Automation API

> OutX API docs - Social Listening API for LinkedIn monitoring and LinkedIn API for profile fetching, post retrieval, and engagement automation.

<script type="application/ld+json">
  {`{
    "@context": "https://schema.org",
    "@type": "WebAPI",
    "name": "OutX API",
    "url": "https://api.outx.ai",
    "description": "REST API for LinkedIn social listening, profile data, and engagement automation. Monitor keywords, track people, fetch profiles, and automate engagement.",
    "documentation": "https://outx.ai/docs/api-reference/introduction",
    "provider": {
      "@type": "Organization",
      "name": "OutX.ai",
      "url": "https://www.outx.ai"
    }
    }`}
</script>

The OutX API lets you interact with LinkedIn programmatically, monitor keywords, track people and companies, fetch profiles, and automate engagement. All endpoints share the same base URL and authentication.

## API Overview

The API is organized into two groups:

<CardGroup cols={2}>
  <Card title="Watchlists & Engagement" icon="radar" color="#8B5CF6" href="/docs/api-reference/quickstart">
    Create watchlists that continuously monitor LinkedIn for keywords, people, and companies. Retrieve AI-categorized posts and automate engagement.
  </Card>

  <Card title="LinkedIn Data" icon="bolt" color="#7C3AED" href="/docs/linkedin-api/introduction">
    Fetch LinkedIn profiles, get posts, like and comment, direct, on-demand API calls. All endpoints are async with task polling.
  </Card>
</CardGroup>

***

## Watchlists & Engagement

Create watchlists that continuously scan LinkedIn or Reddit. OutX enriches posts with AI-generated intent labels and relevance scores.

<Note>
  **One watchlist = one platform.** There are four watchlist types, each with its own endpoint: keyword (LinkedIn), Reddit, people (LinkedIn), and company (LinkedIn). Tracking a topic on "LinkedIn and Reddit" means creating two watchlists with two calls. See [Choose a watchlist type](/docs/api-reference/watchlist/overview).
</Note>

### Keyword Watchlists (LinkedIn)

Track LinkedIn posts that match your keywords or an AI-generated keyword set.

| Method | Endpoint                 | Description                                                            | Details                                         |
| ------ | ------------------------ | ---------------------------------------------------------------------- | ----------------------------------------------- |
| POST   | `/api-keyword-watchlist` | Create a watchlist (direct keywords or `prompt`)                       | [Open](/docs/api-reference/watchlist/keyword/create) |
| GET    | `/api-keyword-watchlist` | List or fetch a single keyword watchlist                               | [Open](/docs/api-reference/watchlist/keyword/get)    |
| PUT    | `/api-keyword-watchlist` | Patch fields, replace keywords/labels, or regenerate from a new prompt | [Open](/docs/api-reference/watchlist/keyword/update) |
| DELETE | `/api-keyword-watchlist` | Delete a keyword watchlist                                             | [Open](/docs/api-reference/watchlist/keyword/delete) |

### Reddit Watchlists

Track Reddit posts and comments that match your keywords or an AI-generated keyword set. The Reddit twin of the keyword watchlist: same body shape, different platform.

| Method | Endpoint                | Description                                                            | Details                                        |
| ------ | ----------------------- | ---------------------------------------------------------------------- | ---------------------------------------------- |
| POST   | `/api-reddit-watchlist` | Create a Reddit watchlist (direct keywords or `prompt`)                | [Open](/docs/api-reference/watchlist/reddit/create) |
| GET    | `/api-reddit-watchlist` | List or fetch a single Reddit watchlist                                | [Open](/docs/api-reference/watchlist/reddit/get)    |
| PUT    | `/api-reddit-watchlist` | Patch fields, replace keywords/labels, or regenerate from a new prompt | [Open](/docs/api-reference/watchlist/reddit/update) |
| DELETE | `/api-reddit-watchlist` | Delete a Reddit watchlist                                              | [Open](/docs/api-reference/watchlist/reddit/delete) |

### People Watchlists (LinkedIn)

Track posts and activity from specific LinkedIn profiles.

| Method | Endpoint                | Description                             | Details                                        |
| ------ | ----------------------- | --------------------------------------- | ---------------------------------------------- |
| POST   | `/api-people-watchlist` | Create a people watchlist               | [Open](/docs/api-reference/watchlist/people/create) |
| GET    | `/api-people-watchlist` | List or fetch a single people watchlist | [Open](/docs/api-reference/watchlist/people/get)    |
| PUT    | `/api-people-watchlist` | Patch fields and pause/resume           | [Open](/docs/api-reference/watchlist/people/update) |
| DELETE | `/api-people-watchlist` | Delete a people watchlist               | [Open](/docs/api-reference/watchlist/people/delete) |

### Company Watchlists (LinkedIn)

Monitor LinkedIn company pages and their posts.

| Method | Endpoint                 | Description                              | Details                                         |
| ------ | ------------------------ | ---------------------------------------- | ----------------------------------------------- |
| POST   | `/api-company-watchlist` | Create a company watchlist               | [Open](/docs/api-reference/watchlist/company/create) |
| GET    | `/api-company-watchlist` | List or fetch a single company watchlist | [Open](/docs/api-reference/watchlist/company/get)    |
| PUT    | `/api-company-watchlist` | Patch fields and pause/resume            | [Open](/docs/api-reference/watchlist/company/update) |
| DELETE | `/api-company-watchlist` | Delete a company watchlist               | [Open](/docs/api-reference/watchlist/company/delete) |

### Posts and Engagement

Retrieve, like, and comment on posts surfaced by your watchlists.

| Method | Endpoint            | Description                                | Details                                            |
| ------ | ------------------- | ------------------------------------------ | -------------------------------------------------- |
| GET    | `/api-posts`        | Retrieve and filter posts (15+ parameters) | [Open](/docs/api-reference/engagement/posts/get)        |
| GET    | `/api-interactions` | List likes and comments performed via OutX | [Open](/docs/api-reference/engagement/interactions/get) |
| POST   | `/api-like`         | Like a post                                | [Open](/docs/api-reference/engagement/like/create)      |
| POST   | `/api-comment`      | Comment on a post                          | [Open](/docs/api-reference/engagement/comment/create)   |

### Team & Usage

| Method | Endpoint    | Description                                               | Details                         |
| ------ | ----------- | --------------------------------------------------------- | ------------------------------- |
| GET    | `/api-team` | Read your team, effective plan, limits, and current usage | [Open](/docs/api-reference/team/get) |

***

## LinkedIn Data

Fetch profiles, get posts, and engage. No watchlists needed. All LinkedIn Data endpoints are **async**: submit a request, get a task ID, then [poll for results](/docs/linkedin-api/get-task-status).

| Method | Endpoint                                  | Description                                      | Details                                       |
| ------ | ----------------------------------------- | ------------------------------------------------ | --------------------------------------------- |
| POST   | `/linkedin-agent/fetch-profile`           | Fetch any LinkedIn profile by slug               | [Open](/docs/linkedin-api/fetch-profile)           |
| POST   | `/linkedin-agent/fetch-profiles-posts`    | Get posts from specific profiles by URN          | [Open](/docs/linkedin-api/fetch-profiles-posts)    |
| POST   | `/linkedin-agent/fetch-company`           | Fetch a LinkedIn company page                    | [Open](/docs/linkedin-api/fetch-company)           |
| POST   | `/linkedin-agent/fetch-company-posts`     | Get posts from specific companies                | [Open](/docs/linkedin-api/fetch-company-posts)     |
| POST   | `/linkedin-agent/search-profiles`         | Search LinkedIn for profiles by filters          | [Open](/docs/linkedin-api/search-profiles)         |
| POST   | `/linkedin-agent/fetch-connections`       | Fetch your 1st-degree connections                | [Open](/docs/linkedin-api/fetch-connections)       |
| POST   | `/linkedin-agent/like-post`               | Like a LinkedIn post                             | [Open](/docs/linkedin-api/like-post)               |
| POST   | `/linkedin-agent/comment-post`            | Comment on a LinkedIn post                       | [Open](/docs/linkedin-api/comment-post)            |
| POST   | `/linkedin-agent/send-message`            | Send a direct message to a 1st-degree connection | [Open](/docs/linkedin-api/send-message)            |
| POST   | `/linkedin-agent/send-connection-request` | Send a connection request                        | [Open](/docs/linkedin-api/send-connection-request) |
| GET    | `/linkedin-agent/get-task-status`         | Check the result of an async task                | [Open](/docs/linkedin-api/get-task-status)         |

See the full [LinkedIn Data section](/docs/linkedin-api/introduction) for details and quickstart.

***

## Base URL

All API requests should be made to:

```
https://api.outx.ai
```

## Authentication

All endpoints require an API key in the `x-api-key` header:

```bash theme={null}
x-api-key: YOUR_API_KEY
```

Get your API key at [mentions.outx.ai/api-doc](https://mentions.outx.ai/api-doc).

## Prerequisites

<Warning>
  **Chrome extension required:** At least one team member must have the OutX Chrome extension installed and active within the last 48 hours. Without this, API calls will return a `403` error. [Learn more about the extension →](/docs/resources/chrome-extension)
</Warning>

## Rate Limits

The HTTP API itself has no rate limit, you can read or write to OutX endpoints (watchlists, posts, interactions) as often as you want. What is capped is the **LinkedIn-side work** those calls trigger: keyword scans, profile fetches, likes, comments. LinkedIn enforces a per-action daily limit on each LinkedIn account, and it counts the same whether the action originated in the OutX dashboard or via the API.

For LinkedIn-action calls (`/linkedin-agent/*`, `/api-like`, `/api-comment`) keep combined volume under **\~50 calls per hour** and spread throughout the day. See [Rate Limits](/docs/api-reference/rate-limits) for the exact per-action caps and the live usage dashboard.

**API calls do not consume OutX credits.** Credits apply only to Sales Navigator export and the email finder.

## Getting Started

<Steps>
  <Step title="Get Your API Key">
    Visit [mentions.outx.ai/api-doc](https://mentions.outx.ai/api-doc) and click "Reveal API Key"
  </Step>

  <Step title="Install Chrome Extension">
    Install the [OutX Chrome Extension](https://chromewebstore.google.com/detail/outxai-track-linkedin-pos/epnimaeheelhgeelbppbfkjegklflakj) on at least one team member's browser
  </Step>

  <Step title="Make Your First Request">
    Follow the [Watchlist Quick Start](/docs/api-reference/quickstart) or the [LinkedIn Data Quick Start](/docs/linkedin-api/quickstart)
  </Step>
</Steps>

## Need Help?

<CardGroup cols={2}>
  <Card title="Watchlist Quick Start" icon="rocket" href="/docs/api-reference/quickstart">
    Create your first watchlist and retrieve posts
  </Card>

  <Card title="LinkedIn Data Quick Start" icon="bolt" href="/docs/linkedin-api/quickstart">
    Fetch your first LinkedIn profile in 2 minutes
  </Card>

  <Card title="Use Cases" icon="lightbulb" href="/docs/api-reference/use-cases">
    Common API workflows and patterns
  </Card>

  <Card title="Support" icon="envelope" href="mailto:support@outx.ai">
    Contact our team for help
  </Card>
</CardGroup>

***

## Learn More

* [LinkedIn API Guide - OutX Blog](https://www.outx.ai/blog/linkedin-api-guide)
* [LinkedIn Social Listening Platform](https://www.outx.ai/social-listening-linkedin)
* [OutX Chrome Extension](https://www.outx.ai/chrome-extension)

## Frequently Asked Questions

<AccordionGroup>
  <Accordion title="What is the difference between Watchlists and LinkedIn Data endpoints?">
    **Watchlists & Engagement** endpoints are for ongoing monitoring, you create watchlists (keyword, people, or company) and OutX continuously scans LinkedIn, enriches posts with AI categories and relevance scores. **LinkedIn Data** endpoints are for on-demand access, fetch a profile, get posts, like or comment as one-off async tasks. Use watchlists for continuous intelligence, and LinkedIn Data for direct lookups or AI agent integrations.
  </Accordion>

  <Accordion title="Do I need a paid plan to use the API?">
    API access is available on all plans, including the free plan. The HTTP API has no rate limit, but LinkedIn-side actions (keyword scans, profile fetches, likes, comments) are capped per LinkedIn account per day. See [Rate Limits](/docs/api-reference/rate-limits) for the per-action caps.
  </Accordion>

  <Accordion title="Do API calls consume my OutX Credits?">
    No. API calls (watchlists, posts, engagement, LinkedIn Data, all of it) are unlimited on every paid plan and do not draw down credits. **OutX Credits** are a separate currency used only for Sales Navigator export and the email finder, where 1 exported lead or 1 verified email = 1 credit. See [Pricing & Subscription](/docs/documentation/pricing-and-subscription) for credit allocations.
  </Accordion>

  <Accordion title="Is there a webhook for real-time notifications?">
    OutX does not currently offer webhooks. Use a polling pattern, periodically call `/api-posts` with `sort_by=recent` (the default) to check for new posts. You can also set up Slack notifications through the OutX UI. See the [Webhook-Style Monitoring](/docs/api-reference/use-cases#webhook-style-monitoring-polling-pattern) use case.
  </Accordion>
</AccordionGroup>