HighLevel: Fetch calendar view for an edit session

← Social planner operations · Get started

Operation gohighlevel.fetcheditsessioncalendar

Provider route: POST /social-media-posting/category/queues/{queueId}/edit/calendar. 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"]["fetchEditSessionCalendar"]>[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.fetchEditSessionCalendar(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.fetch_edit_session_calendar(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.queueId	string	Required within parent
body	Model	Required within parent	Expand Fetch calendar view for an edit session — request body — body

Referenced models: Fetch calendar view for an edit session — request body — body

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 Fetch calendar view for an edit session — response body

Referenced models: Fetch calendar view for an edit session — response body

Schemas

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

Fetch calendar view for an edit session — request body — body

Field	Type	Presence	Description and constraints
$	object	Root
accountIds	array	Optional	Filter by Account IDs. If not provided or empty, returns all posts.
accountIds[]	string	Each item
endDate	string	Required within parent	End Date in ISO format
locationId	string	Required within parent	Location ID
sessionId	string	Required within parent	Edit session ID
startDate	string	Required within parent	Start Date in ISO format

Fetch calendar view for an edit session — response body

Field	Type	Presence	Description and constraints
$	object	Root
results	Model	Required within parent	Expand Fetch calendar view for an edit session — response body — results
statusCode	JSON	Required within parent
statusCode (anyOf 1)	number	Alternative
statusCode (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
success	boolean	Required within parent
traceId	string	Optional

Referenced models: Fetch calendar view for an edit session — response body — results

Fetch calendar view for an edit session — response body — results

Field	Type	Presence	Description and constraints
$	object	Root
message	string	Optional
scheduledPosts	array	Optional
scheduledPosts[]	Model	Each item	Expand Fetch calendar view for an edit session — response body — results scheduled Posts item
timezone	string	Optional	The timezone used for scheduling, e.g., "Asia/Calcutta"
total	JSON	Optional
total (anyOf 1)	number	Alternative	Total number of scheduled posts returned
total (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$

Referenced models: Fetch calendar view for an edit session — response body — results scheduled Posts item

Fetch calendar view for an edit session — response body — results scheduled Posts item

Field	Type	Presence	Description and constraints
$	object	Root
category	JSON	Optional
category (anyOf 1)	JSON	Alternative	The category associated with this post
category (anyOf 1) (allOf 1)	Model	All variants apply	Expand Fetch category queues for a location — response body — results queues item category id, created At, created By, deleted, location Id, name, primary Color, secondary Color, updated At
category (anyOf 2)	null	Alternative
currentVariation	JSON	Optional
currentVariation (anyOf 1)	number	Alternative	The index of the current variation being used for this post
currentVariation (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
errors	array	Optional	List of errors associated with the queue item. Possible values: INVALID_USER_ID, PIXABAY_MEDIA.
errors[]	string	Each item
isDraft	boolean	Optional	Indicates this is a draft item from an edit session
order	JSON	Optional
order (anyOf 1)	number	Alternative	The order of the item in the queue.
order (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
originalItemId	JSON	Optional
originalItemId (anyOf 1)	string	Alternative	Original queue item ID if this draft was created from an existing item
originalItemId (anyOf 2)	null	Alternative
post	JSON	Optional	The formatted post data.
post (allOf 1)	Model	All variants apply	Expand Get posts — response body — results count, posts posts item
primaryImage	string	Optional	The primary image URL for the post.
queueId	string	Optional	The ID of the queue this post belongs to
queueItemId	string	Optional	The unique identifier of the queue item.
scheduledDateTime	string	Optional	The date and time the post is scheduled to be published Format: date-time
timezone	string	Optional	The timezone in which the post is scheduled
variations	array	Optional	A list of content variations for the post.
variations[]	Model	Each item	Expand Fetch items from a queue — response body — results items item variations item

Referenced models: Fetch category queues for a location — response body — results queues item category id, created At, created By, deleted, location Id, name, primary Color, secondary Color, updated At, Get posts — response body — results count, posts posts item, Fetch items from a queue — response body — results items item variations item

Fetch category queues for a location — response body — results queues item category id, created At, created By, deleted, location Id, name, primary Color, secondary Color, updated At

Field	Type	Presence	Description and constraints
$	object	Root
_id	string	Optional	Category ID
createdAt	string	Optional	Creation timestamp
createdBy	string	Optional	ID of the user who created the category
deleted	boolean	Optional	Indicates if the category is deleted
locationId	string	Optional	Location ID
name	string	Optional	Name of the category
primaryColor	string	Optional	Primary color of the category
secondaryColor	string	Optional	Secondary color of the category
updatedAt	string	Optional	Last update timestamp

Fetch items from a queue — response body — results items item variations item

Field	Type	Presence	Description and constraints
$	object	Root
_id	string	Optional	The ID of the variation.
content	string	Optional	The text content of the variation.
mentions	array	Optional	Platform-specific mentions within the content (e.g., @username references).
mentions[]	object	Each item
ogTags	JSON	Optional	Open Graph tags for link previews.
ogTags (allOf 1)	Model	All variants apply	Expand Fetch items from a queue — response body — results items item variations item og Tags meta Image, meta Link, og Title

Referenced models: Fetch items from a queue — response body — results items item variations item og Tags meta Image, meta Link, og Title

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

Field	Type	Presence	Description and constraints
$	object	Root
externalLink	string	Optional	External URL to embed as a link card in the post.
externalLinkDescription	string	Optional	Description for the external link card. Brief summary displayed below the title.
externalLinkTitle	string	Optional	Title for the external link card. Displayed prominently in the embed.
language	string	Optional	ISO 639-1 language code for the post content. **Examples:** `en` (English), `es` (Spanish), `fr` (French), `de` (German)
quotePost	string	Optional	Bluesky AT Protocol URI of a post to quote. **Format:** `at://did:plc:{user-id}/app.bsky.feed.post/{post-id}` **Use Case:** Quote-post another user's post with your commentary.
replyTo	string	Optional	Bluesky AT Protocol URI of a post to reply to. **Format:** `at://did:plc:{user-id}/app.bsky.feed.post/{post-id}` **Use Case:** Create a reply thread to an existing Bluesky post.
shortenedLinks	array	Optional	Shortened links for the post (auto-generated).
shortenedLinks[]	string	Each item

Edit post — request body — body og Tags Details meta Image, meta Link, og Description, og Title

Field	Type	Presence	Description and constraints
$	object	Root
metaImage	string	Optional	Preview image URL for the shared link. **Best Practices:** - Use high-quality images (1200x630px recommended) - Ensure the image is publicly accessible **Auto-fetch:** Use the Get Metatags API to fetch OG data from a URL.
metaLink	string	Optional	URL of the webpage being shared. This is the destination when users click the link preview.
ogDescription	string	Optional	Custom description for the link preview. Overrides the page's og:description meta tag. **Tip:** Keep descriptions under 155 characters for optimal display.
ogTitle	string	Optional	Custom title for the link preview. Overrides the page's og:title meta tag. **Tip:** Keep titles concise (50-60 characters) for best display across platforms.

Fetch items from a queue — response body — results items item variations item og Tags meta Image, meta Link, og Title

Field	Type	Presence	Description and constraints
$	object	Root
metaImage	object	Optional	URL of the content's primary image.
metaLink	object	Optional	The canonical URL of the content.
ogTitle	object	Optional	The title of the content.

Policy, approvals and errors

SDK function policy ID: gohighlevel.fetcheditsessioncalendar. Catalog operation: fetchEditSessionCalendar. 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/category.readonly"]

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

Official provider source