HighLevel: Get post

← Social planner operations · Get started

Operation gohighlevel.get_post

Provider route: GET /social-media-posting/{locationId}/posts/{id}. Alter supplies the connection’s credentials and routing.

Call through Alter

Install @alter-ai/sdk @alter-ai/gohighlevel with npm, or alter-sdk-gohighlevel with pip. Supply your connected customer’s grant ID and the arguments described below.

import { App } from "@alter-ai/sdk";
import { HighLevelIntegration } from "@alter-ai/gohighlevel";

async function execute(input: Parameters<HighLevelIntegration["socialPlanner"]["getPost"]>[0]) {
  const app = new App({ apiKey: process.env.ALTER_API_KEY! });
  try {
    const provider = new HighLevelIntegration(app, { grantId: process.env.PROVIDER_GRANT_ID! });
    const call = await provider.socialPlanner.getPost(input);
    const result = await call.wait();
    return result.bodyJson();
  } finally {
    await app.close();
  }
}

import os
from alter_sdk import App
from alter_sdk_gohighlevel import HighLevelIntegration

async def execute(arguments):
    async with App(api_key=os.environ["ALTER_API_KEY"]) as app:
        provider = HighLevelIntegration(app, {"grant_id": os.environ["PROVIDER_GRANT_ID"]})
        call = await provider.social_planner.get_post(arguments)
        result = await call.wait()
        return result.body_json()

Input

Field	Type	Presence	Description and constraints
$	object	Root	Additional keys: not allowed
path	object	Required within parent	Additional keys: not allowed
path.locationId	string	Required within parent
path.id	string	Required within parent

Response

Response media type: application/json. The table describes the pinned successful response. Referenced models link to their complete fields.

Field	Type	Presence	Description and constraints
$	Model	Root	Expand Get post — response body

Referenced models: Get post — response body

Schemas

20 more schemas are linked from the tables above, on the schema pages.

Get post — response body

Field	Type	Presence	Description and constraints
$	object	Root
message	string	Required within parent	Message
results	JSON	Optional	Requested Results
results (allOf 1)	Model	All variants apply	Expand Get post — response body — results post
statusCode	JSON	Required within parent
statusCode (anyOf 1)	number	Alternative	Status Code
statusCode (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
success	boolean	Required within parent	Success or Failure

Referenced models: Get post — response body — results post

Get post — response body — results post

Field	Type	Presence	Description and constraints
$	object	Root
post	JSON	Optional	Post Data
post (allOf 1)	Model	All variants apply	Expand Get posts — response body — results count, posts posts item

Referenced models: Get posts — response body — results count, posts posts item

Get posts — response body — results count, posts posts item

Field	Type	Presence	Description and constraints
$	object	Root
_id	string	Optional	MongoDB document ID of the post
accountId	string	Optional	Account Id
accountIds	array	Optional	Account Ids
accountIds[]	string	Each item
blueskyPostDetails	JSON	Optional	Bluesky Post Details
blueskyPostDetails (allOf 1)	Model	All variants apply	Expand Get posts — response body — results count, posts posts item bluesky Post Details external Link, external Link Description, external Link Title, language, quote Post, reply To, shortened Links
createdAt	string	Optional	Date when the post was created Format: date-time
createdBy	string	Optional	User ID who created the post
displayDate	string	Optional	Display date for the post Format: date-time
error	string	Required within parent	Error
facebookPostDetails	JSON	Optional	Facebook Post Details
facebookPostDetails (allOf 1)	Model	All variants apply	Expand Get posts — response body — results / count, posts / posts / item / facebookPostDetails / type: post, story, reel
gmbPostDetails	JSON	Optional	GMB Post Details
gmbPostDetails (allOf 1)	Model	All variants apply	Expand Get posts — response body — results / count, posts / posts / item / gmbPostDetails / actionType: none, order, book, shop, learn more, call, sign up, gmb Event Type: STANDARD, EVENT, OFFER
insights	JSON	Optional	Aggregated engagement metrics for the published post. Populated asynchronously by the insights sync workers for supported platforms (Facebook, Instagram, LinkedIn, YouTube). Absent on posts that have not been synced yet or on platforms where insights are not supported.
insights (allOf 1)	Model	All variants apply	Expand Get posts — response body — results count, posts posts item insights Aggregated engagement metrics for a published post
instagramPostDetails	JSON	Optional	Instagram Post Details
instagramPostDetails (allOf 1)	Model	All variants apply	Expand Get posts — response body — results / count, posts / posts / item / instagramPostDetails / type: post, story, reel
linkedinPostDetails	JSON	Optional	Linkedin Post Details
linkedinPostDetails (allOf 1)	Model	All variants apply	Expand Get posts — response body — results count, posts posts item linkedin Post Details pdf Title, poll, post As Pdf
locationId	string	Required within parent	Location Id
media	array	Optional	Post Media Data The limitations of media as per the platforms is provided through the reference link in API description
media[]	Model	Each item	Expand Get posts — response body — results count, posts posts item media item
mediaOptimization	boolean	Optional	Pass this parameter to optimize the image media
ogTagsDetails	JSON	Optional	Og Tags Meta Data
ogTagsDetails (allOf 1)	Model	All variants apply	Expand Edit post — request body — body og Tags Details meta Image, meta Link, og Description, og Title
pinterestPostDetails	JSON	Optional	Pinterest Post Details
pinterestPostDetails (allOf 1)	Model	All variants apply	Expand Edit post — request body — body pinterest Post Details board Ids, link, pinterest Boards, shortened Links, title
platform	string	Optional	platform must be one of the following values: google, facebook, instagram, linkedin, twitter, tiktok
postApprovalDetails	JSON	Optional	Post Approval Details
postApprovalDetails (allOf 1)	Model	All variants apply	Expand Get posts — response body — results / count, posts / posts / item / postApprovalDetails / approvalStatus: pending, approved, rejected, not required
postId	string	Optional	Platform-specific post identifier
publishedAt	string	Optional	Date when the post was published
source	string	Optional	source must be one of the following values: composer, recurring, csv Known values: composer, csv, recurring, review, rss
status	object	Optional	Status must be one of the following values: in_progress, draft, failed, published, scheduled, in_review, notification_sent, deleted
summary	string	Optional	Content text of the post
tags	array	Optional	Tag Ids
tags[]	string	Each item
thumbnail	string	Optional	Post-level cover image (thumbnail) URL. For posts that contain a video, this is the resolved cover image used for the first video in `media[]`. It is set automatically from the `thumbnail` provided on the first video media item at create/edit time, or auto-generated from the video when one is not supplied. Per-item thumbnails inside `media[]` are not retained on the response — the primary cover image lives on this field.
tiktokPostDetails	JSON	Optional	Tiktok Post Details
tiktokPostDetails (allOf 1)	Model	All variants apply	Expand Get posts — response body — results / count, posts / posts / item / tiktokPostDetails / privacyLevel: PUBLIC TO EVERYONE, MUTUAL FOLLOW FRIENDS, SELF ONLY
type	object	Required within parent	Post Type must be one of the following values: - post, story, reel
updatedAt	string	Optional	Date when the post was last updated Format: date-time
user	JSON	Optional	User
user (allOf 1)	Model	All variants apply	Expand Get posts — response body — results count, posts posts item user email, first Name, id, last Name, phone, profile Photo, title
youtubePostDetails	JSON	Optional	Youtube Post Details
youtubePostDetails (allOf 1)	Model	All variants apply	Expand Get posts — response body — results / count, posts / posts / item / youtubePostDetails / privacyLevel: private, public, unlisted, type: video, short

Referenced models: Get posts — response body — results count, posts posts item bluesky Post Details external Link, external Link Description, external Link Title, language, quote Post, reply To, shortened Links, Edit post — request body — body og Tags Details meta Image, meta Link, og Description, og Title, Get posts — response body — results / count, posts / posts / item / facebookPostDetails / type: post, story, reel, Get posts — response body — results / count, posts / posts / item / postApprovalDetails / approvalStatus: pending, approved, rejected, not required, Get posts — response body — results / count, posts / posts / item / gmbPostDetails / actionType: none, order, book, shop, learn more, call, sign up, gmb Event Type: STANDARD, EVENT, OFFER, Get posts — response body — results / count, posts / posts / item / instagramPostDetails / type: post, story, reel, Get posts — response body — results count, posts posts item linkedin Post Details pdf Title, poll, post As Pdf, Edit post — request body — body pinterest Post Details board Ids, link, pinterest Boards, shortened Links, title, Get posts — response body — results count, posts posts item insights Aggregated engagement metrics for a published post, Get posts — response body — results count, posts posts item media item, Get posts — response body — results count, posts posts item user email, first Name, id, last Name, phone, profile Photo, title, Get posts — response body — results / count, posts / posts / item / tiktokPostDetails / privacyLevel: PUBLIC TO EVERYONE, MUTUAL FOLLOW FRIENDS, SELF ONLY, Get posts — response body — results / count, posts / posts / item / youtubePostDetails / privacyLevel: private, public, unlisted, type: video, short

Edit post — request body — body linkedin Post Details pdf Title, poll, post As Pdf poll options, question, settings options item

Field	Type	Presence	Description and constraints
$	object	Root	Additional keys: not allowed
text	string	Required within parent	Text describing the option. Max length: 30 characters. Maximum length: 30

Policy, approvals and errors

SDK function policy ID: gohighlevel.get_post. Catalog operation: get-post. Rules can name either ID; function rules distinguish managed calls and conservatively cover raw calls sharing the route. Existing grant permissions and policy rules apply. wait() returns an immediate result or waits for a required approval; it never approves the request itself. Persist the approval ID to resume after a restart.

Provider errors retain their response; JSON decoding raises ProviderAPIError for provider failures. ManagedOperationError identifies contract/input/retention errors. See error handling and provider-specific behavior. Sensitive input may be refused before approval storage. A decoding error never resubmits a write.

Required provider scopes: ["socialplanner/post.readonly"]

Pinned headers: {"Version": "v3"}

Official provider source