GET Posts API - Retrieve Watchlist Posts

GET Posts

Provide a Watchlist ID to retrieve the posts associated with one or more watchlists.

Once the request is processed, the response will include the watchlist details along with the corresponding posts.

Quick Set up Guide

To get your API KEY mail us support@outx.ai
Create a watchlist using the POST endpoint
Retrieve posts using the GET endpoint with your watchlist ID
Update watchlist settings as needed using the PUT endpoint
Like and Comment using Engagement APIs

Curl

curl -X GET "https://cafqluqomuhgtchexldv.supabase.co/functions/v1/api-posts?watchlist_id=<Watchlist_ID>"
  -H "x-api-key: YOUR_TEAM_API_KEY_HERE"

Multiple Watchlist_ID Curl

curl -X GET "https://cafqluqomuhgtchexldv.supabase.co/functions/v1/api-posts?watchlist_id=<Watchlist_ID1>,<Watchlist_ID2>,<Watchlist_ID3>&current_page=1&lang=true"
  -H "x-api-key: YOUR_TEAM_API_KEY_HERE"

Retrieve all posts from the team watchlist

curl -X GET "https://cafqluqomuhgtchexldv.supabase.co/functions/v1/api-posts"
  -H "x-api-key: YOUR_API_KEY"

Filter posts from all teams

curl -X GET "https://cafqluqomuhgtchexldv.supabase.co/functions/v1/api-posts?labels=AI Technology,Machine Learning"
  -H "x-api-key: YOUR_API_KEY"

Parameters

Required Parameters

Field Name	Type	Description
watchlist_id	string / array	Watchlist ID(s). Use comma-separated values for multiple IDs.

Optional Parameters

Field Name	Type	Description
current_page	number	Page number for pagination. Default: 1.
sort_by	string	Sort order. Allowed values: "recent_first", "popular_first".
is_saved	boolean	Filter for bookmarked posts only. Values: true, false.
lang	string	Language filter. Use "true" for English posts only.
start_date	string	Date range start. Format: YYYY-MM-DD.
end_date	string	Date range end. Format: YYYY-MM-DD.
post_type	string	Post type filter Values: person, company, job_update and birthday_update
trending	boolean	Filter for posts with 100+ likes. Values: true, false.
interacted	boolean	Filter for posts you've liked or commented on. Values: true, false.
seniority_level	string	Filter by author's seniority level.
labels	array	Filter by tags. Use comma-separated values. Special value: "no labels" for posts without tags.

Response

{
  "data": [
    {
      "id": "string",
      "linkedin_post_url": "string",
      "tracking_lists_id": "string",
      "content": "string",
      "image_url": "string",
      "image_text": "string",
      "author_name": "string",
      "author_url": "string",
      "created_at": "2024-01-01T00:00:00Z",
      "posted_at": "2024-01-01T00:00:00Z",
      "likes_count": 0,
      "shares_count": 0,
      "influence_score": 0,
      "sentiment": "string",
      "comments_count": 0,
      "bookmark": false,
      "post_type": "string",
      "language": "string",
      "tags": ["tag1", "tag2"],
      "commented": false,
      "author_headline": "string",
      "author_image_url": "string",
      "image_urls": ["url1", "url2"],
      "videos": null,
      "seniority_level": "string",
      "liked": false,
      "tagDescriptions": [
        {
          "tag": "string",
          "description": "string"
        }
      ]
    }
  ],
  "count": 100
}

Response Field

Field	Type	Description
data	array	Array of LinkedIn post objects returned in the response.
count	number	Total number of posts matching the query.

Inside data array (Post Object)

Field	Type	Description
id	string	Unique identifier for the post.
linkedin_post_url	string	Direct URL to the LinkedIn post.
tracking_lists_id	string	Identifier of the watchlist or tracking list associated with this post.
content	string	Text content of the post.
image_url	string	Primary image URL of the post (if any).
image_text	string	Extracted text from the post image (OCR).
author_name	string	Name of the author.
author_url	string	URL of the author’s LinkedIn profile.
created_at	string	Date/time when the record was created in the system (ISO 8601).
posted_at	string	Date/time when the post was published on LinkedIn (ISO 8601).
likes_count	number	Number of likes the post has received.
shares_count	number	Number of times the post has been shared.
influence_score	number	Calculated influence score for the post.
comments_count	number	Number of comments on the post.
bookmark	boolean	Whether the post is bookmarked by the user.
post_type	string	Type of post (text, image, video, etc.).
language	string	Language of the post.
tags	array	List of tags assigned to the post.
commented	boolean	Whether the authenticated user has commented on the post.
author_headline	string	Headline/job title of the post author.
author_image_url	string	Profile image URL of the author.
image_urls	array	List of all image URLs in the post.
videos	array/null	List of video URLs in the post (if any).
seniority_level	string	Seniority level of the post author.
liked	boolean	Whether the authenticated user has liked the post.
tagDescriptions	array	Array of tag objects with additional details.

Inside tagDescriptions array

Field	Type	Description
tag	string	The tag name.
description	string	Description of the tag.

Errors

Status Code	Error Message	Description
400	"Missing or invalid watchlist_id parameter"	The watchlist_id parameter is missing or invalid.
403	"Access denied: You don't have permission to access these watchlists"	User does not have permission to access the specified watchlist(s).
500	"Internal server error"	Generic server-side error occurred while processing the request. Contact support @OutXAI

For more information about the OutXAI API, feel free to contact us at support@outx.ai.

GET Posts API - Retrieve Watchlist Posts

GET Posts

Quick Set up Guide

Curl

Response

Errors

Related Documentation