HighLevel: Get CSV Post

← Social planner operations · Get started

Operation gohighlevel.get_csv_post

Provider route: GET /social-media-posting/{locationId}/csv/{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"]["getCsvPost"]>[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.getCsvPost(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_csv_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
query	object	Optional	Additional keys: not allowed
query.skip	string	Optional
query.limit	string	Optional

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 CSV Post — response body

Referenced models: Get CSV Post — response body

Schemas

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

Get CSV 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 CSV Post — response body — results count, csv, posts
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 CSV Post — response body — results count, csv, posts

Get CSV Post — response body — results count, csv, posts

Field	Type	Presence	Description and constraints
$	object	Root
count	JSON	Optional
count (anyOf 1)	number	Alternative	Total count of posts in CSV
count (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
csv	JSON	Optional	CSV Data
csv (allOf 1)	Model	All variants apply	Expand Get Upload Status — response body — results count, csvs csvs item
posts	array	Optional	CSV Posts
posts[]	Model	Each item	Expand Get CSV Post — response body — results count, csv, posts posts item

Referenced models: Get Upload Status — response body — results count, csvs csvs item, Get CSV Post — response body — results count, csv, posts posts item

Get Upload Status — response body — results count, csvs csvs item

Field	Type	Presence	Description and constraints
$	object	Root
accountIds	array	Optional	Account Ids
accountIds[]	string	Each item
applyWatermark	boolean	Optional	Apply watermark flag
approver	string	Optional	Approver Id
channel	string	Optional	Channel
count	JSON	Optional
count (anyOf 1)	number	Alternative	Posts count
count (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
createdAt	string	Optional	Date Created Format: date-time
createdBy	string	Optional	Created By Id
csvFileType	string	Optional	CSV file type Known values: basic, advance
file	string	Optional	File path
fileName	string	Optional	File Name
id	string	Optional	CSV Id
locationId	string	Optional	Location Id
mediaOptimization	boolean	Optional	Media optimization flag
originId	string	Optional	Origin Id
status	string	Optional	CSV import status Known values: pending, in_progress, completed, failed, in_review, importing, deleted
traceId	string	Optional	Trace Id
updatedAt	string	Optional	Date Updated Format: date-time

Get CSV Post — response body — results count, csv, posts posts item

Field	Type	Presence	Description and constraints
$	object	Root
accountIds	array	Optional	Account Ids
accountIds[]	string	Each item
applyWatermark	boolean	Optional	Apply watermark flag
csvFileType	string	Optional	CSV file type Known values: basic, advance
errorMessage	string	Optional	Error Description
followUpComment	string	Optional	Follow-up comment to be posted immediately after the main post is published. **Supported Platforms:** Facebook, Instagram, LinkedIn, YouTube **NOT Supported:** TikTok, Google My Business (GMB), Pinterest **Use Case:** Great for adding hashtags, additional context, or engagement prompts without cluttering the main post. - Follow-up comment is automatically trimmed to platform limits **Reference:** [Platform Limitations Guide](https://help.leadconnectorhq.com/support/solutions/articles/48001240003-social-planner-image-video-content-and-api-limitations)
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
link	JSON	Optional	OG Tag
link (allOf 1)	Model	All variants apply	Expand Get CSV Post — response body — results count, csv, posts posts item link error, og Description, og Image, og Site Name, og Title, og Url, url
mediaOptimization	boolean	Optional	Media optimization flag
medias	array	Optional	Post Media List
medias[]	Model	Each item	Expand Get CSV Post — response body — results count, csv, posts posts item medias item
scheduleDate	string	Optional	Schedule date for the post in ISO format
status	string	Optional	Post status Known values: pending, accepted, rejected, deleted
summary	string	Optional	Post content/summary
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	string	Optional	Post type - post, story, or reel
updatedAt	string	Optional	Date Updated Format: date-time

Referenced models: Get CSV Post — response body — results count, csv, posts posts item medias item, 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 CSV Post — response body — results count, csv, posts posts item link error, og Description, og Image, og Site Name, og Title, og Url, url, Get posts — response body — results / count, posts / posts / item / tiktokPostDetails / privacyLevel: PUBLIC TO EVERYONE, MUTUAL FOLLOW FRIENDS, SELF ONLY

Get CSV Post — response body — results count, csv, posts posts item link error, og Description, og Image, og Site Name, og Title, og Url, url

Field	Type	Presence	Description and constraints
$	object	Root
error	string	Optional	Og Tag Error
ogDescription	string	Optional	Tag description
ogImage	JSON	Optional	OG Image data
ogImage (allOf 1)	Model	All variants apply	Expand Get CSV Post — response body — results count, csv, posts posts item link error, og Description, og Image, og Site Name, og Title, og Url, url og Image height, type, url, width
ogSiteName	string	Optional	Site Name
ogTitle	string	Optional	Tag Title
ogUrl	string	Optional	Tag Url
url	string	Optional	Tag url

Referenced models: Get CSV Post — response body — results count, csv, posts posts item link error, og Description, og Image, og Site Name, og Title, og Url, url og Image height, type, url, width

Get posts — response body — results / count, posts / posts / item / tiktokPostDetails / privacyLevel: PUBLIC TO EVERYONE, MUTUAL FOLLOW FRIENDS, SELF ONLY

Field	Type	Presence	Description and constraints
$	object	Root
enableComment	boolean	Optional	Allow users to comment on the video. Default is determined by account settings.
enableDuet	boolean	Optional	Allow users to create Duet videos with your content. **Duet:** Side-by-side video featuring your content and the creator's reaction/addition.
enableStitch	boolean	Optional	Allow users to create Stitch videos with your content. **Stitch:** Clips up to 5 seconds of your video that creators can use in their own videos.
privacyLevel	string	Required within parent	Privacy level controlling who can view the video. **Available Values:** - `PUBLIC_TO_EVERYONE` - Anyone can view (default) - `MUTUAL_FOLLOW_FRIENDS` - Only mutual followers can view - `SELF_ONLY` - Only you can view (private) **Note:** If set to `SELF_ONLY`, `videoDisclosure` must be `false`. Known values: PUBLIC_TO_EVERYONE, MUTUAL_FOLLOW_FRIENDS, SELF_ONLY
promoteOtherBrand	boolean	Optional	Indicates if the video promotes a third-party brand or product. **Required:** Must be `true` if `videoDisclosure` is enabled and you're promoting another brand.
promoteYourBrand	boolean	Optional	Indicates if the video promotes your own brand or product. **Required:** Must be `true` if `videoDisclosure` is enabled and you're promoting your own brand.
videoDisclosure	boolean	Optional	Enable branded content disclosure. Required when video is promotional content. **Validations:** - Cannot be `true` if `privacyLevel` is `SELF_ONLY` - If enabled, at least one of `promoteYourBrand` or `promoteOtherBrand` must be `true`

Policy, approvals and errors

SDK function policy ID: gohighlevel.get_csv_post. Catalog operation: get-csv-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/csv.readonly"]

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

Official provider source