HighLevel: Get all authors

← Blogs operations · Get started

Operation gohighlevel.get_all_blog_authors_by_location

Provider route: GET /blogs/authors. 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["blogs"]["getAllBlogAuthorsByLocation"]>[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.blogs.getAllBlogAuthorsByLocation(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.blogs.get_all_blog_authors_by_location(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.limit	number	Required within parent
query.offset	number	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 all authors — response body

Referenced models: Get all authors — response body

Schemas

Get all authors — response body

Field	Type	Presence	Description and constraints
$	object	Root
authors	array	Required within parent	Array of authors
authors[]	Model	Each item	Expand Get all authors — response body — authors item

Referenced models: Get all authors — response body — authors item

Get all authors — response body — authors item

Field	Type	Presence	Description and constraints
$	object	Root
_id	string	Required within parent
canonicalLink	string	Required within parent
locationId	string	Required within parent
name	string	Required within parent
updatedAt	string	Required within parent

Policy, approvals and errors

SDK function policy ID: gohighlevel.get_all_blog_authors_by_location. Catalog operation: get-all-blog-authors-by-location. 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: ["blogs/author.readonly"]

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

Official provider source