HighLevel: Get categories by location id

← Social planner operations · Get started

Operation gohighlevel.get_categories_location_id

Provider route: GET /social-media-posting/{locationId}/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"]["getCategoriesLocationId"]>[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.getCategoriesLocationId(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_categories_location_id(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	Optional	Additional keys: not allowed
query.searchText	string	Optional
query.limit	string	Optional
query.skip	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 categories by location id — response body

Referenced models: Get categories by location id — response body

Schemas

Get categories by location id — 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 categories by location id — response body — results categories, count
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 categories by location id — response body — results categories, count

Get categories by location id — response body — results categories, count

Field	Type	Presence	Description and constraints
$	object	Root
categories	array	Required within parent	Meta Data
categories[]	Model	Each item	Expand Get categories by location id — response body — results categories, count categories item
count	JSON	Required within parent
count (anyOf 1)	number	Alternative	Count
count (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$

Referenced models: Get categories by location id — response body — results categories, count categories item

Get categories by location id — response body — results categories, count categories item

Field	Type	Presence	Description and constraints
$	object	Root
_id	string	Optional	ID
createdAt	string	Optional	Format: date-time
createdBy	string	Optional	Created By User
deleted	boolean	Required within parent	Deleted Value
locationId	string	Optional	Location ID
name	string	Optional	Category Name
primaryColor	string	Optional	Color For Category
secondaryColor	string	Optional	Secondary Color
updatedAt	string	Optional	Format: date-time

Policy, approvals and errors

SDK function policy ID: gohighlevel.get_categories_location_id. Catalog operation: get-categories-location-id. 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