HighLevel: Fetch slot information for queue items

← Social planner operations · Get started

Operation gohighlevel.fetchslots

Provider route: POST /social-media-posting/category/queues/{queueId}/slots. 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"]["fetchSlots"]>[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.fetchSlots(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_slots(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 slot information for queue items — request body — body

Referenced models: Fetch slot information for queue items — 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 slot information for queue items — response body

Referenced models: Fetch slot information for queue items — response body

Schemas

Fetch slot information for queue items — request body — body

Field	Type	Presence	Description and constraints
$	object	Root
limit	number	Optional	Number of items to return Default: 20
locationId	string	Required within parent	The location ID
sessionId	string	Optional	Session ID for edit mode. If not provided, calculates slots for live items.
skip	number	Optional	Number of items to skip Default: 0

Fetch slot information for queue items — response body

Field	Type	Presence	Description and constraints
$	object	Root
results	Model	Required within parent	Expand Fetch slot information for queue items — 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 slot information for queue items — response body — results

Fetch slot information for queue items — response body — results

Field	Type	Presence	Description and constraints
$	object	Root
limit	JSON	Optional
limit (anyOf 1)	number	Alternative	Number of items returned
limit (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
message	string	Optional
skip	JSON	Optional
skip (anyOf 1)	number	Alternative	Number of items skipped
skip (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
slots	array	Optional	Slot information for items in the requested range
slots[]	Model	Each item	Expand Fetch slot information for queue items — response body — results slots item
timezone	string	Optional	Timezone used for slot calculations
total	JSON	Optional
total (anyOf 1)	number	Alternative	Total number of items in the queue
total (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$

Referenced models: Fetch slot information for queue items — response body — results slots item

Fetch slot information for queue items — response body — results slots item

Field	Type	Presence	Description and constraints
$	object	Root
isSkipped	boolean	Optional	Indicates if this time slot is skipped
itemId	string	Optional	The ID of the queue item
scheduledDateTime	JSON	Optional
scheduledDateTime (anyOf 1)	string	Alternative	The updated scheduled date/time for this item Format: date-time
scheduledDateTime (anyOf 2)	null	Alternative

Policy, approvals and errors

SDK function policy ID: gohighlevel.fetchslots. Catalog operation: fetchSlots. 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