HighLevel: Get Upload Status

← Social planner operations · Get started

Operation gohighlevel.get_upload_status

Provider route: GET /social-media-posting/{locationId}/csv. 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"]["getUploadStatus"]>[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.getUploadStatus(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_upload_status(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
query	object	Required within parent	Additional keys: not allowed
query.skip	string	Optional	Default: 0
query.limit	string	Optional	Default: 10
query.includeUsers	string	Optional
query.isFromTemplate	string	Optional
query.userId	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 Upload Status — response body

Referenced models: Get Upload Status — response body

Schemas

Get Upload Status — 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 Upload Status — response body — results count, csvs
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 Upload Status — response body — results count, csvs

Get Upload Status — response body — results count, csvs

Field	Type	Presence	Description and constraints
$	object	Root
count	JSON	Required within parent
count (anyOf 1)	number	Alternative	Total count of CSV records
count (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
csvs	array	Required within parent	CSV Data
csvs[]	Model	Each item	Expand Get Upload Status — response body — results count, csvs csvs item

Referenced models: Get Upload Status — response body — results count, csvs csvs 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

Policy, approvals and errors

SDK function policy ID: gohighlevel.get_upload_status. Catalog operation: get-upload-status. 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