{
"openapi": "3.1.0",
"info": {
"version": "v1",
"title": "AuthoredUp API"
},
"servers": [
{
"url": "https://api.authoredup.com"
}
],
"paths": {
"/external/api/v1/docs": {
"get": {
"operationId": "getDocs",
"tags": [
"Docs"
],
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/DocumentationArticleSummary"
}
}
}
}
},
"default": {
"description": "Unexpected error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
}
},
"description": "List published AuthoredUp documentation articles. Use the slug with GetDoc to retrieve the Markdown body.",
"parameters": [
{
"in": "query",
"name": "categories",
"required": false,
"schema": {
"type": "array",
"items": {
"type": "string",
"enum": [
"business",
"billing",
"general",
"account",
"compliance",
"user_guide",
"troubleshooting"
]
}
}
},
{
"in": "query",
"name": "limit",
"required": false,
"schema": {
"type": [
"number",
"null"
]
}
}
],
"security": [
{
"bearer_user_api_token": []
},
{
"bearer_oauth_token": []
}
]
}
},
"/external/api/v1/docs/search": {
"get": {
"operationId": "getDocsSearch",
"tags": [
"Docs"
],
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/DocumentationSearchResult"
}
}
}
}
},
"default": {
"description": "Unexpected error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
}
},
"description": "Search published AuthoredUp documentation. Results include the complete Markdown article and a matching excerpt.",
"parameters": [
{
"in": "query",
"name": "q",
"required": true,
"schema": {
"type": "string",
"minLength": 2
}
},
{
"in": "query",
"name": "limit",
"required": false,
"schema": {
"type": "number",
"minimum": 1,
"maximum": 100
}
}
],
"security": [
{
"bearer_user_api_token": []
},
{
"bearer_oauth_token": []
}
]
}
},
"/external/api/v1/docs/{slug}": {
"get": {
"operationId": "getDoc",
"tags": [
"Docs"
],
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/DocumentationArticle"
}
}
}
},
"default": {
"description": "Unexpected error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
}
},
"description": "Get an AuthoredUp documentation article by slug, including its complete Markdown body.",
"parameters": [
{
"in": "path",
"name": "slug",
"required": true,
"schema": {
"type": "string"
}
}
],
"security": [
{
"bearer_user_api_token": []
},
{
"bearer_oauth_token": []
}
]
}
},
"/external/api/v1/roadmap": {
"get": {
"operationId": "getRoadmap",
"tags": [
"Roadmap"
],
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/RoadmapQueryResult"
}
}
}
},
"default": {
"description": "Unexpected error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
}
},
"description": "Query AuthoredUp roadmap items. Results can be filtered by roadmap column, status, or text and sorted by votes or dates.",
"parameters": [
{
"in": "query",
"name": "column",
"required": false,
"schema": {
"type": "string",
"enum": [
"idea",
"adopted",
"closed"
]
}
},
{
"in": "query",
"name": "status",
"required": false,
"schema": {
"type": "string",
"enum": [
"idea",
"adopted",
"completed",
"rejected",
"merged"
]
}
},
{
"in": "query",
"name": "filter",
"required": false,
"description": "Loose title or ID filter.",
"schema": {
"type": "string",
"description": "Loose title or ID filter."
}
},
{
"in": "query",
"name": "sort_field",
"required": false,
"description": "Field to sort by. Defaults to vote_count.",
"schema": {
"description": "Field to sort by. Defaults to vote_count.",
"anyOf": [
{
"type": "string"
},
{
"type": "string"
},
{
"type": "string"
}
]
}
},
{
"in": "query",
"name": "sort_direction",
"required": false,
"schema": {
"type": "string",
"enum": [
"asc",
"desc"
]
}
},
{
"in": "query",
"name": "limit",
"required": false,
"description": "How many records to return. Defaults to 20, max 100.",
"schema": {
"type": "integer",
"description": "How many records to return. Defaults to 20, max 100.",
"minimum": 1,
"maximum": 100
}
},
{
"in": "query",
"name": "offset",
"required": false,
"description": "Start after this many items. Used for pagination.",
"schema": {
"type": "integer",
"description": "Start after this many items. Used for pagination.",
"minimum": 0
}
}
],
"security": [
{
"bearer_user_api_token": []
},
{
"bearer_oauth_token": []
}
]
},
"post": {
"operationId": "postRoadmap",
"tags": [
"Roadmap"
],
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/RoadmapItem"
}
}
}
},
"default": {
"description": "Unexpected error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
}
},
"description": "Create a roadmap suggestion owned by the authenticated user. The item starts in the idea state and automatically receives the user's vote.",
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/RoadmapItemPayload"
}
}
}
},
"security": [
{
"bearer_user_api_token": []
},
{
"bearer_oauth_token": []
}
]
}
},
"/external/api/v1/roadmap/{id}": {
"get": {
"operationId": "getRoadmapId",
"tags": [
"Roadmap"
],
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/RoadmapItem"
}
}
}
},
"default": {
"description": "Unexpected error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
}
},
"description": "Get an AuthoredUp roadmap item by ID.",
"parameters": [
{
"in": "path",
"name": "id",
"required": true,
"schema": {
"type": "string"
}
}
],
"security": [
{
"bearer_user_api_token": []
},
{
"bearer_oauth_token": []
}
]
},
"patch": {
"operationId": "patchRoadmap",
"tags": [
"Roadmap"
],
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/RoadmapItem"
}
}
}
},
"default": {
"description": "Unexpected error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
}
},
"description": "Update the title or description of a roadmap suggestion created by the authenticated user. Only possible while no one else has commented, voted, or subscribed, and only shortly after submission.",
"parameters": [
{
"in": "path",
"name": "id",
"required": true,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/RoadmapItemPatch"
}
}
}
},
"security": [
{
"bearer_user_api_token": []
},
{
"bearer_oauth_token": []
}
]
},
"delete": {
"operationId": "deleteRoadmap",
"tags": [
"Roadmap"
],
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"type": "boolean"
}
}
}
},
"default": {
"description": "Unexpected error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
}
},
"description": "Delete a roadmap suggestion created by the authenticated user. Only possible while no one else has commented, voted, or subscribed, and only shortly after submission.",
"parameters": [
{
"in": "path",
"name": "id",
"required": true,
"schema": {
"type": "string"
}
}
],
"security": [
{
"bearer_user_api_token": []
},
{
"bearer_oauth_token": []
}
]
}
},
"/external/api/v1/posts": {
"get": {
"operationId": "getPosts",
"tags": [
"Posts"
],
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PostDataQueryResult"
}
}
}
},
"default": {
"description": "Unexpected error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
}
},
"description": "Query the authenticated user's LinkedIn posts already stored in AuthoredUp (including teammates' posts on Business accounts). Each post includes text, content type, hashtags, text metrics, reaction/comment/share/impression and other analytics when available, engagement rate, scheduling and publish dates, and optional images or document attachments. The response also returns the referenced profiles, companies, and groups.",
"parameters": [
{
"in": "query",
"name": "post-urn",
"required": false,
"description": "Pick individual posts by URN or activity URN",
"schema": {
"type": "string",
"description": "Pick individual posts by URN or activity URN"
}
},
{
"in": "query",
"name": "actors",
"required": false,
"description": "Filter list to a union of given actors",
"schema": {
"type": "array",
"description": "Filter list to a union of given actors",
"items": {
"type": "string"
}
}
},
{
"in": "query",
"name": "from-date",
"required": false,
"description": "From which normalized date to start looking for posts. Provided as ISO 8601 date string.",
"schema": {
"description": "From which normalized date to start looking for posts. Provided as ISO 8601 date string.",
"type": "string",
"format": "date-time"
}
},
{
"in": "query",
"name": "to-date",
"required": false,
"description": "To which normalized date to look for posts. Provided as ISO 8601 date string.",
"schema": {
"description": "To which normalized date to look for posts. Provided as ISO 8601 date string.",
"type": "string",
"format": "date-time"
}
},
{
"in": "query",
"name": "content-types",
"required": false,
"description": "Only provide posts with given content types.",
"schema": {
"type": "array",
"description": "Only provide posts with given content types.",
"items": {
"type": "string",
"enum": [
"Image",
"Document",
"Text",
"Repost",
"Reshare",
"Article",
"LinkedInVideo",
"Poll",
"ExternalVideo",
"Event",
"Entity",
"ScheduledLiveContent",
"Celebration",
"Newsletter",
"Slideshow",
"TextOverlayImage",
"Showcase",
"Review",
"Other"
]
}
}
},
{
"in": "query",
"name": "tags",
"required": false,
"description": "List of user tags to filter posts by",
"schema": {
"type": "array",
"description": "List of user tags to filter posts by",
"items": {
"type": "string"
}
}
},
{
"in": "query",
"name": "filter",
"required": false,
"description": "Loose string to filter rows by",
"schema": {
"type": "string",
"description": "Loose string to filter rows by"
}
},
{
"in": "query",
"name": "sort-field",
"required": false,
"description": "Field to sort by (defaults to \"post_updated_at\")",
"schema": {
"type": "string",
"description": "Field to sort by (defaults to \"post_updated_at\")",
"enum": [
"urn",
"text",
"document",
"content_type",
"hashtags",
"images",
"actor_profile_id",
"actor_company_id",
"actor_group_id",
"text_metrics",
"time_zone_name",
"reaction_counts",
"reaction_count",
"comment_count",
"impression_count",
"did_self_like",
"text_attributes",
"save_count",
"send_count",
"members_reached_count",
"profile_view_count",
"followers_gained_count",
"link_click_count",
"post_scheduled_date",
"post_created_at",
"post_updated_at",
"post_published_at",
"post_deleted_at",
"activity_urn",
"markdown_content",
"share_count",
"engagement_rate",
"normalized_post_date",
"document.name",
"document.id",
"document.size_in_bytes",
"document.mime_type",
"document.recommended_extension",
"text_metrics.rawLength",
"text_metrics.characters",
"text_metrics.words",
"text_metrics.paragraphs",
"text_metrics.sentences",
"text_metrics.readingTimeMs",
"text_metrics.readabilityIndex",
"text_metrics.emojis",
"text_metrics.hasBold",
"text_metrics.hasItalic",
"text_metrics.hasUnderline",
"text_metrics.dividers",
"text_metrics.dividers.count",
"text_metrics.dividers.style",
"text_metrics.dividers.placement",
"reaction_counts.LIKE",
"reaction_counts.INTEREST",
"reaction_counts.PRAISE",
"reaction_counts.EMPATHY",
"reaction_counts.ENTERTAINMENT",
"reaction_counts.APPRECIATION",
"reaction_counts.MAYBE"
]
}
},
{
"in": "query",
"name": "sort-direction",
"required": false,
"description": "Direction to sort by (defaults to \"desc\")",
"schema": {
"type": "string",
"description": "Direction to sort by (defaults to \"desc\")",
"enum": [
"asc",
"desc"
]
}
},
{
"in": "query",
"name": "limit",
"required": false,
"description": "How many records to return (defaults to 20, max 1000)",
"schema": {
"type": "number",
"description": "How many records to return (defaults to 20, max 1000)"
}
},
{
"in": "query",
"name": "offset",
"required": false,
"description": "Start after this many items. Used for pagination",
"schema": {
"type": "number",
"description": "Start after this many items. Used for pagination"
}
},
{
"in": "query",
"name": "include",
"required": false,
"description": "Include posts with given statuses\nIf not specified, defaults to \"published\" and \"scheduled\".",
"schema": {
"type": "array",
"description": "Include posts with given statuses\nIf not specified, defaults to \"published\" and \"scheduled\".",
"items": {
"type": "string",
"enum": [
"hidden",
"deleted",
"scheduled",
"published"
]
}
}
}
],
"security": [
{
"bearer_user_api_token": []
},
{
"bearer_oauth_token": []
}
]
}
},
"/external/api/v1/posts/{urn}": {
"get": {
"operationId": "getPost",
"tags": [
"Posts"
],
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PostDataQueryResult"
}
}
}
},
"default": {
"description": "Unexpected error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
}
},
"description": "Get a single post by share URN or activity URN. Returns the same structure as the posts query (items plus referenced profiles, companies, and groups).",
"parameters": [
{
"in": "path",
"name": "urn",
"required": true,
"schema": {
"type": "string"
}
}
],
"security": [
{
"bearer_user_api_token": []
},
{
"bearer_oauth_token": []
}
]
}
},
"/external/api/v1/saved-posts": {
"get": {
"operationId": "getSavedPosts",
"tags": [
"Posts"
],
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PostDataQueryResult"
}
}
}
},
"default": {
"description": "Unexpected error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
}
},
"description": "Query LinkedIn posts the user has saved in LinkedIn. Returns the same post payload as the posts query.",
"parameters": [
{
"in": "query",
"name": "post-urn",
"required": false,
"description": "Pick individual posts by URN or activity URN",
"schema": {
"type": "string",
"description": "Pick individual posts by URN or activity URN"
}
},
{
"in": "query",
"name": "actors",
"required": false,
"description": "Filter list to a union of given actors",
"schema": {
"type": "array",
"description": "Filter list to a union of given actors",
"items": {
"type": "string"
}
}
},
{
"in": "query",
"name": "from-date",
"required": false,
"description": "From which normalized date to start looking for posts. Provided as ISO 8601 date string.",
"schema": {
"description": "From which normalized date to start looking for posts. Provided as ISO 8601 date string.",
"type": "string",
"format": "date-time"
}
},
{
"in": "query",
"name": "to-date",
"required": false,
"description": "To which normalized date to look for posts. Provided as ISO 8601 date string.",
"schema": {
"description": "To which normalized date to look for posts. Provided as ISO 8601 date string.",
"type": "string",
"format": "date-time"
}
},
{
"in": "query",
"name": "content-types",
"required": false,
"description": "Only provide posts with given content types.",
"schema": {
"type": "array",
"description": "Only provide posts with given content types.",
"items": {
"type": "string",
"enum": [
"Image",
"Document",
"Text",
"Repost",
"Reshare",
"Article",
"LinkedInVideo",
"Poll",
"ExternalVideo",
"Event",
"Entity",
"ScheduledLiveContent",
"Celebration",
"Newsletter",
"Slideshow",
"TextOverlayImage",
"Showcase",
"Review",
"Other"
]
}
}
},
{
"in": "query",
"name": "tags",
"required": false,
"description": "List of user tags to filter posts by",
"schema": {
"type": "array",
"description": "List of user tags to filter posts by",
"items": {
"type": "string"
}
}
},
{
"in": "query",
"name": "filter",
"required": false,
"description": "Loose string to filter rows by",
"schema": {
"type": "string",
"description": "Loose string to filter rows by"
}
},
{
"in": "query",
"name": "sort-field",
"required": false,
"description": "Field to sort by (defaults to \"post_updated_at\")",
"schema": {
"type": "string",
"description": "Field to sort by (defaults to \"post_updated_at\")",
"enum": [
"urn",
"text",
"document",
"content_type",
"hashtags",
"images",
"actor_profile_id",
"actor_company_id",
"actor_group_id",
"text_metrics",
"time_zone_name",
"reaction_counts",
"reaction_count",
"comment_count",
"impression_count",
"did_self_like",
"text_attributes",
"save_count",
"send_count",
"members_reached_count",
"profile_view_count",
"followers_gained_count",
"link_click_count",
"post_scheduled_date",
"post_created_at",
"post_updated_at",
"post_published_at",
"post_deleted_at",
"activity_urn",
"markdown_content",
"share_count",
"engagement_rate",
"normalized_post_date",
"document.name",
"document.id",
"document.size_in_bytes",
"document.mime_type",
"document.recommended_extension",
"text_metrics.rawLength",
"text_metrics.characters",
"text_metrics.words",
"text_metrics.paragraphs",
"text_metrics.sentences",
"text_metrics.readingTimeMs",
"text_metrics.readabilityIndex",
"text_metrics.emojis",
"text_metrics.hasBold",
"text_metrics.hasItalic",
"text_metrics.hasUnderline",
"text_metrics.dividers",
"text_metrics.dividers.count",
"text_metrics.dividers.style",
"text_metrics.dividers.placement",
"reaction_counts.LIKE",
"reaction_counts.INTEREST",
"reaction_counts.PRAISE",
"reaction_counts.EMPATHY",
"reaction_counts.ENTERTAINMENT",
"reaction_counts.APPRECIATION",
"reaction_counts.MAYBE"
]
}
},
{
"in": "query",
"name": "sort-direction",
"required": false,
"description": "Direction to sort by (defaults to \"desc\")",
"schema": {
"type": "string",
"description": "Direction to sort by (defaults to \"desc\")",
"enum": [
"asc",
"desc"
]
}
},
{
"in": "query",
"name": "limit",
"required": false,
"description": "How many records to return (defaults to 20, max 1000)",
"schema": {
"type": "number",
"description": "How many records to return (defaults to 20, max 1000)"
}
},
{
"in": "query",
"name": "offset",
"required": false,
"description": "Start after this many items. Used for pagination",
"schema": {
"type": "number",
"description": "Start after this many items. Used for pagination"
}
},
{
"in": "query",
"name": "profile-ids",
"required": false,
"description": "List of the profiles for which to seek saved posts",
"schema": {
"type": "array",
"description": "List of the profiles for which to seek saved posts",
"items": {
"type": "string"
}
}
},
{
"in": "query",
"name": "include-hidden",
"required": false,
"description": "If true, also return posts that are hidden from the saved list",
"schema": {
"type": "boolean",
"description": "If true, also return posts that are hidden from the saved list"
}
}
],
"security": [
{
"bearer_user_api_token": []
},
{
"bearer_oauth_token": []
}
]
}
},
"/external/api/v1/saved-posts/{urn}": {
"get": {
"operationId": "getSavedPost",
"tags": [
"Posts"
],
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PostDataQueryResult"
}
}
}
},
"default": {
"description": "Unexpected error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
}
},
"description": "Get a single saved post by share URN.",
"parameters": [
{
"in": "path",
"name": "urn",
"required": true,
"schema": {
"type": "string"
}
}
],
"security": [
{
"bearer_user_api_token": []
},
{
"bearer_oauth_token": []
}
]
}
},
"/external/api/v1/actors": {
"get": {
"operationId": "getActors",
"tags": [
"Actors"
],
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Actor"
}
}
}
}
},
"default": {
"description": "Unexpected error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
}
},
"description": "List the actors the user can work with in AuthoredUp: personal profiles, company pages, and groups. Each actor has an identifier used when filtering posts, a type (profile/company/group), and nested details such as name, LinkedIn public identifier or company URL, follower/connection counts, and logo/picture metadata.",
"parameters": [
{
"in": "query",
"name": "include-types",
"required": false,
"description": "Filter actors by type, by default all types are included",
"schema": {
"type": "array",
"description": "Filter actors by type, by default all types are included",
"items": {
"type": "string",
"enum": [
"profile",
"company",
"group"
]
}
}
}
],
"security": [
{
"bearer_user_api_token": []
},
{
"bearer_oauth_token": []
}
]
}
},
"/external/api/v1/organization-members": {
"get": {
"operationId": "getOrganizationMembers",
"tags": [
"Organization"
],
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/OrganizationMember"
}
}
}
}
},
"default": {
"description": "Unexpected error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
}
},
"description": "List active organization members that can be used as draft collaborators. Use the returned IDs in draft collaborator_ids when creating or updating drafts.",
"security": [
{
"bearer_user_api_token": []
},
{
"bearer_oauth_token": []
}
]
}
},
"/external/api/v1/dashboard/{profileId}/profile-history": {
"get": {
"operationId": "getDashboardProfileHistory",
"tags": [
"Dashboard"
],
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/DashboardProfileHistory"
}
}
}
},
"default": {
"description": "Unexpected error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
}
},
"description": "Time series of historic performance for one of your licensed LinkedIn profiles (same data as AuthoredUp's profile dashboard). Returns daily (or period-bucketed) follower_count and connection_count points; some older points may be marked estimated when LinkedIn did not provide exact past values. Period: month, quarter, or year (default month).",
"parameters": [
{
"in": "path",
"name": "profileId",
"required": true,
"schema": {
"type": "string"
}
},
{
"in": "query",
"name": "period",
"required": false,
"description": "Time period for profile history",
"schema": {
"type": "string",
"description": "Time period for profile history",
"default": "month",
"enum": [
"month",
"quarter",
"year"
]
}
}
],
"security": [
{
"bearer_user_api_token": []
},
{
"bearer_oauth_token": []
}
]
}
},
"/external/api/v1/dashboard/{companyId}/company-history": {
"get": {
"operationId": "getDashboardCompanyHistory",
"tags": [
"Dashboard"
],
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/DashboardCompanyHistory"
}
}
}
},
"default": {
"description": "Unexpected error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
}
},
"description": "Time series of follower counts for one of your licensed company pages (same data as AuthoredUp's company dashboard).",
"parameters": [
{
"in": "path",
"name": "companyId",
"required": true,
"schema": {
"type": "string"
}
},
{
"in": "query",
"name": "period",
"required": false,
"description": "Time period for company history",
"schema": {
"type": "string",
"description": "Time period for company history",
"default": "month",
"enum": [
"month",
"quarter",
"year"
]
}
}
],
"security": [
{
"bearer_user_api_token": []
},
{
"bearer_oauth_token": []
}
]
}
},
"/external/api/v1/drafts": {
"get": {
"operationId": "getDrafts",
"tags": [
"Drafts"
],
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/DraftQueryResult"
}
}
}
},
"default": {
"description": "Unexpected error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
}
},
"description": "Query the user's drafts, including drafts shared with them by teammates. Drafts are unpublished posts the user can review, edit, schedule, and publish with AuthoredUp. Returns the same draft objects as the draft create and update endpoints.",
"parameters": [
{
"in": "query",
"name": "status",
"required": false,
"description": "Include only drafts with given statuses. Defaults to all but \"deleted\".",
"schema": {
"type": "array",
"description": "Include only drafts with given statuses. Defaults to all but \"deleted\".",
"items": {
"type": "string",
"enum": [
"active",
"ready",
"submitted",
"deleted"
]
}
}
},
{
"in": "query",
"name": "actors",
"required": false,
"description": "Filter to drafts designated to the given actors (profile or company identifiers)",
"schema": {
"type": "array",
"description": "Filter to drafts designated to the given actors (profile or company identifiers)",
"items": {
"type": "string"
}
}
},
{
"in": "query",
"name": "tags",
"required": false,
"description": "Only drafts labeled with all the given tags",
"schema": {
"type": "array",
"description": "Only drafts labeled with all the given tags",
"items": {
"type": "string"
}
}
},
{
"in": "query",
"name": "filter",
"required": false,
"description": "Loose string to filter drafts by (matches id, title, text and linked post URN)",
"schema": {
"type": "string",
"description": "Loose string to filter drafts by (matches id, title, text and linked post URN)"
}
},
{
"in": "query",
"name": "from-date",
"required": false,
"description": "From which creation date to look for drafts. Provided as ISO 8601 date string.",
"schema": {
"description": "From which creation date to look for drafts. Provided as ISO 8601 date string.",
"type": "string",
"format": "date-time"
}
},
{
"in": "query",
"name": "to-date",
"required": false,
"description": "To which creation date to look for drafts. Provided as ISO 8601 date string.",
"schema": {
"description": "To which creation date to look for drafts. Provided as ISO 8601 date string.",
"type": "string",
"format": "date-time"
}
},
{
"in": "query",
"name": "ownership",
"required": false,
"description": "\"owner\" returns only the user's own drafts, \"collaborator\" only drafts shared with them.\nDefaults to both.",
"schema": {
"type": "string",
"description": "\"owner\" returns only the user's own drafts, \"collaborator\" only drafts shared with them.\nDefaults to both.",
"enum": [
"owner",
"collaborator"
]
}
},
{
"in": "query",
"name": "sort-field",
"required": false,
"description": "Field to sort by (defaults to \"updated_at\")",
"schema": {
"description": "Field to sort by (defaults to \"updated_at\")",
"anyOf": [
{
"type": "string"
},
{
"type": "string"
},
{
"type": "string"
},
{
"type": "string"
}
]
}
},
{
"in": "query",
"name": "sort-direction",
"required": false,
"description": "Direction to sort by (defaults to \"desc\")",
"schema": {
"type": "string",
"description": "Direction to sort by (defaults to \"desc\")",
"enum": [
"asc",
"desc"
]
}
},
{
"in": "query",
"name": "limit",
"required": false,
"description": "How many records to return (defaults to 20)",
"schema": {
"type": "number",
"description": "How many records to return (defaults to 20)"
}
},
{
"in": "query",
"name": "offset",
"required": false,
"description": "Start after this many items. Used for pagination",
"schema": {
"type": "number",
"description": "Start after this many items. Used for pagination"
}
}
],
"security": [
{
"bearer_user_api_token": []
},
{
"bearer_oauth_token": []
}
]
},
"post": {
"operationId": "postDraft",
"tags": [
"Drafts"
],
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Draft"
}
}
}
},
"default": {
"description": "Unexpected error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
}
},
"description": "Use this when the user wants to create a new private text draft in AuthoredUp. Optionally provide text with inline markdown for styling (bold, italic, monospace), an internal title, tags, a target profile or company ID, collaborators, and a planned publish time; media attachments are not supported. Collaborators can access shared draft content, and reminders may send AuthoredUp notifications or email. This tool does not publish or schedule content on LinkedIn.",
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/DraftPayload"
}
}
}
},
"security": [
{
"bearer_user_api_token": []
},
{
"bearer_oauth_token": []
}
]
}
},
"/external/api/v1/drafts/{id}": {
"get": {
"operationId": "getDraft",
"tags": [
"Drafts"
],
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Draft"
}
}
}
},
"default": {
"description": "Unexpected error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
}
},
"description": "Get a single draft by ID.",
"parameters": [
{
"in": "path",
"name": "id",
"required": true,
"schema": {
"type": "string"
}
}
],
"security": [
{
"bearer_user_api_token": []
},
{
"bearer_oauth_token": []
}
]
},
"patch": {
"operationId": "patchDraft",
"tags": [
"Drafts"
],
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Draft"
}
}
}
},
"default": {
"description": "Unexpected error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
}
},
"description": "Use this when the user wants to update an existing private AuthoredUp draft. Only provided fields are changed, but markdown_content replaces the entire draft text and status can mark the draft deleted. The draft must be owned by or shared with the user. Changes can notify collaborators, and reminders may send AuthoredUp notifications or email. This tool does not publish or schedule content on LinkedIn.",
"parameters": [
{
"in": "path",
"name": "id",
"required": true,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/DraftPayload"
}
}
}
},
"security": [
{
"bearer_user_api_token": []
},
{
"bearer_oauth_token": []
}
]
}
},
"/external/api/v1/mentions": {
"get": {
"operationId": "getMentions",
"tags": [
"Mentions"
],
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/MentionQueryResult"
}
}
}
},
"default": {
"description": "Unexpected error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
}
},
"description": "List profiles and companies that can be @-mentioned in drafts. Only entities that were previously mentioned in the user's own posts are available. Use an item's ln_profile_id or ln_company_id in draft text as \"@[Name](identifier)\".",
"parameters": [
{
"in": "query",
"name": "filter",
"required": false,
"description": "Loose string to filter candidates by name",
"schema": {
"type": "string",
"description": "Loose string to filter candidates by name"
}
},
{
"in": "query",
"name": "actors",
"required": false,
"description": "Only list entities mentioned in posts of given actors",
"schema": {
"type": "array",
"description": "Only list entities mentioned in posts of given actors",
"items": {
"type": "string"
}
}
},
{
"in": "query",
"name": "limit",
"required": false,
"description": "How many records to return (defaults to 20)",
"schema": {
"type": "number",
"description": "How many records to return (defaults to 20)"
}
},
{
"in": "query",
"name": "offset",
"required": false,
"description": "Start after this many items. Used for pagination",
"schema": {
"type": "number",
"description": "Start after this many items. Used for pagination"
}
}
],
"security": [
{
"bearer_user_api_token": []
},
{
"bearer_oauth_token": []
}
]
}
},
"/external/api/v1/user-tags": {
"get": {
"operationId": "getUserTags",
"tags": [
"Tags"
],
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/UserTag"
}
}
}
}
},
"default": {
"description": "Unexpected error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
}
},
"description": "List the user's tags, with usage counts across their posts and drafts. Tags are free-form labels used to organize posts and drafts. Prefer reusing existing tags (eg. when creating or updating drafts) over inventing new ones.",
"security": [
{
"bearer_user_api_token": []
},
{
"bearer_oauth_token": []
}
]
}
},
"/external/api/v1/images/{id}/data": {
"get": {
"operationId": "getImageData",
"tags": [
"Images"
],
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"type": "string",
"format": "binary"
}
}
}
},
"default": {
"description": "Unexpected error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
}
},
"description": "Download or display binary image bytes for an image id referenced from posts or actor picture/logo fields. Response may be a 302 redirect to the file store.",
"parameters": [
{
"in": "path",
"name": "id",
"required": true,
"schema": {
"type": "string"
}
}
],
"security": [
{
"bearer_user_api_token": []
},
{
"bearer_oauth_token": []
}
]
}
},
"/external/api/v1/documents/{id}/data": {
"get": {
"operationId": "getDocumentData",
"tags": [
"Documents"
],
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"type": "string",
"format": "binary"
}
}
}
},
"default": {
"description": "Unexpected error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
}
},
"description": "Download binary document bytes (e.g. a PDF attached to a document post) for a document id from post data. Response may be a 302 redirect to the file store.",
"parameters": [
{
"in": "path",
"name": "id",
"required": true,
"schema": {
"type": "string"
}
}
],
"security": [
{
"bearer_user_api_token": []
},
{
"bearer_oauth_token": []
}
]
}
}
},
"components": {
"schemas": {
"Error": {
"description": "Custom error message",
"required": [
"status",
"message",
"name"
],
"properties": {
"status": {
"type": "integer",
"format": "int32"
},
"message": {
"type": "string"
},
"name": {
"type": "string"
},
"data": {
"type": "object",
"additionalProperties": true,
"description": "Additional data about the error, if available"
}
}
},
"ValidationError": {
"description": "Validation error",
"required": [
"status",
"message",
"name",
"data"
],
"properties": {
"status": {
"type": "integer",
"format": "int32",
"example": 400
},
"message": {
"type": "string",
"example": "Validation error: \"content-types[0]\" must be one of [Image, Document, Text, ...]"
},
"name": {
"type": "string",
"example": "ValidationError"
},
"data": {
"type": "object",
"properties": {
"faults": {
"type": "array",
"items": {
"type": "object",
"properties": {
"message": {
"type": "string"
},
"path": {
"type": "array",
"items": {
"oneOf": [
{
"type": "string"
},
{
"type": "integer"
}
]
}
},
"type": {
"type": "string"
},
"context": {
"type": "object",
"additionalProperties": true
}
}
}
},
"target": {
"type": "object",
"additionalProperties": true
},
"schema": {
"type": "object",
"additionalProperties": true
}
}
}
}
},
"PubHelpArticlesCriteria": {
"type": "object",
"properties": {
"categories": {
"type": "array",
"items": {
"type": "string",
"enum": [
"business",
"billing",
"general",
"account",
"compliance",
"user_guide",
"troubleshooting"
]
}
},
"limit": {
"type": [
"number",
"null"
]
}
},
"additionalProperties": false
},
"DocumentationArticleSummary": {
"type": "object",
"properties": {
"slug": {
"type": "string"
},
"category": {
"type": "string",
"enum": [
"business",
"billing",
"general",
"account",
"compliance",
"user_guide",
"troubleshooting"
]
},
"title": {
"type": "string"
},
"created_at": {
"type": "string",
"format": "date-time"
},
"updated_at": {
"type": [
"string",
"null"
],
"format": "date-time"
}
},
"required": [
"category",
"created_at",
"slug",
"title",
"updated_at"
],
"additionalProperties": false
},
"DocumentationSearchResult": {
"type": "object",
"properties": {
"slug": {
"type": "string"
},
"category": {
"type": "string",
"enum": [
"business",
"billing",
"general",
"account",
"compliance",
"user_guide",
"troubleshooting"
]
},
"title": {
"type": "string"
},
"created_at": {
"type": "string",
"format": "date-time"
},
"updated_at": {
"type": [
"string",
"null"
],
"format": "date-time"
},
"content": {
"type": "string",
"description": "Article body in Markdown."
},
"rank": {
"type": "number",
"description": "Full text search rank."
},
"headline": {
"type": "string",
"description": "Markdown excerpt containing the matching text."
}
},
"required": [
"category",
"content",
"created_at",
"headline",
"rank",
"slug",
"title",
"updated_at"
],
"additionalProperties": false
},
"DocumentationArticle": {
"type": "object",
"properties": {
"slug": {
"type": "string"
},
"category": {
"type": "string",
"enum": [
"business",
"billing",
"general",
"account",
"compliance",
"user_guide",
"troubleshooting"
]
},
"title": {
"type": "string"
},
"created_at": {
"type": "string",
"format": "date-time"
},
"updated_at": {
"type": [
"string",
"null"
],
"format": "date-time"
},
"content": {
"type": "string",
"description": "Article body in Markdown."
}
},
"required": [
"category",
"content",
"created_at",
"slug",
"title",
"updated_at"
],
"additionalProperties": false
},
"RoadmapCriteria": {
"type": "object",
"properties": {
"column": {
"type": "string",
"enum": [
"idea",
"adopted",
"closed"
]
},
"status": {
"type": "string",
"enum": [
"idea",
"adopted",
"completed",
"rejected",
"merged"
]
},
"filter": {
"type": "string",
"description": "Loose title or ID filter."
},
"sort_field": {
"description": "Field to sort by. Defaults to vote_count.",
"anyOf": [
{
"type": "string"
},
{
"type": "string"
},
{
"type": "string"
}
]
},
"sort_direction": {
"type": "string",
"enum": [
"asc",
"desc"
]
},
"limit": {
"type": "integer",
"description": "How many records to return. Defaults to 20, max 100.",
"minimum": 1,
"maximum": 100
},
"offset": {
"type": "integer",
"description": "Start after this many items. Used for pagination.",
"minimum": 0
}
},
"additionalProperties": false
},
"RoadmapQueryResult": {
"type": "object",
"properties": {
"nextPageOffset": {
"type": "number",
"description": "What offset should be set to grab the next page. If there are no more records, this will be null"
},
"items": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"title": {
"type": [
"string",
"null"
]
},
"description": {
"type": "string"
},
"status": {
"type": "string",
"enum": [
"idea",
"adopted",
"completed",
"rejected",
"merged"
]
},
"column": {
"type": "string",
"enum": [
"idea",
"adopted",
"closed"
]
},
"vote_count": {
"type": "number"
},
"comment_count": {
"type": "number"
},
"voted": {
"type": "boolean"
},
"editable": {
"type": "boolean",
"description": "Whether the authenticated user can still update or delete this item"
},
"requested_at": {
"type": "string",
"format": "date-time"
},
"updated_at": {
"type": "string",
"format": "date-time"
}
},
"required": [
"column",
"comment_count",
"description",
"editable",
"id",
"requested_at",
"status",
"title",
"updated_at",
"vote_count",
"voted"
],
"additionalProperties": false
}
}
},
"required": [
"items",
"nextPageOffset"
],
"additionalProperties": false
},
"RoadmapItem": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"title": {
"type": [
"string",
"null"
]
},
"description": {
"type": "string"
},
"status": {
"type": "string",
"enum": [
"idea",
"adopted",
"completed",
"rejected",
"merged"
]
},
"column": {
"type": "string",
"enum": [
"idea",
"adopted",
"closed"
]
},
"vote_count": {
"type": "number"
},
"comment_count": {
"type": "number"
},
"voted": {
"type": "boolean"
},
"editable": {
"type": "boolean",
"description": "Whether the authenticated user can still update or delete this item"
},
"requested_at": {
"type": "string",
"format": "date-time"
},
"updated_at": {
"type": "string",
"format": "date-time"
}
},
"required": [
"column",
"comment_count",
"description",
"editable",
"id",
"requested_at",
"status",
"title",
"updated_at",
"vote_count",
"voted"
],
"additionalProperties": false
},
"RoadmapItemPayload": {
"type": "object",
"properties": {
"title": {
"type": "string"
},
"description": {
"type": "string"
}
},
"required": [
"description",
"title"
],
"additionalProperties": false
},
"RoadmapItemPatch": {
"type": "object",
"properties": {
"title": {
"type": "string"
},
"description": {
"type": "string"
}
},
"additionalProperties": false
},
"PostDataCriteria": {
"type": "object",
"properties": {
"post-urn": {
"type": "string",
"description": "Pick individual posts by URN or activity URN"
},
"actors": {
"type": "array",
"description": "Filter list to a union of given actors",
"items": {
"type": "string"
}
},
"from-date": {
"description": "From which normalized date to start looking for posts. Provided as ISO 8601 date string.",
"type": "string",
"format": "date-time"
},
"to-date": {
"description": "To which normalized date to look for posts. Provided as ISO 8601 date string.",
"type": "string",
"format": "date-time"
},
"content-types": {
"type": "array",
"description": "Only provide posts with given content types.",
"items": {
"type": "string",
"enum": [
"Image",
"Document",
"Text",
"Repost",
"Reshare",
"Article",
"LinkedInVideo",
"Poll",
"ExternalVideo",
"Event",
"Entity",
"ScheduledLiveContent",
"Celebration",
"Newsletter",
"Slideshow",
"TextOverlayImage",
"Showcase",
"Review",
"Other"
]
}
},
"tags": {
"type": "array",
"description": "List of user tags to filter posts by",
"items": {
"type": "string"
}
},
"filter": {
"type": "string",
"description": "Loose string to filter rows by"
},
"sort-field": {
"type": "string",
"description": "Field to sort by (defaults to \"post_updated_at\")",
"enum": [
"urn",
"text",
"document",
"content_type",
"hashtags",
"images",
"actor_profile_id",
"actor_company_id",
"actor_group_id",
"text_metrics",
"time_zone_name",
"reaction_counts",
"reaction_count",
"comment_count",
"impression_count",
"did_self_like",
"text_attributes",
"save_count",
"send_count",
"members_reached_count",
"profile_view_count",
"followers_gained_count",
"link_click_count",
"post_scheduled_date",
"post_created_at",
"post_updated_at",
"post_published_at",
"post_deleted_at",
"activity_urn",
"markdown_content",
"share_count",
"engagement_rate",
"normalized_post_date",
"document.name",
"document.id",
"document.size_in_bytes",
"document.mime_type",
"document.recommended_extension",
"text_metrics.rawLength",
"text_metrics.characters",
"text_metrics.words",
"text_metrics.paragraphs",
"text_metrics.sentences",
"text_metrics.readingTimeMs",
"text_metrics.readabilityIndex",
"text_metrics.emojis",
"text_metrics.hasBold",
"text_metrics.hasItalic",
"text_metrics.hasUnderline",
"text_metrics.dividers",
"text_metrics.dividers.count",
"text_metrics.dividers.style",
"text_metrics.dividers.placement",
"reaction_counts.LIKE",
"reaction_counts.INTEREST",
"reaction_counts.PRAISE",
"reaction_counts.EMPATHY",
"reaction_counts.ENTERTAINMENT",
"reaction_counts.APPRECIATION",
"reaction_counts.MAYBE"
]
},
"sort-direction": {
"type": "string",
"description": "Direction to sort by (defaults to \"desc\")",
"enum": [
"asc",
"desc"
]
},
"limit": {
"type": "number",
"description": "How many records to return (defaults to 20, max 1000)"
},
"offset": {
"type": "number",
"description": "Start after this many items. Used for pagination"
},
"include": {
"type": "array",
"description": "Include posts with given statuses\nIf not specified, defaults to \"published\" and \"scheduled\".",
"items": {
"type": "string",
"enum": [
"hidden",
"deleted",
"scheduled",
"published"
]
}
}
},
"additionalProperties": false
},
"PostDataQueryResult": {
"type": "object",
"properties": {
"nextPageOffset": {
"type": "number",
"description": "What offset should be set to grab the next page. If there are no more records, this will be null"
},
"items": {
"type": "array",
"description": "List of posts that match the criteria.",
"items": {
"type": "object",
"properties": {
"urn": {},
"activity_urn": {
"type": [
"string",
"null"
],
"description": "Activity URN is an alternative identifier for the post.\nThis can be used to construct the post URL: https://www.linkedin.com/feed/update/${activity_urn}"
},
"text": {
"type": [
"string",
"null"
]
},
"text_attributes": {
"type": [
"array",
"null"
],
"items": {
"anyOf": [
{
"type": "object",
"properties": {
"start": {
"type": "number",
"description": "Codepoint index where the attribute starts"
},
"length": {
"type": "number",
"description": "Length in codepoints of the attribute"
},
"index": {
"type": "number"
},
"type": {
"type": "string"
},
"urnValue": {
"type": "string"
}
},
"required": [
"index",
"length",
"start",
"type",
"urnValue"
],
"additionalProperties": false
},
{
"type": "object",
"properties": {
"start": {
"type": "number",
"description": "Codepoint index where the attribute starts"
},
"length": {
"type": "number",
"description": "Length in codepoints of the attribute"
},
"index": {
"type": "number"
},
"type": {
"type": "string"
},
"urnValue": {
"type": "string"
},
"numericId": {
"type": "number",
"description": "Available only for some sources. It seems we can regenerate a mention without it."
}
},
"required": [
"index",
"length",
"start",
"type",
"urnValue"
],
"additionalProperties": false
},
{
"type": "object",
"properties": {
"start": {
"type": "number",
"description": "Codepoint index where the attribute starts"
},
"length": {
"type": "number",
"description": "Length in codepoints of the attribute"
},
"index": {
"type": "number"
},
"type": {
"type": "string"
},
"hashtag": {
"type": "string"
}
},
"required": [
"hashtag",
"index",
"length",
"start",
"type"
],
"additionalProperties": false
},
{
"type": "object",
"properties": {
"start": {
"type": "number",
"description": "Codepoint index where the attribute starts"
},
"length": {
"type": "number",
"description": "Length in codepoints of the attribute"
},
"index": {
"type": "number"
},
"type": {
"type": "string"
},
"rawLink": {
"type": "string"
},
"resolvedLink": {
"type": "string"
},
"linkType": {
"type": "string",
"enum": [
"external",
"internal",
"email"
]
}
},
"required": [
"index",
"length",
"linkType",
"rawLink",
"resolvedLink",
"start",
"type"
],
"additionalProperties": false
},
{
"type": "object",
"properties": {
"start": {
"type": "number",
"description": "Codepoint index where the attribute starts"
},
"length": {
"type": "number",
"description": "Length in codepoints of the attribute"
},
"index": {
"type": "number"
},
"type": {
"type": "string"
},
"publicIdentifier": {
"type": "string"
}
},
"required": [
"index",
"length",
"publicIdentifier",
"start",
"type"
],
"additionalProperties": false
},
{
"type": "object",
"properties": {
"start": {
"type": "number",
"description": "Codepoint index where the attribute starts"
},
"length": {
"type": "number",
"description": "Length in codepoints of the attribute"
},
"index": {
"type": "number"
},
"type": {
"type": "string"
},
"universalName": {
"type": "string"
}
},
"required": [
"index",
"length",
"start",
"type",
"universalName"
],
"additionalProperties": false
},
{
"type": "object",
"properties": {
"start": {
"type": "number",
"description": "Codepoint index where the attribute starts"
},
"length": {
"type": "number",
"description": "Length in codepoints of the attribute"
},
"index": {
"type": "number"
},
"type": {
"type": "string"
},
"font": {
"type": [
"string",
"null"
],
"enum": [
"bold",
"italic",
"boldItalic",
"monospace",
null
]
},
"styling": {
"type": [
"array",
"null"
],
"items": {
"type": "string",
"enum": [
"strikethrough",
"underline"
]
}
}
},
"required": [
"font",
"index",
"length",
"start",
"styling",
"type"
],
"additionalProperties": false
}
]
}
},
"markdown_content": {
"type": "string",
"description": "Post text in markdown, including mention tokens."
},
"content_type": {
"type": "string",
"description": "Note that LinkedInVideo and ExternalVideo distinction isn't entirely reliable.",
"enum": [
"Image",
"Document",
"Text",
"Repost",
"Reshare",
"Article",
"LinkedInVideo",
"Poll",
"ExternalVideo",
"Event",
"Entity",
"ScheduledLiveContent",
"Celebration",
"Newsletter",
"Slideshow",
"TextOverlayImage",
"Showcase",
"Review",
"Other"
]
},
"hashtags": {
"type": "array",
"items": {
"type": "object",
"properties": {
"hashtag": {
"type": "string"
},
"count": {
"type": "number"
}
},
"required": [
"count",
"hashtag"
],
"additionalProperties": false
}
},
"images": {
"type": "array",
"description": "List of images for image posts. List of page screenshots for document posts (if available).",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"original_name": {
"type": "string",
"description": "The original name of the image, including extension"
},
"format": {
"type": "string",
"description": "The format of the image, eg. \"jpg\", \"png\""
},
"size_in_bytes": {
"type": "number"
},
"width": {
"type": "number"
},
"height": {
"type": "number"
}
},
"required": [
"format",
"height",
"id",
"original_name",
"size_in_bytes",
"width"
],
"additionalProperties": false
}
},
"document": {
"type": "object",
"description": "For document posts, this is the document that was attached to the post (likely PDF).",
"properties": {
"name": {
"type": [
"string",
"null"
],
"description": "This maps to file name, including extension"
},
"id": {
"type": "string"
},
"size_in_bytes": {
"type": "number"
},
"mime_type": {
"type": "string"
},
"recommended_extension": {
"type": "string",
"description": "This is based on the original document file name or its mime type."
}
},
"required": [
"id",
"mime_type",
"name",
"recommended_extension",
"size_in_bytes"
],
"additionalProperties": false
},
"actor_profile_id": {
"anyOf": [
{
"type": "null"
},
{
"type": "string"
},
{
"type": "string"
}
]
},
"actor_company_id": {
"anyOf": [
{
"type": "null"
},
{
"type": "string"
},
{
"type": "string"
}
]
},
"actor_group_id": {
"type": [
"string",
"null"
]
},
"text_metrics": {
"type": [
"object",
"null"
],
"properties": {
"rawLength": {
"type": "number"
},
"characters": {
"type": "number"
},
"words": {
"type": "number"
},
"paragraphs": {
"type": "number"
},
"sentences": {
"type": "number"
},
"readingTimeMs": {
"type": "number"
},
"readabilityIndex": {
"type": "number"
},
"emojis": {
"type": "array",
"items": {
"type": "string"
}
},
"hasBold": {
"type": "boolean"
},
"hasItalic": {
"type": "boolean"
},
"hasUnderline": {
"type": "boolean"
},
"dividers": {
"type": "object",
"properties": {
"count": {
"type": "number"
},
"style": {
"type": [
"string",
"null"
]
},
"placement": {
"type": [
"string",
"null"
],
"enum": [
"after_hook",
"before_ending",
"between_sections",
null
]
}
},
"required": [
"count",
"placement",
"style"
],
"additionalProperties": false
}
},
"required": [
"characters",
"dividers",
"emojis",
"hasBold",
"hasItalic",
"hasUnderline",
"paragraphs",
"rawLength",
"readabilityIndex",
"readingTimeMs",
"sentences",
"words"
],
"additionalProperties": false
},
"time_zone_name": {
"type": [
"string",
"null"
],
"description": "Not available for posts that were published without AuthoredUp.\nInternally, for those posts we fall back to the post author's time zone."
},
"reaction_counts": {
"type": "object"
},
"reaction_count": {
"type": [
"number",
"null"
]
},
"comment_count": {
"type": [
"number",
"null"
]
},
"share_count": {
"type": [
"number",
"null"
]
},
"impression_count": {
"type": [
"number",
"null"
]
},
"save_count": {
"type": [
"number",
"null"
]
},
"send_count": {
"type": [
"number",
"null"
]
},
"link_click_count": {
"type": [
"number",
"null"
]
},
"members_reached_count": {
"type": [
"number",
"null"
]
},
"profile_view_count": {
"type": [
"number",
"null"
]
},
"followers_gained_count": {
"type": [
"number",
"null"
]
},
"engagement_rate": {
"type": "number",
"description": "Calculated as: reactions + comments + shares / impressions\nOnly available if all the data is available."
},
"did_self_like": {
"type": [
"boolean",
"null"
]
},
"post_scheduled_date": {
"description": "This is the date the post has been scheduled for publishing. It will stay set even after the post has been published.\nWe won't have this data for posts that were published without AuthoredUp.",
"type": [
"string",
"null"
],
"format": "date-time"
},
"post_created_at": {
"description": "This data is correct for posts that were created with AuthoredUp, and estimated for others.",
"type": "string",
"format": "date-time"
},
"post_updated_at": {
"description": "We can precisely tell when this happens if you use AuthoredUp. Otherwise, we estimate it the best we can.",
"type": "string",
"format": "date-time"
},
"post_published_at": {
"description": "This data can be accurately estimated from the data provided by LinkedIn, so you can rely on it pretty confidently.",
"type": [
"string",
"null"
],
"format": "date-time"
},
"post_deleted_at": {
"description": "If we've detected the post has been deleted, this will be set to the date of deletion.",
"type": [
"string",
"null"
],
"format": "date-time"
},
"normalized_post_date": {
"description": "Date that is derived from the deleted, published, scheduled or created date, in that order of priority.\nYou should be able to rely that you always have this date.",
"type": [
"string",
"null"
],
"format": "date-time"
}
},
"required": [
"activity_urn",
"actor_company_id",
"actor_group_id",
"actor_profile_id",
"comment_count",
"content_type",
"did_self_like",
"engagement_rate",
"followers_gained_count",
"hashtags",
"impression_count",
"link_click_count",
"markdown_content",
"members_reached_count",
"normalized_post_date",
"post_created_at",
"post_deleted_at",
"post_published_at",
"post_scheduled_date",
"post_updated_at",
"profile_view_count",
"reaction_count",
"reaction_counts",
"save_count",
"send_count",
"share_count",
"text",
"text_attributes",
"text_metrics",
"time_zone_name",
"urn"
],
"additionalProperties": false
}
},
"profiles": {
"type": "array",
"description": "All referenced actor profiles",
"items": {
"type": "object",
"properties": {
"id": {
"anyOf": [
{
"type": "string"
},
{
"type": "string"
}
]
},
"first_name": {
"type": "string"
},
"maiden_name": {
"type": "string",
"description": "This can also be the middle name, or a second first name (LinkedIn has renamed it in UI)"
},
"last_name": {
"type": "string"
},
"occupation": {
"type": "string",
"description": "Profile tagline"
},
"public_identifier": {
"type": "string",
"description": "This can be used to link to the profile on LinkedIn. Eg. https://www.linkedin.com/in/{identifier}"
},
"follower_count": {
"type": "number",
"description": "The latest follower count for the profile"
},
"connection_count": {
"type": "number",
"description": "The latest connection count for the profile"
},
"picture": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"original_name": {
"type": "string",
"description": "The original name of the image, including extension"
},
"format": {
"type": "string",
"description": "The format of the image, eg. \"jpg\", \"png\""
},
"size_in_bytes": {
"type": "number"
},
"width": {
"type": "number"
},
"height": {
"type": "number"
}
},
"required": [
"format",
"height",
"id",
"original_name",
"size_in_bytes",
"width"
],
"additionalProperties": false
},
"background_image": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"original_name": {
"type": "string",
"description": "The original name of the image, including extension"
},
"format": {
"type": "string",
"description": "The format of the image, eg. \"jpg\", \"png\""
},
"size_in_bytes": {
"type": "number"
},
"width": {
"type": "number"
},
"height": {
"type": "number"
}
},
"required": [
"format",
"height",
"id",
"original_name",
"size_in_bytes",
"width"
],
"additionalProperties": false
}
},
"required": [
"background_image",
"connection_count",
"first_name",
"follower_count",
"id",
"last_name",
"maiden_name",
"occupation",
"picture",
"public_identifier"
],
"additionalProperties": false
}
},
"companies": {
"type": "array",
"description": "All referenced actor companies",
"items": {
"type": "object",
"properties": {
"id": {
"anyOf": [
{
"type": "string"
},
{
"type": "string"
}
]
},
"name": {
"type": "string"
},
"universal_name": {
"type": "string",
"description": "Universal name is a unique identifier for the company, used in URLs"
},
"url": {
"type": "string",
"description": "Direct URL to the company page on LinkedIn"
},
"is_school": {
"type": "boolean",
"description": "Indicates if the company is a school or university"
},
"is_stub": {
"type": "boolean",
"description": "Indicates that we never received all the data about this company. Treat with caution."
},
"follower_count": {
"type": "number"
},
"logo": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"original_name": {
"type": "string",
"description": "The original name of the image, including extension"
},
"format": {
"type": "string",
"description": "The format of the image, eg. \"jpg\", \"png\""
},
"size_in_bytes": {
"type": "number"
},
"width": {
"type": "number"
},
"height": {
"type": "number"
}
},
"required": [
"format",
"height",
"id",
"original_name",
"size_in_bytes",
"width"
],
"additionalProperties": false
},
"cover_image": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"original_name": {
"type": "string",
"description": "The original name of the image, including extension"
},
"format": {
"type": "string",
"description": "The format of the image, eg. \"jpg\", \"png\""
},
"size_in_bytes": {
"type": "number"
},
"width": {
"type": "number"
},
"height": {
"type": "number"
}
},
"required": [
"format",
"height",
"id",
"original_name",
"size_in_bytes",
"width"
],
"additionalProperties": false
}
},
"required": [
"cover_image",
"follower_count",
"id",
"is_school",
"is_stub",
"logo",
"name",
"universal_name",
"url"
],
"additionalProperties": false
}
},
"groups": {
"type": "array",
"description": "All referenced actor groups",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"name": {
"type": "string"
},
"description": {
"type": "string"
},
"is_public": {
"type": "boolean"
},
"is_stub": {
"type": "boolean",
"description": "Indicates that we never received all the data about this group. Treat with caution."
},
"logo": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"original_name": {
"type": "string",
"description": "The original name of the image, including extension"
},
"format": {
"type": "string",
"description": "The format of the image, eg. \"jpg\", \"png\""
},
"size_in_bytes": {
"type": "number"
},
"width": {
"type": "number"
},
"height": {
"type": "number"
}
},
"required": [
"format",
"height",
"id",
"original_name",
"size_in_bytes",
"width"
],
"additionalProperties": false
}
},
"required": [
"description",
"id",
"is_public",
"is_stub",
"logo",
"name"
],
"additionalProperties": false
}
}
},
"required": [
"companies",
"groups",
"items",
"nextPageOffset",
"profiles"
],
"additionalProperties": false
},
"SavedPostDataCriteria": {
"type": "object",
"properties": {
"post-urn": {
"type": "string",
"description": "Pick individual posts by URN or activity URN"
},
"actors": {
"type": "array",
"description": "Filter list to a union of given actors",
"items": {
"type": "string"
}
},
"from-date": {
"description": "From which normalized date to start looking for posts. Provided as ISO 8601 date string.",
"type": "string",
"format": "date-time"
},
"to-date": {
"description": "To which normalized date to look for posts. Provided as ISO 8601 date string.",
"type": "string",
"format": "date-time"
},
"content-types": {
"type": "array",
"description": "Only provide posts with given content types.",
"items": {
"type": "string",
"enum": [
"Image",
"Document",
"Text",
"Repost",
"Reshare",
"Article",
"LinkedInVideo",
"Poll",
"ExternalVideo",
"Event",
"Entity",
"ScheduledLiveContent",
"Celebration",
"Newsletter",
"Slideshow",
"TextOverlayImage",
"Showcase",
"Review",
"Other"
]
}
},
"tags": {
"type": "array",
"description": "List of user tags to filter posts by",
"items": {
"type": "string"
}
},
"filter": {
"type": "string",
"description": "Loose string to filter rows by"
},
"sort-field": {
"type": "string",
"description": "Field to sort by (defaults to \"post_updated_at\")",
"enum": [
"urn",
"text",
"document",
"content_type",
"hashtags",
"images",
"actor_profile_id",
"actor_company_id",
"actor_group_id",
"text_metrics",
"time_zone_name",
"reaction_counts",
"reaction_count",
"comment_count",
"impression_count",
"did_self_like",
"text_attributes",
"save_count",
"send_count",
"members_reached_count",
"profile_view_count",
"followers_gained_count",
"link_click_count",
"post_scheduled_date",
"post_created_at",
"post_updated_at",
"post_published_at",
"post_deleted_at",
"activity_urn",
"markdown_content",
"share_count",
"engagement_rate",
"normalized_post_date",
"document.name",
"document.id",
"document.size_in_bytes",
"document.mime_type",
"document.recommended_extension",
"text_metrics.rawLength",
"text_metrics.characters",
"text_metrics.words",
"text_metrics.paragraphs",
"text_metrics.sentences",
"text_metrics.readingTimeMs",
"text_metrics.readabilityIndex",
"text_metrics.emojis",
"text_metrics.hasBold",
"text_metrics.hasItalic",
"text_metrics.hasUnderline",
"text_metrics.dividers",
"text_metrics.dividers.count",
"text_metrics.dividers.style",
"text_metrics.dividers.placement",
"reaction_counts.LIKE",
"reaction_counts.INTEREST",
"reaction_counts.PRAISE",
"reaction_counts.EMPATHY",
"reaction_counts.ENTERTAINMENT",
"reaction_counts.APPRECIATION",
"reaction_counts.MAYBE"
]
},
"sort-direction": {
"type": "string",
"description": "Direction to sort by (defaults to \"desc\")",
"enum": [
"asc",
"desc"
]
},
"limit": {
"type": "number",
"description": "How many records to return (defaults to 20, max 1000)"
},
"offset": {
"type": "number",
"description": "Start after this many items. Used for pagination"
},
"profile-ids": {
"type": "array",
"description": "List of the profiles for which to seek saved posts",
"items": {
"type": "string"
}
},
"include-hidden": {
"type": "boolean",
"description": "If true, also return posts that are hidden from the saved list"
}
},
"additionalProperties": false
},
"Actor": {
"type": "object",
"properties": {
"identifier": {
"type": "string",
"description": "For profiles, this is the profile ID (LNP_abcdef).\nFor companies, this is the company ID (LNC_abcdef).\nFor groups, this is the combination of a profile ID and group's numeric ID, separated by a \".\" (dot).\n For example: \"LNP_abcdef.123\""
},
"type": {
"type": "string",
"description": "The type of this actor. One of \"profile\", \"company\" or \"group\".",
"enum": [
"profile",
"company",
"group"
]
},
"profile": {
"type": "object",
"description": "Present for profile and group actors.",
"properties": {
"id": {
"anyOf": [
{
"type": "string"
},
{
"type": "string"
}
]
},
"first_name": {
"type": "string"
},
"maiden_name": {
"type": "string",
"description": "This can also be the middle name, or a second first name (LinkedIn has renamed it in UI)"
},
"last_name": {
"type": "string"
},
"occupation": {
"type": "string",
"description": "Profile tagline"
},
"public_identifier": {
"type": "string",
"description": "This can be used to link to the profile on LinkedIn. Eg. https://www.linkedin.com/in/{identifier}"
},
"follower_count": {
"type": "number",
"description": "The latest follower count for the profile"
},
"connection_count": {
"type": "number",
"description": "The latest connection count for the profile"
},
"picture": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"original_name": {
"type": "string",
"description": "The original name of the image, including extension"
},
"format": {
"type": "string",
"description": "The format of the image, eg. \"jpg\", \"png\""
},
"size_in_bytes": {
"type": "number"
},
"width": {
"type": "number"
},
"height": {
"type": "number"
}
},
"required": [
"format",
"height",
"id",
"original_name",
"size_in_bytes",
"width"
],
"additionalProperties": false
},
"background_image": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"original_name": {
"type": "string",
"description": "The original name of the image, including extension"
},
"format": {
"type": "string",
"description": "The format of the image, eg. \"jpg\", \"png\""
},
"size_in_bytes": {
"type": "number"
},
"width": {
"type": "number"
},
"height": {
"type": "number"
}
},
"required": [
"format",
"height",
"id",
"original_name",
"size_in_bytes",
"width"
],
"additionalProperties": false
}
},
"required": [
"background_image",
"connection_count",
"first_name",
"follower_count",
"id",
"last_name",
"maiden_name",
"occupation",
"picture",
"public_identifier"
],
"additionalProperties": false
},
"company": {
"type": "object",
"description": "Present for company actors.",
"properties": {
"id": {
"anyOf": [
{
"type": "string"
},
{
"type": "string"
}
]
},
"name": {
"type": "string"
},
"universal_name": {
"type": "string",
"description": "Universal name is a unique identifier for the company, used in URLs"
},
"url": {
"type": "string",
"description": "Direct URL to the company page on LinkedIn"
},
"is_school": {
"type": "boolean",
"description": "Indicates if the company is a school or university"
},
"is_stub": {
"type": "boolean",
"description": "Indicates that we never received all the data about this company. Treat with caution."
},
"follower_count": {
"type": "number"
},
"logo": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"original_name": {
"type": "string",
"description": "The original name of the image, including extension"
},
"format": {
"type": "string",
"description": "The format of the image, eg. \"jpg\", \"png\""
},
"size_in_bytes": {
"type": "number"
},
"width": {
"type": "number"
},
"height": {
"type": "number"
}
},
"required": [
"format",
"height",
"id",
"original_name",
"size_in_bytes",
"width"
],
"additionalProperties": false
},
"cover_image": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"original_name": {
"type": "string",
"description": "The original name of the image, including extension"
},
"format": {
"type": "string",
"description": "The format of the image, eg. \"jpg\", \"png\""
},
"size_in_bytes": {
"type": "number"
},
"width": {
"type": "number"
},
"height": {
"type": "number"
}
},
"required": [
"format",
"height",
"id",
"original_name",
"size_in_bytes",
"width"
],
"additionalProperties": false
}
},
"required": [
"cover_image",
"follower_count",
"id",
"is_school",
"is_stub",
"logo",
"name",
"universal_name",
"url"
],
"additionalProperties": false
},
"group": {
"type": "object",
"description": "Present for group actors.",
"properties": {
"id": {
"type": "string"
},
"name": {
"type": "string"
},
"description": {
"type": "string"
},
"is_public": {
"type": "boolean"
},
"is_stub": {
"type": "boolean",
"description": "Indicates that we never received all the data about this group. Treat with caution."
},
"logo": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"original_name": {
"type": "string",
"description": "The original name of the image, including extension"
},
"format": {
"type": "string",
"description": "The format of the image, eg. \"jpg\", \"png\""
},
"size_in_bytes": {
"type": "number"
},
"width": {
"type": "number"
},
"height": {
"type": "number"
}
},
"required": [
"format",
"height",
"id",
"original_name",
"size_in_bytes",
"width"
],
"additionalProperties": false
}
},
"required": [
"description",
"id",
"is_public",
"is_stub",
"logo",
"name"
],
"additionalProperties": false
}
},
"required": [
"identifier",
"type"
],
"additionalProperties": false
},
"OrganizationMember": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"name": {
"type": "string"
},
"role": {
"type": "string",
"enum": [
"admin",
"manager",
"member"
]
},
"started_at": {
"type": [
"string",
"null"
],
"format": "date-time"
},
"ended_at": {
"type": [
"string",
"null"
],
"format": "date-time"
},
"avatar": {
"type": [
"object",
"null"
],
"properties": {
"id": {
"type": "string"
},
"original_name": {
"type": "string",
"description": "The original name of the image, including extension"
},
"format": {
"type": "string",
"description": "The format of the image, eg. \"jpg\", \"png\""
},
"size_in_bytes": {
"type": "number"
},
"width": {
"type": "number"
},
"height": {
"type": "number"
}
},
"required": [
"format",
"height",
"id",
"original_name",
"size_in_bytes",
"width"
],
"additionalProperties": false
}
},
"required": [
"avatar",
"ended_at",
"id",
"name",
"role",
"started_at"
],
"additionalProperties": false
},
"DashboardProfileHistory": {
"type": "object",
"properties": {
"items": {
"type": "array",
"items": {
"type": "object",
"properties": {
"follower_count": {
"type": [
"number",
"null"
]
},
"connection_count": {
"type": [
"number",
"null"
]
},
"date": {
"type": "string",
"format": "date-time"
},
"estimated": {
"type": "boolean",
"description": "If true, this data point was estimated based on the collected history and other data points.\nSince LinkedIn doesn't provide precise follower counts for past dates, this is the best we can do."
}
},
"required": [
"connection_count",
"date",
"estimated",
"follower_count"
],
"additionalProperties": false
}
}
},
"required": [
"items"
],
"additionalProperties": false
},
"DashboardCompanyHistory": {
"type": "object",
"properties": {
"items": {
"type": "array",
"items": {
"type": "object",
"properties": {
"follower_count": {
"type": [
"number",
"null"
]
},
"date": {
"type": "string",
"format": "date-time"
}
},
"required": [
"date",
"follower_count"
],
"additionalProperties": false
}
}
},
"required": [
"items"
],
"additionalProperties": false
},
"DraftsCriteria": {
"type": "object",
"properties": {
"status": {
"type": "array",
"description": "Include only drafts with given statuses. Defaults to all but \"deleted\".",
"items": {
"type": "string",
"enum": [
"active",
"ready",
"submitted",
"deleted"
]
}
},
"actors": {
"type": "array",
"description": "Filter to drafts designated to the given actors (profile or company identifiers)",
"items": {
"type": "string"
}
},
"tags": {
"type": "array",
"description": "Only drafts labeled with all the given tags",
"items": {
"type": "string"
}
},
"filter": {
"type": "string",
"description": "Loose string to filter drafts by (matches id, title, text and linked post URN)"
},
"from-date": {
"description": "From which creation date to look for drafts. Provided as ISO 8601 date string.",
"type": "string",
"format": "date-time"
},
"to-date": {
"description": "To which creation date to look for drafts. Provided as ISO 8601 date string.",
"type": "string",
"format": "date-time"
},
"ownership": {
"type": "string",
"description": "\"owner\" returns only the user's own drafts, \"collaborator\" only drafts shared with them.\nDefaults to both.",
"enum": [
"owner",
"collaborator"
]
},
"sort-field": {
"description": "Field to sort by (defaults to \"updated_at\")",
"anyOf": [
{
"type": "string"
},
{
"type": "string"
},
{
"type": "string"
},
{
"type": "string"
}
]
},
"sort-direction": {
"type": "string",
"description": "Direction to sort by (defaults to \"desc\")",
"enum": [
"asc",
"desc"
]
},
"limit": {
"type": "number",
"description": "How many records to return (defaults to 20)"
},
"offset": {
"type": "number",
"description": "Start after this many items. Used for pagination"
}
},
"additionalProperties": false
},
"DraftQueryResult": {
"type": "object",
"properties": {
"nextPageOffset": {
"type": "number",
"description": "What offset should be set to grab the next page. If there are no more records, this will be null"
},
"items": {
"type": "array",
"items": {
"type": "object",
"properties": {
"markdown_content": {
"type": [
"string",
"null"
],
"description": "Draft text in markdown. Line breaks are preserved.\nSupports only inline styles: **bold**, *italic*, ***bold italic***, and `monospace`.\nEverything else is treated as plain text (including list markers, hashtags, and URLs; LinkedIn auto-links URLs).\nMentions use \"@[Name](identifier)\" (e.g. \"@[Jane Doe](LNP_abc123)\") with identifiers from the mentions endpoint.\nOnly entities previously mentioned in the user's posts are valid; Name is replaced with the entity's actual name.\nMention tokens cannot be inside styled (bold/italic) spans."
},
"title": {
"type": [
"string",
"null"
],
"description": "Internal title, used for organizing drafts in AuthoredUp. Not part of the post content."
},
"status": {
"type": "string",
"description": "Draft lifecycle status. \"active\" drafts are being worked on, \"ready\" drafts are marked as\nready to publish, \"submitted\" drafts have been published or scheduled, \"deleted\" drafts are removed.",
"enum": [
"active",
"ready",
"submitted",
"deleted"
]
},
"tags": {
"type": "array",
"description": "List of user tags for organizing drafts",
"items": {
"type": "string"
}
},
"actor_profile_id": {
"description": "Profile that should publish this draft. Groups are not supported for drafts.",
"anyOf": [
{
"type": "null"
},
{
"type": "string"
},
{
"type": "string"
}
]
},
"actor_company_id": {
"description": "Company that should publish this draft. Groups are not supported for drafts.",
"anyOf": [
{
"type": "null"
},
{
"type": "string"
},
{
"type": "string"
}
]
},
"publish_at": {
"description": "The time when the user plans to publish the draft. Must be in the future.",
"type": [
"string",
"null"
],
"format": "date-time"
},
"remind": {
"type": [
"boolean",
"null"
],
"description": "Whether the user should be reminded to publish this draft."
},
"version": {
"type": [
"number",
"null"
],
"description": "Current draft version. Provide this when replacing content to prevent conflicting updates."
},
"collaborator_ids": {
"type": [
"array",
"null"
],
"description": "Organization member IDs that have access to this draft.",
"items": {
"type": "string"
}
},
"id": {
"type": "string"
},
"text": {
"type": [
"string",
"null"
]
},
"text_attributes": {
"type": [
"array",
"null"
],
"items": {
"anyOf": [
{
"type": "object",
"properties": {
"start": {
"type": "number",
"description": "Codepoint index where the attribute starts"
},
"length": {
"type": "number",
"description": "Length in codepoints of the attribute"
},
"index": {
"type": "number"
},
"type": {
"type": "string"
},
"urnValue": {
"type": "string"
}
},
"required": [
"index",
"length",
"start",
"type",
"urnValue"
],
"additionalProperties": false
},
{
"type": "object",
"properties": {
"start": {
"type": "number",
"description": "Codepoint index where the attribute starts"
},
"length": {
"type": "number",
"description": "Length in codepoints of the attribute"
},
"index": {
"type": "number"
},
"type": {
"type": "string"
},
"urnValue": {
"type": "string"
},
"numericId": {
"type": "number",
"description": "Available only for some sources. It seems we can regenerate a mention without it."
}
},
"required": [
"index",
"length",
"start",
"type",
"urnValue"
],
"additionalProperties": false
},
{
"type": "object",
"properties": {
"start": {
"type": "number",
"description": "Codepoint index where the attribute starts"
},
"length": {
"type": "number",
"description": "Length in codepoints of the attribute"
},
"index": {
"type": "number"
},
"type": {
"type": "string"
},
"hashtag": {
"type": "string"
}
},
"required": [
"hashtag",
"index",
"length",
"start",
"type"
],
"additionalProperties": false
},
{
"type": "object",
"properties": {
"start": {
"type": "number",
"description": "Codepoint index where the attribute starts"
},
"length": {
"type": "number",
"description": "Length in codepoints of the attribute"
},
"index": {
"type": "number"
},
"type": {
"type": "string"
},
"rawLink": {
"type": "string"
},
"resolvedLink": {
"type": "string"
},
"linkType": {
"type": "string",
"enum": [
"external",
"internal",
"email"
]
}
},
"required": [
"index",
"length",
"linkType",
"rawLink",
"resolvedLink",
"start",
"type"
],
"additionalProperties": false
},
{
"type": "object",
"properties": {
"start": {
"type": "number",
"description": "Codepoint index where the attribute starts"
},
"length": {
"type": "number",
"description": "Length in codepoints of the attribute"
},
"index": {
"type": "number"
},
"type": {
"type": "string"
},
"publicIdentifier": {
"type": "string"
}
},
"required": [
"index",
"length",
"publicIdentifier",
"start",
"type"
],
"additionalProperties": false
},
{
"type": "object",
"properties": {
"start": {
"type": "number",
"description": "Codepoint index where the attribute starts"
},
"length": {
"type": "number",
"description": "Length in codepoints of the attribute"
},
"index": {
"type": "number"
},
"type": {
"type": "string"
},
"universalName": {
"type": "string"
}
},
"required": [
"index",
"length",
"start",
"type",
"universalName"
],
"additionalProperties": false
},
{
"type": "object",
"properties": {
"start": {
"type": "number",
"description": "Codepoint index where the attribute starts"
},
"length": {
"type": "number",
"description": "Length in codepoints of the attribute"
},
"index": {
"type": "number"
},
"type": {
"type": "string"
},
"font": {
"type": [
"string",
"null"
],
"enum": [
"bold",
"italic",
"boldItalic",
"monospace",
null
]
},
"styling": {
"type": [
"array",
"null"
],
"items": {
"type": "string",
"enum": [
"strikethrough",
"underline"
]
}
}
},
"required": [
"font",
"index",
"length",
"start",
"styling",
"type"
],
"additionalProperties": false
}
]
}
},
"based_on_draft_id": {
"type": [
"string",
"null"
],
"description": "The draft this draft was based on."
},
"collaborators": {
"type": "array",
"description": "Members with access to this draft.",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"name": {
"type": "string"
},
"role": {
"type": "string",
"enum": [
"admin",
"manager",
"member"
]
},
"started_at": {
"type": [
"string",
"null"
],
"format": "date-time"
},
"ended_at": {
"type": [
"string",
"null"
],
"format": "date-time"
},
"avatar": {
"type": [
"object",
"null"
],
"properties": {
"id": {
"type": "string"
},
"original_name": {
"type": "string",
"description": "The original name of the image, including extension"
},
"format": {
"type": "string",
"description": "The format of the image, eg. \"jpg\", \"png\""
},
"size_in_bytes": {
"type": "number"
},
"width": {
"type": "number"
},
"height": {
"type": "number"
}
},
"required": [
"format",
"height",
"id",
"original_name",
"size_in_bytes",
"width"
],
"additionalProperties": false
}
},
"required": [
"avatar",
"ended_at",
"id",
"name",
"role",
"started_at"
],
"additionalProperties": false
}
},
"owner": {
"type": [
"object",
"null"
],
"description": "Draft owner when it is shared with the current user.",
"properties": {
"id": {
"type": "string"
},
"name": {
"type": "string"
},
"role": {
"type": "string",
"enum": [
"admin",
"manager",
"member"
]
},
"started_at": {
"type": [
"string",
"null"
],
"format": "date-time"
},
"ended_at": {
"type": [
"string",
"null"
],
"format": "date-time"
},
"avatar": {
"type": [
"object",
"null"
],
"properties": {
"id": {
"type": "string"
},
"original_name": {
"type": "string",
"description": "The original name of the image, including extension"
},
"format": {
"type": "string",
"description": "The format of the image, eg. \"jpg\", \"png\""
},
"size_in_bytes": {
"type": "number"
},
"width": {
"type": "number"
},
"height": {
"type": "number"
}
},
"required": [
"format",
"height",
"id",
"original_name",
"size_in_bytes",
"width"
],
"additionalProperties": false
}
},
"required": [
"avatar",
"ended_at",
"id",
"name",
"role",
"started_at"
],
"additionalProperties": false
},
"ln_post_urn": {
"description": "Once the draft has been published, this is the URN of the resulting LinkedIn post."
},
"media_type": {
"type": [
"string",
"null"
],
"description": "Type of media attached to this draft (\"image\" or \"document\"), if any. Media cannot be viewed\nor managed through this API. Updating the draft text leaves its media untouched.",
"enum": [
"image",
"document",
null
]
},
"created_at": {
"type": "string",
"format": "date-time"
},
"updated_at": {
"type": "string",
"format": "date-time"
},
"marked_as_ready_at": {
"description": "When the draft was marked ready to publish.",
"type": [
"string",
"null"
],
"format": "date-time"
},
"adopted_at": {
"description": "When the draft was adopted.",
"type": [
"string",
"null"
],
"format": "date-time"
},
"submitted_at": {
"description": "When the draft was submitted for publishing.",
"type": [
"string",
"null"
],
"format": "date-time"
},
"deleted_at": {
"description": "When the draft was deleted.",
"type": [
"string",
"null"
],
"format": "date-time"
},
"reminded_at": {
"description": "When the user was last reminded to publish the draft.",
"type": [
"string",
"null"
],
"format": "date-time"
}
},
"required": [
"actor_company_id",
"actor_profile_id",
"adopted_at",
"based_on_draft_id",
"collaborator_ids",
"collaborators",
"created_at",
"deleted_at",
"id",
"ln_post_urn",
"markdown_content",
"marked_as_ready_at",
"media_type",
"owner",
"publish_at",
"remind",
"reminded_at",
"status",
"submitted_at",
"tags",
"text",
"text_attributes",
"title",
"updated_at"
],
"additionalProperties": false
}
},
"profiles": {
"type": "array",
"description": "All referenced profiles, including designated actor profiles and text mentions.",
"items": {
"type": "object",
"properties": {
"id": {
"anyOf": [
{
"type": "string"
},
{
"type": "string"
}
]
},
"first_name": {
"type": "string"
},
"maiden_name": {
"type": "string",
"description": "This can also be the middle name, or a second first name (LinkedIn has renamed it in UI)"
},
"last_name": {
"type": "string"
},
"occupation": {
"type": "string",
"description": "Profile tagline"
},
"public_identifier": {
"type": "string",
"description": "This can be used to link to the profile on LinkedIn. Eg. https://www.linkedin.com/in/{identifier}"
},
"follower_count": {
"type": "number",
"description": "The latest follower count for the profile"
},
"connection_count": {
"type": "number",
"description": "The latest connection count for the profile"
},
"picture": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"original_name": {
"type": "string",
"description": "The original name of the image, including extension"
},
"format": {
"type": "string",
"description": "The format of the image, eg. \"jpg\", \"png\""
},
"size_in_bytes": {
"type": "number"
},
"width": {
"type": "number"
},
"height": {
"type": "number"
}
},
"required": [
"format",
"height",
"id",
"original_name",
"size_in_bytes",
"width"
],
"additionalProperties": false
},
"background_image": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"original_name": {
"type": "string",
"description": "The original name of the image, including extension"
},
"format": {
"type": "string",
"description": "The format of the image, eg. \"jpg\", \"png\""
},
"size_in_bytes": {
"type": "number"
},
"width": {
"type": "number"
},
"height": {
"type": "number"
}
},
"required": [
"format",
"height",
"id",
"original_name",
"size_in_bytes",
"width"
],
"additionalProperties": false
}
},
"required": [
"background_image",
"connection_count",
"first_name",
"follower_count",
"id",
"last_name",
"maiden_name",
"occupation",
"picture",
"public_identifier"
],
"additionalProperties": false
}
},
"companies": {
"type": "array",
"description": "All referenced companies, including designated actor companies and text mentions.",
"items": {
"type": "object",
"properties": {
"id": {
"anyOf": [
{
"type": "string"
},
{
"type": "string"
}
]
},
"name": {
"type": "string"
},
"universal_name": {
"type": "string",
"description": "Universal name is a unique identifier for the company, used in URLs"
},
"url": {
"type": "string",
"description": "Direct URL to the company page on LinkedIn"
},
"is_school": {
"type": "boolean",
"description": "Indicates if the company is a school or university"
},
"is_stub": {
"type": "boolean",
"description": "Indicates that we never received all the data about this company. Treat with caution."
},
"follower_count": {
"type": "number"
},
"logo": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"original_name": {
"type": "string",
"description": "The original name of the image, including extension"
},
"format": {
"type": "string",
"description": "The format of the image, eg. \"jpg\", \"png\""
},
"size_in_bytes": {
"type": "number"
},
"width": {
"type": "number"
},
"height": {
"type": "number"
}
},
"required": [
"format",
"height",
"id",
"original_name",
"size_in_bytes",
"width"
],
"additionalProperties": false
},
"cover_image": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"original_name": {
"type": "string",
"description": "The original name of the image, including extension"
},
"format": {
"type": "string",
"description": "The format of the image, eg. \"jpg\", \"png\""
},
"size_in_bytes": {
"type": "number"
},
"width": {
"type": "number"
},
"height": {
"type": "number"
}
},
"required": [
"format",
"height",
"id",
"original_name",
"size_in_bytes",
"width"
],
"additionalProperties": false
}
},
"required": [
"cover_image",
"follower_count",
"id",
"is_school",
"is_stub",
"logo",
"name",
"universal_name",
"url"
],
"additionalProperties": false
}
}
},
"required": [
"companies",
"items",
"nextPageOffset",
"profiles"
],
"additionalProperties": false
},
"Draft": {
"type": "object",
"properties": {
"markdown_content": {
"type": [
"string",
"null"
],
"description": "Draft text in markdown. Line breaks are preserved.\nSupports only inline styles: **bold**, *italic*, ***bold italic***, and `monospace`.\nEverything else is treated as plain text (including list markers, hashtags, and URLs; LinkedIn auto-links URLs).\nMentions use \"@[Name](identifier)\" (e.g. \"@[Jane Doe](LNP_abc123)\") with identifiers from the mentions endpoint.\nOnly entities previously mentioned in the user's posts are valid; Name is replaced with the entity's actual name.\nMention tokens cannot be inside styled (bold/italic) spans."
},
"title": {
"type": [
"string",
"null"
],
"description": "Internal title, used for organizing drafts in AuthoredUp. Not part of the post content."
},
"status": {
"type": "string",
"description": "Draft lifecycle status. \"active\" drafts are being worked on, \"ready\" drafts are marked as\nready to publish, \"submitted\" drafts have been published or scheduled, \"deleted\" drafts are removed.",
"enum": [
"active",
"ready",
"submitted",
"deleted"
]
},
"tags": {
"type": "array",
"description": "List of user tags for organizing drafts",
"items": {
"type": "string"
}
},
"actor_profile_id": {
"description": "Profile that should publish this draft. Groups are not supported for drafts.",
"anyOf": [
{
"type": "null"
},
{
"type": "string"
},
{
"type": "string"
}
]
},
"actor_company_id": {
"description": "Company that should publish this draft. Groups are not supported for drafts.",
"anyOf": [
{
"type": "null"
},
{
"type": "string"
},
{
"type": "string"
}
]
},
"publish_at": {
"description": "The time when the user plans to publish the draft. Must be in the future.",
"type": [
"string",
"null"
],
"format": "date-time"
},
"remind": {
"type": [
"boolean",
"null"
],
"description": "Whether the user should be reminded to publish this draft."
},
"version": {
"type": [
"number",
"null"
],
"description": "Current draft version. Provide this when replacing content to prevent conflicting updates."
},
"collaborator_ids": {
"type": [
"array",
"null"
],
"description": "Organization member IDs that have access to this draft.",
"items": {
"type": "string"
}
},
"id": {
"type": "string"
},
"text": {
"type": [
"string",
"null"
]
},
"text_attributes": {
"type": [
"array",
"null"
],
"items": {
"anyOf": [
{
"type": "object",
"properties": {
"start": {
"type": "number",
"description": "Codepoint index where the attribute starts"
},
"length": {
"type": "number",
"description": "Length in codepoints of the attribute"
},
"index": {
"type": "number"
},
"type": {
"type": "string"
},
"urnValue": {
"type": "string"
}
},
"required": [
"index",
"length",
"start",
"type",
"urnValue"
],
"additionalProperties": false
},
{
"type": "object",
"properties": {
"start": {
"type": "number",
"description": "Codepoint index where the attribute starts"
},
"length": {
"type": "number",
"description": "Length in codepoints of the attribute"
},
"index": {
"type": "number"
},
"type": {
"type": "string"
},
"urnValue": {
"type": "string"
},
"numericId": {
"type": "number",
"description": "Available only for some sources. It seems we can regenerate a mention without it."
}
},
"required": [
"index",
"length",
"start",
"type",
"urnValue"
],
"additionalProperties": false
},
{
"type": "object",
"properties": {
"start": {
"type": "number",
"description": "Codepoint index where the attribute starts"
},
"length": {
"type": "number",
"description": "Length in codepoints of the attribute"
},
"index": {
"type": "number"
},
"type": {
"type": "string"
},
"hashtag": {
"type": "string"
}
},
"required": [
"hashtag",
"index",
"length",
"start",
"type"
],
"additionalProperties": false
},
{
"type": "object",
"properties": {
"start": {
"type": "number",
"description": "Codepoint index where the attribute starts"
},
"length": {
"type": "number",
"description": "Length in codepoints of the attribute"
},
"index": {
"type": "number"
},
"type": {
"type": "string"
},
"rawLink": {
"type": "string"
},
"resolvedLink": {
"type": "string"
},
"linkType": {
"type": "string",
"enum": [
"external",
"internal",
"email"
]
}
},
"required": [
"index",
"length",
"linkType",
"rawLink",
"resolvedLink",
"start",
"type"
],
"additionalProperties": false
},
{
"type": "object",
"properties": {
"start": {
"type": "number",
"description": "Codepoint index where the attribute starts"
},
"length": {
"type": "number",
"description": "Length in codepoints of the attribute"
},
"index": {
"type": "number"
},
"type": {
"type": "string"
},
"publicIdentifier": {
"type": "string"
}
},
"required": [
"index",
"length",
"publicIdentifier",
"start",
"type"
],
"additionalProperties": false
},
{
"type": "object",
"properties": {
"start": {
"type": "number",
"description": "Codepoint index where the attribute starts"
},
"length": {
"type": "number",
"description": "Length in codepoints of the attribute"
},
"index": {
"type": "number"
},
"type": {
"type": "string"
},
"universalName": {
"type": "string"
}
},
"required": [
"index",
"length",
"start",
"type",
"universalName"
],
"additionalProperties": false
},
{
"type": "object",
"properties": {
"start": {
"type": "number",
"description": "Codepoint index where the attribute starts"
},
"length": {
"type": "number",
"description": "Length in codepoints of the attribute"
},
"index": {
"type": "number"
},
"type": {
"type": "string"
},
"font": {
"type": [
"string",
"null"
],
"enum": [
"bold",
"italic",
"boldItalic",
"monospace",
null
]
},
"styling": {
"type": [
"array",
"null"
],
"items": {
"type": "string",
"enum": [
"strikethrough",
"underline"
]
}
}
},
"required": [
"font",
"index",
"length",
"start",
"styling",
"type"
],
"additionalProperties": false
}
]
}
},
"based_on_draft_id": {
"type": [
"string",
"null"
],
"description": "The draft this draft was based on."
},
"collaborators": {
"type": "array",
"description": "Members with access to this draft.",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"name": {
"type": "string"
},
"role": {
"type": "string",
"enum": [
"admin",
"manager",
"member"
]
},
"started_at": {
"type": [
"string",
"null"
],
"format": "date-time"
},
"ended_at": {
"type": [
"string",
"null"
],
"format": "date-time"
},
"avatar": {
"type": [
"object",
"null"
],
"properties": {
"id": {
"type": "string"
},
"original_name": {
"type": "string",
"description": "The original name of the image, including extension"
},
"format": {
"type": "string",
"description": "The format of the image, eg. \"jpg\", \"png\""
},
"size_in_bytes": {
"type": "number"
},
"width": {
"type": "number"
},
"height": {
"type": "number"
}
},
"required": [
"format",
"height",
"id",
"original_name",
"size_in_bytes",
"width"
],
"additionalProperties": false
}
},
"required": [
"avatar",
"ended_at",
"id",
"name",
"role",
"started_at"
],
"additionalProperties": false
}
},
"owner": {
"type": [
"object",
"null"
],
"description": "Draft owner when it is shared with the current user.",
"properties": {
"id": {
"type": "string"
},
"name": {
"type": "string"
},
"role": {
"type": "string",
"enum": [
"admin",
"manager",
"member"
]
},
"started_at": {
"type": [
"string",
"null"
],
"format": "date-time"
},
"ended_at": {
"type": [
"string",
"null"
],
"format": "date-time"
},
"avatar": {
"type": [
"object",
"null"
],
"properties": {
"id": {
"type": "string"
},
"original_name": {
"type": "string",
"description": "The original name of the image, including extension"
},
"format": {
"type": "string",
"description": "The format of the image, eg. \"jpg\", \"png\""
},
"size_in_bytes": {
"type": "number"
},
"width": {
"type": "number"
},
"height": {
"type": "number"
}
},
"required": [
"format",
"height",
"id",
"original_name",
"size_in_bytes",
"width"
],
"additionalProperties": false
}
},
"required": [
"avatar",
"ended_at",
"id",
"name",
"role",
"started_at"
],
"additionalProperties": false
},
"ln_post_urn": {
"description": "Once the draft has been published, this is the URN of the resulting LinkedIn post."
},
"media_type": {
"type": [
"string",
"null"
],
"description": "Type of media attached to this draft (\"image\" or \"document\"), if any. Media cannot be viewed\nor managed through this API. Updating the draft text leaves its media untouched.",
"enum": [
"image",
"document",
null
]
},
"created_at": {
"type": "string",
"format": "date-time"
},
"updated_at": {
"type": "string",
"format": "date-time"
},
"marked_as_ready_at": {
"description": "When the draft was marked ready to publish.",
"type": [
"string",
"null"
],
"format": "date-time"
},
"adopted_at": {
"description": "When the draft was adopted.",
"type": [
"string",
"null"
],
"format": "date-time"
},
"submitted_at": {
"description": "When the draft was submitted for publishing.",
"type": [
"string",
"null"
],
"format": "date-time"
},
"deleted_at": {
"description": "When the draft was deleted.",
"type": [
"string",
"null"
],
"format": "date-time"
},
"reminded_at": {
"description": "When the user was last reminded to publish the draft.",
"type": [
"string",
"null"
],
"format": "date-time"
}
},
"required": [
"actor_company_id",
"actor_profile_id",
"adopted_at",
"based_on_draft_id",
"collaborator_ids",
"collaborators",
"created_at",
"deleted_at",
"id",
"ln_post_urn",
"markdown_content",
"marked_as_ready_at",
"media_type",
"owner",
"publish_at",
"remind",
"reminded_at",
"status",
"submitted_at",
"tags",
"text",
"text_attributes",
"title",
"updated_at"
],
"additionalProperties": false
},
"DraftPayload": {
"type": "object",
"properties": {
"markdown_content": {
"type": [
"string",
"null"
],
"description": "Draft text in markdown. Line breaks are preserved.\nSupports only inline styles: **bold**, *italic*, ***bold italic***, and `monospace`.\nEverything else is treated as plain text (including list markers, hashtags, and URLs; LinkedIn auto-links URLs).\nMentions use \"@[Name](identifier)\" (e.g. \"@[Jane Doe](LNP_abc123)\") with identifiers from the mentions endpoint.\nOnly entities previously mentioned in the user's posts are valid; Name is replaced with the entity's actual name.\nMention tokens cannot be inside styled (bold/italic) spans."
},
"title": {
"type": [
"string",
"null"
],
"description": "Internal title, used for organizing drafts in AuthoredUp. Not part of the post content."
},
"status": {
"type": "string",
"description": "Draft lifecycle status. \"active\" drafts are being worked on, \"ready\" drafts are marked as\nready to publish, \"submitted\" drafts have been published or scheduled, \"deleted\" drafts are removed.",
"enum": [
"active",
"ready",
"submitted",
"deleted"
]
},
"tags": {
"type": "array",
"description": "List of user tags for organizing drafts",
"items": {
"type": "string"
}
},
"actor_profile_id": {
"description": "Profile that should publish this draft. Groups are not supported for drafts.",
"anyOf": [
{
"type": "null"
},
{
"type": "string"
},
{
"type": "string"
}
]
},
"actor_company_id": {
"description": "Company that should publish this draft. Groups are not supported for drafts.",
"anyOf": [
{
"type": "null"
},
{
"type": "string"
},
{
"type": "string"
}
]
},
"publish_at": {
"description": "The time when the user plans to publish the draft. Must be in the future.",
"type": [
"string",
"null"
],
"format": "date-time"
},
"remind": {
"type": [
"boolean",
"null"
],
"description": "Whether the user should be reminded to publish this draft."
},
"version": {
"type": [
"number",
"null"
],
"description": "Current draft version. Provide this when replacing content to prevent conflicting updates."
},
"collaborator_ids": {
"type": [
"array",
"null"
],
"description": "Organization member IDs that have access to this draft.",
"items": {
"type": "string"
}
}
},
"additionalProperties": false
},
"MentionsCriteria": {
"type": "object",
"properties": {
"filter": {
"type": "string",
"description": "Loose string to filter candidates by name"
},
"actors": {
"type": "array",
"description": "Only list entities mentioned in posts of given actors",
"items": {
"type": "string"
}
},
"limit": {
"type": "number",
"description": "How many records to return (defaults to 20)"
},
"offset": {
"type": "number",
"description": "Start after this many items. Used for pagination"
}
},
"additionalProperties": false
},
"MentionQueryResult": {
"type": "object",
"properties": {
"nextPageOffset": {
"type": "number",
"description": "What offset should be set to grab the next page. If there are no more records, this will be null"
},
"items": {
"type": "array",
"items": {
"type": "object",
"properties": {
"type": {
"anyOf": [
{
"type": "string"
},
{
"type": "string"
}
]
},
"ln_profile_id": {
"anyOf": [
{
"type": "null"
},
{
"type": "string"
},
{
"type": "string"
}
]
},
"ln_company_id": {
"anyOf": [
{
"type": "null"
},
{
"type": "string"
},
{
"type": "string"
}
]
},
"title": {
"type": "string"
},
"last_interaction_at": {
"type": "string",
"format": "date-time"
}
},
"required": [
"last_interaction_at",
"ln_company_id",
"ln_profile_id",
"title",
"type"
],
"additionalProperties": false
}
},
"profiles": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"anyOf": [
{
"type": "string"
},
{
"type": "string"
}
]
},
"first_name": {
"type": "string"
},
"maiden_name": {
"type": "string",
"description": "This can also be the middle name, or a second first name (LinkedIn has renamed it in UI)"
},
"last_name": {
"type": "string"
},
"occupation": {
"type": "string",
"description": "Profile tagline"
},
"public_identifier": {
"type": "string",
"description": "This can be used to link to the profile on LinkedIn. Eg. https://www.linkedin.com/in/{identifier}"
},
"follower_count": {
"type": "number",
"description": "The latest follower count for the profile"
},
"connection_count": {
"type": "number",
"description": "The latest connection count for the profile"
},
"picture": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"original_name": {
"type": "string",
"description": "The original name of the image, including extension"
},
"format": {
"type": "string",
"description": "The format of the image, eg. \"jpg\", \"png\""
},
"size_in_bytes": {
"type": "number"
},
"width": {
"type": "number"
},
"height": {
"type": "number"
}
},
"required": [
"format",
"height",
"id",
"original_name",
"size_in_bytes",
"width"
],
"additionalProperties": false
},
"background_image": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"original_name": {
"type": "string",
"description": "The original name of the image, including extension"
},
"format": {
"type": "string",
"description": "The format of the image, eg. \"jpg\", \"png\""
},
"size_in_bytes": {
"type": "number"
},
"width": {
"type": "number"
},
"height": {
"type": "number"
}
},
"required": [
"format",
"height",
"id",
"original_name",
"size_in_bytes",
"width"
],
"additionalProperties": false
}
},
"required": [
"background_image",
"connection_count",
"first_name",
"follower_count",
"id",
"last_name",
"maiden_name",
"occupation",
"picture",
"public_identifier"
],
"additionalProperties": false
}
},
"companies": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"anyOf": [
{
"type": "string"
},
{
"type": "string"
}
]
},
"name": {
"type": "string"
},
"universal_name": {
"type": "string",
"description": "Universal name is a unique identifier for the company, used in URLs"
},
"url": {
"type": "string",
"description": "Direct URL to the company page on LinkedIn"
},
"is_school": {
"type": "boolean",
"description": "Indicates if the company is a school or university"
},
"is_stub": {
"type": "boolean",
"description": "Indicates that we never received all the data about this company. Treat with caution."
},
"follower_count": {
"type": "number"
},
"logo": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"original_name": {
"type": "string",
"description": "The original name of the image, including extension"
},
"format": {
"type": "string",
"description": "The format of the image, eg. \"jpg\", \"png\""
},
"size_in_bytes": {
"type": "number"
},
"width": {
"type": "number"
},
"height": {
"type": "number"
}
},
"required": [
"format",
"height",
"id",
"original_name",
"size_in_bytes",
"width"
],
"additionalProperties": false
},
"cover_image": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"original_name": {
"type": "string",
"description": "The original name of the image, including extension"
},
"format": {
"type": "string",
"description": "The format of the image, eg. \"jpg\", \"png\""
},
"size_in_bytes": {
"type": "number"
},
"width": {
"type": "number"
},
"height": {
"type": "number"
}
},
"required": [
"format",
"height",
"id",
"original_name",
"size_in_bytes",
"width"
],
"additionalProperties": false
}
},
"required": [
"cover_image",
"follower_count",
"id",
"is_school",
"is_stub",
"logo",
"name",
"universal_name",
"url"
],
"additionalProperties": false
}
}
},
"required": [
"companies",
"items",
"nextPageOffset",
"profiles"
],
"additionalProperties": false
},
"UserTag": {
"type": "object",
"properties": {
"tag": {
"type": "string"
},
"post_count": {
"type": "number",
"description": "Number of the user's posts labeled with this tag"
},
"draft_count": {
"type": "number",
"description": "Number of the user's drafts labeled with this tag"
}
},
"required": [
"draft_count",
"post_count",
"tag"
],
"additionalProperties": false
}
},
"securitySchemes": {
"bearer_user_api_token": {
"type": "http",
"scheme": "bearer",
"name": "user_api_token",
"description": "Bearer token mechanism: \"user_api_token\""
},
"bearer_oauth_token": {
"type": "http",
"scheme": "bearer",
"name": "oauth_token",
"description": "Bearer token mechanism: \"oauth_token\""
}
}
}
}