HighLevel: Get all categories with their queue status

← Social planner operations · Get started

Operation gohighlevel.fetchavailablecategories

Provider route: GET /social-media-posting/category/queues/available-categories. 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"]["fetchAvailableCategories"]>[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.fetchAvailableCategories(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_available_categories(arguments)
        result = await call.wait()
        return result.body_json()

Input

Field	Type	Presence	Description and constraints
$	object	Root	Additional keys: not allowed
query	object	Required within parent	Additional keys: not allowed
query.locationId	string	Required within parent
query.skip	string	Optional
query.limit	string	Optional
query.q	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 all categories with their queue status — response body

Referenced models: Get all categories with their queue status — response body

Schemas

Get all categories with their queue status — response body

Field	Type	Presence	Description and constraints
$	object	Root
results	Model	Required within parent	Expand Get all categories with their queue status — 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: Get all categories with their queue status — response body — results

Get all categories with their queue status — response body — results

Field	Type	Presence	Description and constraints
$	object	Root
categories	array	Optional	List of categories with queue status
categories[]	Model	Each item	Expand Get all categories with their queue status — response body — results categories item
message	string	Optional
meta	Model	Optional	Expand Fetch category queues for a location — response body — results meta

Referenced models: Fetch category queues for a location — response body — results meta, Get all categories with their queue status — response body — results categories item

Fetch category queues for a location — response body — results meta

Field	Type	Presence	Description and constraints
$	object	Root
count	string	Optional	Total count of items

Get all categories with their queue status — response body — results categories item

Field	Type	Presence	Description and constraints
$	object	Root
_id	string	Optional	Category ID
createdAt	string	Optional	Creation timestamp
createdBy	string	Optional	Creator user ID
deleted	boolean	Optional	Indicates if deleted
locationId	string	Optional	Location ID
name	string	Optional	Category name
primaryColor	string	Optional	Primary color (hex)
publishedPostsCount	JSON	Optional
publishedPostsCount (anyOf 1)	number	Alternative	Published posts count
publishedPostsCount (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
queueDetails	JSON	Optional
queueDetails (anyOf 1)	JSON	Alternative	Queue details (present when in_queue or draft)
queueDetails (anyOf 1) (allOf 1)	Model	All variants apply	Expand Get all categories with their queue status — response body — results categories item queue Details Queue details (present when in queue or draft) enable Future Posts, prioritize New Content, queue Id
queueDetails (anyOf 2)	null	Alternative
secondaryColor	string	Optional	Secondary color (hex)
status	string	Optional	Status: available (no queue), in_queue (active/paused), or draft Known values: available, in_queue, draft
updatedAt	string	Optional	Last update timestamp

Referenced models: Get all categories with their queue status — response body — results categories item queue Details Queue details (present when in queue or draft) enable Future Posts, prioritize New Content, queue Id

Get all categories with their queue status — response body — results categories item queue Details Queue details (present when in queue or draft) enable Future Posts, prioritize New Content, queue Id

Field	Type	Presence	Description and constraints
$	object	Root
enableFuturePosts	boolean	Optional	Enable posting future content
prioritizeNewContent	boolean	Optional	Prioritize new content over older content
queueId	string	Optional	Queue ID

Policy, approvals and errors

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