HighLevel: Get Recurring Task By Id

← Locations operations · Get started

Operation gohighlevel.get_recurring_task_by_id

Provider route: GET /locations/{locationId}/recurring-tasks/{id}. 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["locations"]["getRecurringTaskById"]>[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.locations.getRecurringTaskById(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.locations.get_recurring_task_by_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.id	string	Required within parent
path.locationId	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 Create Recurring Task — response body

Referenced models: Create Recurring Task — response body

Schemas

Create Recurring Task — response body

Field	Type	Presence	Description and constraints
$	object	Root
recurringTask	JSON	Required within parent	Recurring Tasks
recurringTask (allOf 1)	Model	All variants apply	Expand Create Recurring Task — response body — recurring Task assigned To, contact Id, created At, deleted, description, id, location Id, rrule Options, title, total Occurrence, updated At

Referenced models: Create Recurring Task — response body — recurring Task assigned To, contact Id, created At, deleted, description, id, location Id, rrule Options, title, total Occurrence, updated At

Create Recurring Task — response body — recurring Task assigned To, contact Id, created At, deleted, description, id, location Id, rrule Options, title, total Occurrence, updated At

Field	Type	Presence	Description and constraints
$	object	Root
assignedTo	string	Optional	Assigned To
contactId	string	Optional	Contact Id
createdAt	string	Required within parent	Created At
deleted	boolean	Required within parent	Deleted
description	string	Required within parent	Description of the task
id	string	Required within parent	Recurring Task Id
locationId	string	Required within parent	Location Id
rruleOptions	JSON	Required within parent	Recurring rules
rruleOptions (allOf 1)	Model	All variants apply	Expand Create Recurring Task — response body — recurringTask / assignedTo, contactId, createdAt, deleted, description, id, locationId, rruleOptions, title, totalOccurrence, updatedAt / rruleOptions / dayOfWeek: MO, TU, WE, TH, FR, SA, SU, interval Type: yearly, monthly, weekly, daily, hourly
title	string	Required within parent	Name of the task
totalOccurrence	JSON	Required within parent
totalOccurrence (anyOf 1)	number	Alternative	Total Occurrence
totalOccurrence (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
updatedAt	string	Required within parent	Updated At

Referenced models: Create Recurring Task — response body — recurringTask / assignedTo, contactId, createdAt, deleted, description, id, locationId, rruleOptions, title, totalOccurrence, updatedAt / rruleOptions / dayOfWeek: MO, TU, WE, TH, FR, SA, SU, interval Type: yearly, monthly, weekly, daily, hourly

Create Recurring Task — response body — recurringTask / assignedTo, contactId, createdAt, deleted, description, id, locationId, rruleOptions, title, totalOccurrence, updatedAt / rruleOptions / dayOfWeek: MO, TU, WE, TH, FR, SA, SU, interval Type: yearly, monthly, weekly, daily, hourly

Field	Type	Presence	Description and constraints
$	object	Root
count	JSON	Optional
count (anyOf 1)	number	Alternative	Max number of task executions
count (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
createTaskIfOverDue	boolean	Optional	Create Task If Over Due
dayOfMonth	JSON	Optional
dayOfMonth (anyOf 1)	number	Alternative	1, 2, 3, ..., 27, 31
dayOfMonth (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
dayOfWeek	string	Optional	Known values: MO, TU, WE, TH, FR, SA, SU
dueAfterSeconds	JSON	Required within parent
dueAfterSeconds (anyOf 1)	number	Alternative	Due after seconds
dueAfterSeconds (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
endDate	string	Optional	End Date
interval	JSON	Required within parent
interval (anyOf 1)	number	Alternative
interval (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
intervalType	string	Required within parent	Known values: yearly, monthly, weekly, daily, hourly
monthOfYear	JSON	Optional
monthOfYear (anyOf 1)	number	Alternative	1, 2, ....., 11, 12
monthOfYear (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
startDate	string	Required within parent	Start Date

Policy, approvals and errors

SDK function policy ID: gohighlevel.get_recurring_task_by_id. Catalog operation: get-recurring-task-by-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.

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

Official provider source