---
updatedAt: 2026-04-28T15:27:08.000Z
agentTools:
projectIndex: https://developer.unipile.com/llms.txt
---
# List all posts
Returns a list of posts written by a user or a company.
# OpenAPI definition
```json
{
"openapi": "3.0.0",
"paths": {
"/api/v1/users/{identifier}/posts": {
"get": {
"operationId": "UsersController_listAllPosts",
"x-readme": {
"code-samples": [
{
"language": "node",
"code": "import { UnipileClient } from \"unipile-node-sdk\"\n\n// SDK setup\nconst BASE_URL = \"your base url\"\nconst ACCESS_TOKEN = \"your access token\"\n// Inputs\nconst account_id = \"account id\"\nconst identifier = \"identifier\"\n\ntry {\n\tconst client = new UnipileClient(BASE_URL, ACCESS_TOKEN)\n\n\tconst response = await client.users.getAllPosts({\n\t\taccount_id,\n\t\tidentifier,\n\t})\n} catch (error) {\n\tconsole.log(error)\n}\n",
"name": "unipile-node-sdk",
"install": "npm install unipile-node-sdk"
}
]
},
"summary": "List all posts",
"description": "Returns a list of posts written by a user or a company.",
"parameters": [
{
"name": "cursor",
"required": false,
"in": "query",
"schema": {
"title": "CursorParam",
"description": "A cursor for pagination purposes. To get the next page of entries, you need to make a new request and fulfill this field with the cursor received in the preceding request. This process should be repeated until all entries have been retrieved.",
"minLength": 1,
"type": "string"
}
},
{
"name": "limit",
"required": false,
"in": "query",
"schema": {
"minimum": 1,
"maximum": 100,
"description": "A limit for the number of items returned in the response. The value can be set between 1 and 100.",
"example": 100,
"type": "integer"
}
},
{
"name": "is_company",
"required": false,
"in": "query",
"description": "`Linkedin only` Set it to **\"true\"** if the posts are from a company.",
"schema": {
"type": "boolean"
}
},
{
"name": "account_id",
"required": true,
"in": "query",
"description": "The id of the account to perform the request from.",
"schema": {
"type": "string"
}
},
{
"name": "identifier",
"required": true,
"in": "path",
"description": "The entity's provider internal id.
`Linkedin`: starts with ACo/ADo for users, while for companies it's a series of numbers.
`Instagram`: use the provider_id or the username of the user.",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK. Request succeeded.",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"object": {
"type": "string",
"enum": [
"PostList"
]
},
"items": {
"type": "array",
"items": {
"allOf": [
{
"anyOf": [
{
"type": "object",
"properties": {
"provider": {
"type": "string",
"enum": [
"LINKEDIN"
]
},
"id": {
"title": "UniqueId",
"description": "A unique identifier.",
"minLength": 1,
"type": "string"
},
"social_id": {
"description": "A unique identifier to be used to add a comment or a reaction to the post.",
"type": "string"
},
"share_url": {
"type": "string"
},
"title": {
"type": "string"
},
"text": {
"type": "string"
},
"date": {
"type": "string"
},
"parsed_datetime": {
"type": "string"
},
"reaction_counter": {
"type": "number"
},
"comment_counter": {
"type": "number"
},
"repost_counter": {
"type": "number"
},
"impressions_counter": {
"type": "number"
},
"user_reacted": {
"type": "string",
"enum": [
"LIKE",
"PRAISE",
"APPRECIATION",
"EMPATHY",
"INTEREST",
"ENTERTAINMENT"
]
},
"author": {
"type": "object",
"properties": {
"public_identifier": {
"anyOf": [
{
"type": "string"
},
{
"nullable": true
}
]
},
"id": {
"anyOf": [
{
"type": "string"
},
{
"nullable": true
}
]
},
"name": {
"anyOf": [
{
"type": "string"
},
{
"nullable": true
}
]
},
"is_company": {
"type": "boolean"
},
"headline": {
"type": "string"
},
"profile_picture_url": {
"type": "string"
}
},
"required": [
"public_identifier",
"id",
"name",
"is_company"
]
},
"written_by": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"public_identifier": {
"type": "string"
},
"name": {
"type": "string"
}
},
"required": [
"id",
"public_identifier",
"name"
]
},
"permissions": {
"type": "object",
"properties": {
"can_react": {
"type": "boolean"
},
"can_share": {
"type": "boolean"
},
"can_post_comments": {
"type": "boolean"
}
},
"required": [
"can_react",
"can_share",
"can_post_comments"
]
},
"is_repost": {
"type": "boolean"
},
"repost_id": {
"description": "The republication ID.",
"type": "string"
},
"repost_parsed_datetime": {
"type": "string"
},
"reposted_by": {
"type": "object",
"properties": {
"public_identifier": {
"anyOf": [
{
"type": "string"
},
{
"nullable": true
}
]
},
"id": {
"anyOf": [
{
"type": "string"
},
{
"nullable": true
}
]
},
"name": {
"anyOf": [
{
"type": "string"
},
{
"nullable": true
}
]
},
"is_company": {
"type": "boolean"
},
"headline": {
"type": "string"
},
"profile_picture_url": {
"type": "string"
}
},
"required": [
"public_identifier",
"id",
"name",
"is_company"
]
},
"repost_content": {
"description": "The post shared in the current publication.",
"type": "object",
"properties": {
"id": {
"title": "UniqueId",
"description": "A unique identifier.",
"minLength": 1,
"type": "string"
},
"date": {
"type": "string"
},
"parsed_datetime": {
"type": "string"
},
"attachments": {
"type": "array",
"items": {
"anyOf": [
{
"type": "object",
"properties": {
"id": {
"type": "string"
},
"file_size": {
"type": "number"
},
"unavailable": {
"type": "boolean"
},
"mimetype": {
"type": "string"
},
"url": {
"type": "string"
},
"url_expires_at": {
"type": "number"
},
"type": {
"type": "string",
"enum": [
"img"
]
},
"size": {
"type": "object",
"properties": {
"width": {
"type": "number"
},
"height": {
"type": "number"
}
},
"required": [
"width",
"height"
]
},
"sticker": {
"type": "boolean"
}
},
"required": [
"id",
"unavailable",
"type",
"size",
"sticker"
]
},
{
"type": "object",
"properties": {
"id": {
"type": "string"
},
"file_size": {
"type": "number"
},
"unavailable": {
"type": "boolean"
},
"mimetype": {
"type": "string"
},
"url": {
"type": "string"
},
"url_expires_at": {
"type": "number"
},
"type": {
"type": "string",
"enum": [
"video"
]
},
"size": {
"type": "object",
"properties": {
"width": {
"type": "number"
},
"height": {
"type": "number"
}
},
"required": [
"width",
"height"
]
},
"gif": {
"type": "boolean"
}
},
"required": [
"id",
"unavailable",
"type",
"size",
"gif"
]
},
{
"type": "object",
"properties": {
"id": {
"type": "string"
},
"file_size": {
"type": "number"
},
"unavailable": {
"type": "boolean"
},
"mimetype": {
"type": "string"
},
"url": {
"type": "string"
},
"url_expires_at": {
"type": "number"
},
"type": {
"type": "string",
"enum": [
"audio"
]
},
"duration": {
"type": "number"
},
"voice_note": {
"type": "boolean"
}
},
"required": [
"id",
"unavailable",
"type",
"voice_note"
]
},
{
"type": "object",
"properties": {
"id": {
"type": "string"
},
"file_size": {
"type": "number"
},
"unavailable": {
"type": "boolean"
},
"mimetype": {
"type": "string"
},
"url": {
"type": "string"
},
"url_expires_at": {
"type": "number"
},
"type": {
"type": "string",
"enum": [
"file"
]
},
"file_name": {
"type": "string"
}
},
"required": [
"id",
"unavailable",
"type",
"file_name"
]
},
{
"type": "object",
"properties": {
"id": {
"type": "string"
},
"file_size": {
"type": "number"
},
"unavailable": {
"type": "boolean"
},
"mimetype": {
"type": "string"
},
"url": {
"type": "string"
},
"url_expires_at": {
"type": "number"
},
"type": {
"type": "string",
"enum": [
"linkedin_post"
]
}
},
"required": [
"id",
"unavailable",
"type"
]
},
{
"type": "object",
"properties": {
"id": {
"type": "string"
},
"file_size": {
"type": "number"
},
"unavailable": {
"type": "boolean"
},
"mimetype": {
"type": "string"
},
"url": {
"type": "string"
},
"url_expires_at": {
"type": "number"
},
"type": {
"type": "string",
"enum": [
"video_meeting"
]
},
"starts_at": {
"anyOf": [
{
"type": "number"
},
{
"nullable": true
}
]
},
"expires_at": {
"anyOf": [
{
"type": "number"
},
{
"nullable": true
}
]
},
"time_range": {
"anyOf": [
{
"type": "number"
},
{
"nullable": true
}
]
}
},
"required": [
"id",
"unavailable",
"type",
"starts_at",
"expires_at",
"time_range"
]
},
{
"type": "object",
"properties": {
"id": {
"type": "string"
},
"file_size": {
"type": "number"
},
"unavailable": {
"type": "boolean"
},
"mimetype": {
"type": "string"
},
"url": {
"type": "string"
},
"url_expires_at": {
"type": "number"
},
"type": {
"type": "string",
"enum": [
"media_share"
]
},
"post": {
"type": "object",
"properties": {
"url": {
"type": "string"
},
"author": {
"type": "string"
},
"author_id": {
"type": "string"
},
"author_messaging_id": {
"type": "string"
},
"description": {
"type": "string"
}
},
"required": [
"url"
]
},
"story": {
"type": "object",
"properties": {
"url": {
"type": "string"
},
"author": {
"type": "string"
}
},
"required": [
"url"
]
},
"cta": {
"type": "object",
"properties": {
"text": {
"type": "string"
},
"type": {
"type": "string"
},
"url": {
"type": "string"
}
},
"required": [
"text",
"type"
]
},
"link": {
"type": "object",
"properties": {
"text": {
"type": "string"
},
"url": {
"type": "string"
},
"title": {
"type": "string"
},
"summary": {
"type": "string"
},
"image_url": {
"type": "string"
}
},
"required": [
"text",
"url",
"title",
"summary",
"image_url"
]
},
"video_call": {
"type": "object",
"properties": {
"type": {
"type": "string"
},
"description": {
"type": "string"
},
"duration": {
"type": "number"
},
"start_time": {
"type": "number"
},
"end_time": {
"type": "number"
}
},
"required": [
"type",
"description",
"duration",
"start_time",
"end_time"
]
}
},
"required": [
"id",
"unavailable",
"type"
]
},
{
"type": "object",
"properties": {
"id": {
"type": "string"
},
"file_size": {
"type": "number"
},
"unavailable": {
"type": "boolean"
},
"mimetype": {
"type": "string"
},
"url": {
"type": "string"
},
"url_expires_at": {
"type": "number"
},
"type": {
"type": "string",
"enum": [
"profile"
]
},
"profile": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"profile_pic_url": {
"type": "string"
},
"is_verified": {
"type": "boolean"
},
"username": {
"type": "string"
},
"full_name": {
"type": "string"
},
"is_private": {
"type": "boolean"
},
"instagram_messaging_id": {
"type": "string"
}
},
"required": [
"id",
"profile_pic_url",
"is_verified",
"username",
"full_name",
"is_private"
]
}
},
"required": [
"id",
"unavailable",
"type",
"profile"
]
},
{
"type": "object",
"properties": {
"id": {
"type": "string"
},
"file_size": {
"type": "number"
},
"unavailable": {
"type": "boolean"
},
"mimetype": {
"type": "string"
},
"url": {
"type": "string"
},
"url_expires_at": {
"type": "number"
},
"type": {
"type": "string",
"enum": [
"contact_card"
]
},
"display_name": {
"anyOf": [
{
"type": "string"
},
{
"nullable": true
}
]
},
"phones": {
"type": "array",
"items": {
"type": "object",
"properties": {
"number": {
"type": "string"
},
"type": {
"type": "string"
}
},
"required": [
"number"
]
}
},
"emails": {
"type": "array",
"items": {
"type": "object",
"properties": {
"address": {
"type": "string"
},
"type": {
"type": "string"
}
},
"required": [
"address"
]
}
},
"organization": {
"anyOf": [
{
"type": "string"
},
{
"nullable": true
}
]
}
},
"required": [
"id",
"unavailable",
"type",
"display_name",
"phones",
"emails",
"organization"
]
},
{
"type": "object",
"properties": {
"id": {
"type": "string"
},
"file_size": {
"type": "number"
},
"unavailable": {
"type": "boolean"
},
"mimetype": {
"type": "string"
},
"url": {
"type": "string"
},
"url_expires_at": {
"type": "number"
},
"type": {
"type": "string",
"enum": [
"poll"
]
},
"poll": {
"type": "object",
"properties": {
"question": {
"type": "string"
},
"options": {
"type": "array",
"items": {
"type": "object",
"properties": {
"text": {
"type": "string"
},
"voter_count": {
"type": "number"
}
},
"required": [
"text",
"voter_count"
]
}
},
"description": {
"anyOf": [
{
"type": "string"
},
{
"nullable": true
}
]
},
"type": {
"anyOf": [
{
"type": "string",
"enum": [
"regular"
]
},
{
"type": "string",
"enum": [
"quiz"
]
}
]
},
"is_anonymous": {
"type": "boolean"
},
"allows_multiple_answers": {
"type": "boolean"
}
},
"required": [
"question",
"options",
"description",
"type",
"is_anonymous",
"allows_multiple_answers"
]
}
},
"required": [
"id",
"unavailable",
"type",
"poll"
]
}
]
}
},
"author": {
"type": "object",
"properties": {
"public_identifier": {
"anyOf": [
{
"type": "string"
},
{
"nullable": true
}
]
},
"id": {
"anyOf": [
{
"type": "string"
},
{
"nullable": true
}
]
},
"name": {
"anyOf": [
{
"type": "string"
},
{
"nullable": true
}
]
},
"is_company": {
"type": "boolean"
},
"headline": {
"type": "string"
},
"profile_picture_url": {
"type": "string"
}
},
"required": [
"public_identifier",
"id",
"name",
"is_company"
]
},
"text": {
"type": "string"
}
},
"required": [
"id",
"date",
"parsed_datetime",
"attachments",
"author",
"text"
]
},
"mentions": {
"type": "array",
"items": {
"type": "object",
"properties": {
"url": {
"type": "string"
},
"start": {
"type": "number"
},
"length": {
"type": "number"
}
},
"required": [
"url",
"start",
"length"
]
}
},
"attachments": {
"type": "array",
"items": {
"anyOf": [
{
"type": "object",
"properties": {
"id": {
"type": "string"
},
"file_size": {
"type": "number"
},
"unavailable": {
"type": "boolean"
},
"mimetype": {
"type": "string"
},
"url": {
"type": "string"
},
"url_expires_at": {
"type": "number"
},
"type": {
"type": "string",
"enum": [
"img"
]
},
"size": {
"type": "object",
"properties": {
"width": {
"type": "number"
},
"height": {
"type": "number"
}
},
"required": [
"width",
"height"
]
},
"sticker": {
"type": "boolean"
}
},
"required": [
"id",
"unavailable",
"type",
"size",
"sticker"
]
},
{
"type": "object",
"properties": {
"id": {
"type": "string"
},
"file_size": {
"type": "number"
},
"unavailable": {
"type": "boolean"
},
"mimetype": {
"type": "string"
},
"url": {
"type": "string"
},
"url_expires_at": {
"type": "number"
},
"type": {
"type": "string",
"enum": [
"video"
]
},
"size": {
"type": "object",
"properties": {
"width": {
"type": "number"
},
"height": {
"type": "number"
}
},
"required": [
"width",
"height"
]
},
"gif": {
"type": "boolean"
}
},
"required": [
"id",
"unavailable",
"type",
"size",
"gif"
]
},
{
"type": "object",
"properties": {
"id": {
"type": "string"
},
"file_size": {
"type": "number"
},
"unavailable": {
"type": "boolean"
},
"mimetype": {
"type": "string"
},
"url": {
"type": "string"
},
"url_expires_at": {
"type": "number"
},
"type": {
"type": "string",
"enum": [
"audio"
]
},
"duration": {
"type": "number"
},
"voice_note": {
"type": "boolean"
}
},
"required": [
"id",
"unavailable",
"type",
"voice_note"
]
},
{
"type": "object",
"properties": {
"id": {
"type": "string"
},
"file_size": {
"type": "number"
},
"unavailable": {
"type": "boolean"
},
"mimetype": {
"type": "string"
},
"url": {
"type": "string"
},
"url_expires_at": {
"type": "number"
},
"type": {
"type": "string",
"enum": [
"file"
]
},
"file_name": {
"type": "string"
}
},
"required": [
"id",
"unavailable",
"type",
"file_name"
]
},
{
"type": "object",
"properties": {
"id": {
"type": "string"
},
"file_size": {
"type": "number"
},
"unavailable": {
"type": "boolean"
},
"mimetype": {
"type": "string"
},
"url": {
"type": "string"
},
"url_expires_at": {
"type": "number"
},
"type": {
"type": "string",
"enum": [
"linkedin_post"
]
}
},
"required": [
"id",
"unavailable",
"type"
]
},
{
"type": "object",
"properties": {
"id": {
"type": "string"
},
"file_size": {
"type": "number"
},
"unavailable": {
"type": "boolean"
},
"mimetype": {
"type": "string"
},
"url": {
"type": "string"
},
"url_expires_at": {
"type": "number"
},
"type": {
"type": "string",
"enum": [
"video_meeting"
]
},
"starts_at": {
"anyOf": [
{
"type": "number"
},
{
"nullable": true
}
]
},
"expires_at": {
"anyOf": [
{
"type": "number"
},
{
"nullable": true
}
]
},
"time_range": {
"anyOf": [
{
"type": "number"
},
{
"nullable": true
}
]
}
},
"required": [
"id",
"unavailable",
"type",
"starts_at",
"expires_at",
"time_range"
]
},
{
"type": "object",
"properties": {
"id": {
"type": "string"
},
"file_size": {
"type": "number"
},
"unavailable": {
"type": "boolean"
},
"mimetype": {
"type": "string"
},
"url": {
"type": "string"
},
"url_expires_at": {
"type": "number"
},
"type": {
"type": "string",
"enum": [
"media_share"
]
},
"post": {
"type": "object",
"properties": {
"url": {
"type": "string"
},
"author": {
"type": "string"
},
"author_id": {
"type": "string"
},
"author_messaging_id": {
"type": "string"
},
"description": {
"type": "string"
}
},
"required": [
"url"
]
},
"story": {
"type": "object",
"properties": {
"url": {
"type": "string"
},
"author": {
"type": "string"
}
},
"required": [
"url"
]
},
"cta": {
"type": "object",
"properties": {
"text": {
"type": "string"
},
"type": {
"type": "string"
},
"url": {
"type": "string"
}
},
"required": [
"text",
"type"
]
},
"link": {
"type": "object",
"properties": {
"text": {
"type": "string"
},
"url": {
"type": "string"
},
"title": {
"type": "string"
},
"summary": {
"type": "string"
},
"image_url": {
"type": "string"
}
},
"required": [
"text",
"url",
"title",
"summary",
"image_url"
]
},
"video_call": {
"type": "object",
"properties": {
"type": {
"type": "string"
},
"description": {
"type": "string"
},
"duration": {
"type": "number"
},
"start_time": {
"type": "number"
},
"end_time": {
"type": "number"
}
},
"required": [
"type",
"description",
"duration",
"start_time",
"end_time"
]
}
},
"required": [
"id",
"unavailable",
"type"
]
},
{
"type": "object",
"properties": {
"id": {
"type": "string"
},
"file_size": {
"type": "number"
},
"unavailable": {
"type": "boolean"
},
"mimetype": {
"type": "string"
},
"url": {
"type": "string"
},
"url_expires_at": {
"type": "number"
},
"type": {
"type": "string",
"enum": [
"profile"
]
},
"profile": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"profile_pic_url": {
"type": "string"
},
"is_verified": {
"type": "boolean"
},
"username": {
"type": "string"
},
"full_name": {
"type": "string"
},
"is_private": {
"type": "boolean"
},
"instagram_messaging_id": {
"type": "string"
}
},
"required": [
"id",
"profile_pic_url",
"is_verified",
"username",
"full_name",
"is_private"
]
}
},
"required": [
"id",
"unavailable",
"type",
"profile"
]
},
{
"type": "object",
"properties": {
"id": {
"type": "string"
},
"file_size": {
"type": "number"
},
"unavailable": {
"type": "boolean"
},
"mimetype": {
"type": "string"
},
"url": {
"type": "string"
},
"url_expires_at": {
"type": "number"
},
"type": {
"type": "string",
"enum": [
"contact_card"
]
},
"display_name": {
"anyOf": [
{
"type": "string"
},
{
"nullable": true
}
]
},
"phones": {
"type": "array",
"items": {
"type": "object",
"properties": {
"number": {
"type": "string"
},
"type": {
"type": "string"
}
},
"required": [
"number"
]
}
},
"emails": {
"type": "array",
"items": {
"type": "object",
"properties": {
"address": {
"type": "string"
},
"type": {
"type": "string"
}
},
"required": [
"address"
]
}
},
"organization": {
"anyOf": [
{
"type": "string"
},
{
"nullable": true
}
]
}
},
"required": [
"id",
"unavailable",
"type",
"display_name",
"phones",
"emails",
"organization"
]
},
{
"type": "object",
"properties": {
"id": {
"type": "string"
},
"file_size": {
"type": "number"
},
"unavailable": {
"type": "boolean"
},
"mimetype": {
"type": "string"
},
"url": {
"type": "string"
},
"url_expires_at": {
"type": "number"
},
"type": {
"type": "string",
"enum": [
"poll"
]
},
"poll": {
"type": "object",
"properties": {
"question": {
"type": "string"
},
"options": {
"type": "array",
"items": {
"type": "object",
"properties": {
"text": {
"type": "string"
},
"voter_count": {
"type": "number"
}
},
"required": [
"text",
"voter_count"
]
}
},
"description": {
"anyOf": [
{
"type": "string"
},
{
"nullable": true
}
]
},
"type": {
"anyOf": [
{
"type": "string",
"enum": [
"regular"
]
},
{
"type": "string",
"enum": [
"quiz"
]
}
]
},
"is_anonymous": {
"type": "boolean"
},
"allows_multiple_answers": {
"type": "boolean"
}
},
"required": [
"question",
"options",
"description",
"type",
"is_anonymous",
"allows_multiple_answers"
]
}
},
"required": [
"id",
"unavailable",
"type",
"poll"
]
}
]
}
},
"poll": {
"type": "object",
"properties": {
"id": {
"title": "UniqueId",
"description": "A unique identifier.",
"minLength": 1,
"type": "string"
},
"total_votes_count": {
"type": "number"
},
"question": {
"type": "string"
},
"is_open": {
"type": "boolean"
},
"options": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"title": "UniqueId",
"description": "A unique identifier.",
"minLength": 1,
"type": "string"
},
"text": {
"type": "string"
},
"win": {
"type": "boolean"
},
"votes_count": {
"type": "number"
}
},
"required": [
"id",
"text",
"win",
"votes_count"
]
}
}
},
"required": [
"id",
"total_votes_count",
"question",
"is_open",
"options"
]
},
"group": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"name": {
"type": "string"
},
"private": {
"type": "boolean"
}
},
"required": [
"id",
"name",
"private"
]
},
"job_posting": {
"type": "object",
"properties": {
"id": {
"anyOf": [
{
"type": "string"
},
{
"nullable": true
}
]
},
"title": {
"type": "string"
},
"location": {
"type": "string"
},
"company": {
"type": "object",
"properties": {
"id": {
"anyOf": [
{
"type": "string"
},
{
"nullable": true
}
]
},
"name": {
"anyOf": [
{
"type": "string"
},
{
"nullable": true
}
]
},
"picture_url": {
"type": "string"
}
},
"required": [
"id",
"name"
]
}
},
"required": [
"id",
"title",
"location",
"company"
]
},
"article": {
"type": "object",
"properties": {
"id": {
"anyOf": [
{
"type": "string"
},
{
"nullable": true
}
]
},
"title": {
"type": "string"
},
"url": {
"type": "string"
},
"author": {
"type": "string"
},
"published_at": {
"type": "string"
},
"excerpt": {
"type": "string"
},
"picture_url": {
"type": "string"
}
},
"required": [
"id",
"title"
]
},
"analytics": {
"type": "object",
"properties": {
"impressions": {
"type": "number"
},
"engagements": {
"type": "number"
},
"engagement_rate": {
"type": "number"
},
"clicks": {
"type": "number"
},
"clickthrough_rate": {
"type": "number"
},
"page_viewers_from_this_post": {
"type": "number"
},
"followers_gained_from_this_post": {
"type": "number"
},
"members_reached": {
"type": "number"
}
}
}
},
"required": [
"provider",
"id",
"social_id",
"share_url",
"text",
"date",
"parsed_datetime",
"reaction_counter",
"comment_counter",
"repost_counter",
"impressions_counter",
"author",
"permissions",
"is_repost",
"mentions",
"attachments"
]
},
{
"type": "object",
"properties": {
"provider": {
"type": "string",
"enum": [
"INSTAGRAM"
]
},
"provider_id": {
"type": "string"
},
"has_audio": {
"type": "boolean"
},
"has_liked": {
"type": "boolean"
},
"like_count": {
"type": "number"
},
"comment_count": {
"type": "number"
},
"like_and_view_counts_disabled": {
"type": "boolean"
},
"comments_disabled": {
"anyOf": [
{
"type": "boolean"
},
{
"nullable": true
}
]
},
"accessibility_caption": {
"anyOf": [
{
"type": "string"
},
{
"nullable": true
}
]
},
"caption": {
"type": "object",
"properties": {
"edited": {
"type": "boolean"
},
"has_translation": {
"type": "boolean"
},
"created_at": {
"type": "number"
},
"text": {
"type": "string"
}
},
"required": [
"edited",
"has_translation",
"created_at",
"text"
]
},
"video": {
"type": "object",
"properties": {
"url": {
"type": "string"
},
"width": {
"type": "number"
},
"height": {
"type": "number"
}
},
"required": [
"url",
"width",
"height"
]
},
"preview_image": {
"type": "object",
"properties": {
"url": {
"type": "string"
},
"width": {
"type": "number"
},
"height": {
"type": "number"
}
},
"required": [
"url",
"width",
"height"
]
},
"owner": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"username": {
"type": "string"
},
"profile_pic_url": {
"type": "string"
},
"is_verified": {
"type": "boolean"
},
"is_private": {
"type": "boolean"
}
},
"required": [
"id",
"username",
"profile_pic_url",
"is_verified",
"is_private"
]
},
"location": {
"anyOf": [
{
"type": "object",
"properties": {
"name": {
"type": "string"
},
"lat": {
"type": "number"
},
"lng": {
"type": "number"
}
},
"required": [
"name",
"lat",
"lng"
]
},
{
"nullable": true
}
]
}
},
"required": [
"provider",
"provider_id",
"has_audio",
"has_liked",
"like_count",
"comment_count",
"like_and_view_counts_disabled",
"comments_disabled",
"accessibility_caption",
"preview_image",
"owner",
"location"
]
}
]
},
{
"type": "object",
"properties": {
"object": {
"type": "string",
"enum": [
"Post"
]
}
},
"required": [
"object"
]
}
]
}
},
"cursor": {
"anyOf": [
{
"type": "string"
},
{
"nullable": true
}
]
},
"paging": {
"type": "object",
"properties": {
"page_count": {
"type": "number"
}
},
"required": [
"page_count"
]
}
},
"required": [
"object",
"items",
"cursor",
"paging"
]
}
}
}
},
"401": {
"description": "## Unauthorized\n\n### Missing credentials - Type: \"errors/missing_credentials\"\nSome credentials are necessary to perform the request.\n\n### Multiple sessions - Type: \"errors/multiple_sessions\"\nLinkedIn limits the use of multiple sessions on certain Recruiter accounts. This error restricts access to this route only, but causing a popup to appear in the user's browser, prompting them to choose a session, which can disconnect the current account. To avoid this error, use the cookie connection method.\n\n### Wrong account - Type: \"errors/wrong_account\"\nThe provided credentials do not match the correct account.\n\n### Invalid credentials - Type: \"errors/invalid_credentials\"\nThe provided credentials are invalid.\n\n### Invalid proxy credentials - Type: \"errors/invalid_proxy_credentials\"\nThe provided proxy credentials are invalid.\n\n### Invalid IMAP configuration - Type: \"errors/invalid_imap_configuration\"\nThe provided IMAP configuration is invalid.\n\n### Invalid SMTP configuration - Type: \"errors/invalid_smtp_configuration\"\nThe provided SMTP configuration is invalid.\n\n### Invalid checkpoint solution - Type: \"errors/invalid_checkpoint_solution\"\nThe checkpoint resolution did not pass successfully. Please retry.\n\n### Checkpoint error - Type: \"errors/checkpoint_error\"\nThe checkpoint does not appear to be resolvable. Please try again and contact support if the problem persists.\n\n### Expired credentials - Type: \"errors/expired_credentials\"\nInvalid credentials. Please check your username and password and try again.\n\n### Expired link - Type: \"errors/expired_link\"\nThis link has expired. Please return to the application and generate a new one.\n\n### Insufficient privileges - Type: \"errors/insufficient_privileges\"\nThis resource seems to be out of your scopes.\n\n### Disconnected account - Type: \"errors/disconnected_account\"\nThe account appears to be disconnected from the provider service.\n\n### Disconnected feature - Type: \"errors/disconnected_feature\"\nThe service you're trying to reach appears to be disconnected.",
"content": {
"application/json": {
"schema": {
"title": "UnauthorizedResponse",
"type": "object",
"properties": {
"title": {
"type": "string"
},
"detail": {
"type": "string"
},
"instance": {
"type": "string"
},
"type": {
"type": "string",
"enum": [
"errors/missing_credentials",
"errors/multiple_sessions",
"errors/invalid_checkpoint_solution",
"errors/invalid_proxy_credentials",
"errors/checkpoint_error",
"errors/invalid_credentials",
"errors/expired_credentials",
"errors/insufficient_privileges",
"errors/disconnected_account",
"errors/disconnected_feature",
"errors/invalid_credentials_but_valid_account_imap",
"errors/expired_link",
"errors/wrong_account"
]
},
"status": {
"type": "number",
"enum": [
401
]
},
"connectionParams": {
"type": "object",
"properties": {
"imap_host": {
"type": "string"
},
"imap_encryption": {
"type": "string"
},
"imap_port": {
"type": "number"
},
"imap_user": {
"type": "string"
},
"smtp_host": {
"type": "string"
},
"smtp_port": {
"type": "number"
},
"smtp_user": {
"type": "string"
}
},
"required": [
"imap_host",
"imap_port",
"imap_user",
"smtp_host",
"smtp_port",
"smtp_user"
]
}
},
"required": [
"title",
"type",
"status"
]
}
}
}
},
"403": {
"description": "## Forbidden\n\n### Insufficient permissions - Type: \"errors/insufficient_permissions\"\nValid authentication but insufficient permissions to perform the request.\n\n### Account restricted - Type: \"errors/account_restricted\"\nAccess to this account has been restricted. Please sign in to the provider service to learn more about how to unlock your account.\n\n### Account mismatch - Type: \"errors/account_mismatch\"\nThis action cannot be done with your account.\n\n### Unknown authentication context - Type: \"errors/unknown_authentication_context\"\nAn additional step seems necessary to complete login. Please connect to provider with your browser to find out more, then retry authentication.\n\n### Session mismatch - Type: \"errors/session_mismatch\"\nToken User id does not match client session id.\n\n### Feature not subscribed - Type: \"errors/feature_not_subscribed\"\nThe requested feature has either not been subscribed or not been authenticated properly.\n\n### Subscription required - Type: \"errors/subscription_required\"\nThe action you're trying to achieve requires a subscription to provider's services.\n\n### Resource access restricted - Type: \"errors/resource_access_restricted\"\nYou don't have access to this resource.\n\n### Action required - Type: \"errors/action_required\"\nAn additional step seems necessary. Complete authentication on the provider's native application and try again.",
"content": {
"application/json": {
"schema": {
"title": "ForbiddenResponse",
"type": "object",
"properties": {
"title": {
"type": "string"
},
"detail": {
"type": "string"
},
"instance": {
"type": "string"
},
"type": {
"type": "string",
"enum": [
"errors/account_restricted",
"errors/account_mismatch",
"errors/insufficient_permissions",
"errors/session_mismatch",
"errors/feature_not_subscribed",
"errors/subscription_required",
"errors/unknown_authentication_context",
"errors/action_required",
"errors/resource_access_restricted"
]
},
"status": {
"type": "number",
"enum": [
403
]
}
},
"required": [
"title",
"type",
"status"
]
}
}
}
},
"422": {
"description": "\n ## Unprocessable Entity\n ### Recipient cannot be reached\n Make sure that the recipient ID is valid and that the corresponding profile is not locked.\nundefined",
"content": {
"application/json": {
"schema": {
"title": "UnprocessableEntityResponseSchema",
"type": "object",
"properties": {
"title": {
"type": "string"
},
"detail": {
"type": "string"
},
"instance": {
"type": "string"
},
"type": {
"type": "string",
"enum": [
"errors/invalid_account",
"errors/invalid_recipient",
"errors/no_connection_with_recipient",
"errors/blocked_recipient",
"errors/user_unreachable",
"errors/unprocessable_entity",
"errors/payment_error",
"errors/action_already_performed",
"errors/invalid_message",
"errors/invalid_post",
"errors/not_allowed_inmail",
"errors/insufficient_credits",
"errors/cannot_resend_yet",
"errors/cannot_resend_within_24hrs",
"errors/limit_exceeded",
"errors/connection_limit_reached",
"errors/already_invited_recently",
"errors/already_connected",
"errors/cannot_invite_attendee",
"errors/parent_mail_not_found",
"errors/parent_mail_invalid_provider_id",
"errors/invalid_reply_subject",
"errors/invalid_headers",
"errors/send_as_denied",
"errors/invalid_folder",
"errors/invalid_thread",
"errors/unauthorized",
"errors/sender_rejected",
"errors/recipient_rejected",
"errors/ip_rejected_by_server",
"errors/provider_unreachable",
"errors/account_configuration_error",
"errors/cant_send_message",
"errors/realtime_client_not_initialized",
"errors/comments_disabled",
"errors/insufficient_job_slot",
"errors/not_supported_by_provider"
]
},
"status": {
"type": "number",
"enum": [
422
]
}
},
"required": [
"title",
"type",
"status"
]
}
}
}
},
"500": {
"description": "## Internal Server Error\n\n### Unexpected error - Type: \"errors/unexpected_error\"\nSomething went wrong. {{moreDetails}}\n\n### Provider error - Type: \"errors/provider_error\"\nThe provider is experiencing operational problems. Please try again later.\n\n### Authentication intent error - Type: \"errors/authentication_intent_error\"\nThe current authentication intent was killed after failure. Please start the process again from the beginning.",
"content": {
"application/json": {
"schema": {
"title": "InternalServerErrorResponse",
"type": "object",
"properties": {
"title": {
"type": "string"
},
"detail": {
"type": "string"
},
"instance": {
"type": "string"
},
"type": {
"type": "string",
"enum": [
"errors/unexpected_error",
"errors/provider_error",
"errors/authentication_intent_error"
]
},
"status": {
"type": "number",
"enum": [
500
]
}
},
"required": [
"title",
"type",
"status"
]
}
}
}
},
"503": {
"description": "## Service Unavailable\n\n### No client session - Type: \"errors/no_client_session\"\nNo client session is currently running.\n\n### No channel - Type: \"errors/no_channel\"\nNo channel to client session.\n\n### Handler missing - Type: \"errors/no_handler\"\nHandler missing for that request.\n\n### Network down - Type: \"errors/network_down\"\nNetwork is down on server side. Please wait a moment and retry.\n\n### Service unavailable - Type: \"errors/service_unavailable\"\nPlease try again later.",
"content": {
"application/json": {
"schema": {
"title": "ServiceUnavailableResponse",
"type": "object",
"properties": {
"title": {
"type": "string"
},
"detail": {
"type": "string"
},
"instance": {
"type": "string"
},
"type": {
"type": "string",
"enum": [
"errors/no_client_session",
"errors/no_channel",
"errors/no_handler",
"errors/network_down",
"errors/service_unavailable"
]
},
"status": {
"type": "number",
"enum": [
503
]
}
},
"required": [
"title",
"type",
"status"
]
}
}
}
},
"504": {
"description": "## Gateway Timeout\n\n### Request timed out - Type: \"errors/request_timeout\"\nRequest Timeout. Please try again, and if the issue persists, contact support.",
"content": {
"application/json": {
"schema": {
"title": "GatewayTimeoutResponse",
"type": "object",
"properties": {
"title": {
"type": "string"
},
"detail": {
"type": "string"
},
"instance": {
"type": "string"
},
"type": {
"type": "string",
"enum": [
"errors/request_timeout"
]
},
"status": {
"type": "number",
"enum": [
504
]
}
},
"required": [
"title",
"type",
"status"
]
}
}
}
}
},
"tags": [
"Users"
],
"security": [
{
"Access-Token": []
}
]
}
}
},
"info": {
"title": "Unipile API Reference",
"description": "Unipile Communication is an **HTTP API**. It has predictable resource-oriented `URLs`, accepts **form-encoded** or **JSON-encoded** request bodies, returns **JSON-encoded responses**, and uses standard HTTP response codes, authentication, and verbs.",
"version": "1.0",
"contact": {}
},
"tags": [
{
"name": "Users",
"description": "Users features"
}
],
"servers": [
{
"url": "https://{subdomain}.unipile.com:{port}",
"description": "live server",
"variables": {
"subdomain": {
"default": "api1"
},
"port": {
"default": "13111"
}
}
},
{
"url": "http://127.0.0.1:3114"
}
],
"components": {
"securitySchemes": {
"Access-Token": {
"type": "apiKey",
"in": "header",
"name": "X-API-KEY"
}
}
}
}
```