HubSpot: Retrieve sequence — sequences get By Sequence Id

← Sequences operations · Get started

Operation hubspot.sequences_get_by_sequence_id

Provider route: GET /automation/sequences/2026-09/{sequenceId}. Alter supplies the connection’s credentials and routing.

Call through Alter

Install @alter-ai/sdk @alter-ai/hubspot with npm, or alter-sdk-hubspot with pip. Supply your connected customer’s grant ID and the arguments described below.

import { App } from "@alter-ai/sdk";
import { HubSpotIntegration } from "@alter-ai/hubspot";

async function execute(input: Parameters<HubSpotIntegration["sequences"]["getBySequenceId"]>[0]) {
  const app = new App({ apiKey: process.env.ALTER_API_KEY! });
  try {
    const provider = new HubSpotIntegration(app, { grantId: process.env.PROVIDER_GRANT_ID! });
    const call = await provider.sequences.getBySequenceId(input);
    const result = await call.wait();
    return result.bodyJson();
  } finally {
    await app.close();
  }
}

import os
from alter_sdk import App
from alter_sdk_hubspot import HubSpotIntegration

async def execute(arguments):
    async with App(api_key=os.environ["ALTER_API_KEY"]) as app:
        provider = HubSpotIntegration(app, {"grant_id": os.environ["PROVIDER_GRANT_ID"]})
        call = await provider.sequences.get_by_sequence_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.sequenceId	string	Required within parent
query	object	Required within parent	Additional keys: not allowed
query.userId	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 Retrieve sequence — sequences get By Sequence Id — response body

Referenced models: Retrieve sequence — sequences get By Sequence Id — response body

Schemas

1 more schema is linked from the tables above, on the schema pages.

Retrieve sequence — sequences get By Sequence Id — response body

Field	Type	Presence	Description and constraints
$	object	Root
createdAt	string	Required within parent	The date and time when the sequence was created, in ISO 8601 format. Format: date-time
dependencies	array	Required within parent	An array of dependencies between sequence steps, each represented by a PublicSequenceStepDependencyResponse object.
dependencies[]	Model	Each item	Expand Update sequence — response body — dependencies item
folderId	string	Optional	The unique identifier for the folder containing the sequence.
id	string	Required within parent	The unique identifier for the sequence.
name	string	Required within parent	The name of the sequence.
settings	Model	Optional	Expand Update sequence — response body — settings
steps	array	Required within parent	An array of steps included in the sequence, each represented by a PublicSequenceStepResponse object.
steps[]	Model	Each item	Expand Retrieve sequence — sequences get By Sequence Id — response body — steps item
updatedAt	string	Required within parent	The date and time when the sequence was last updated, in ISO 8601 format. Format: date-time
userId	string	Required within parent	The unique identifier of the user who owns the sequence.

Referenced models: Update sequence — response body — settings, Update sequence — response body — dependencies item, Retrieve sequence — sequences get By Sequence Id — response body — steps item

Update sequence — response body — settings

Field	Type	Presence	Description and constraints
$	object	Root
createdAt	string	Required within parent	The date and time when the sequence settings were created, in ISO 8601 format. Format: date-time
eligibleFollowUpDays	string	Required within parent	Specifies the days eligible for follow-ups. Valid values include 'EVERYDAY', 'BUSINESS_DAYS', and 'WEEKDAYS_ONLY'. Known values: BUSINESS_DAYS, EVERYDAY, WEEKDAYS_ONLY
id	string	Required within parent	The unique identifier for the sequence settings.
individualTaskRemindersEnabled	boolean	Required within parent	A boolean indicating whether individual task reminders are enabled.
sellingStrategy	string	Required within parent	The strategy used for selling, which can be either 'LEAD_BASED' or 'ACCOUNT_BASED'. Known values: ACCOUNT_BASED, LEAD_BASED
sendWindowEndMinute	JSON	Required within parent
sendWindowEndMinute (anyOf 1)	integer	Alternative	The ending minute of the window during which emails can be sent, represented as an integer. Format: int32
sendWindowEndMinute (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
sendWindowStartMinute	JSON	Required within parent
sendWindowStartMinute (anyOf 1)	integer	Alternative	The starting minute of the window during which emails can be sent, represented as an integer. Format: int32
sendWindowStartMinute (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
taskReminderMinute	JSON	Required within parent
taskReminderMinute (anyOf 1)	integer	Alternative	The minute at which task reminders are sent, represented as an integer. Format: int32
taskReminderMinute (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
updatedAt	string	Required within parent	The date and time when the sequence settings were last updated, in ISO 8601 format. Format: date-time

Update sequence — response body — dependencies item

Field	Type	Presence	Description and constraints
$	object	Root
createdAt	string	Required within parent	The date and time when this dependency was created, in ISO 8601 format. Format: date-time
dependencyType	string	Required within parent	The type of dependency, which can be either 'TASK_COMPLETION' or 'MANUAL_PAUSE'. Known values: ADAPTIVE_COMPLETION, MANUAL_PAUSE, TASK_COMPLETION
id	string	Required within parent	The unique identifier for this dependency.
reliesOnSequenceStepId	string	Required within parent	The unique identifier of the sequence step that this dependency relies on.
reliesOnStepOrder	JSON	Required within parent
reliesOnStepOrder (anyOf 1)	integer	Alternative	The order number of the step that this dependency relies on. Format: int32
reliesOnStepOrder (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
requiredBySequenceStepId	string	Required within parent	The unique identifier of the sequence step that requires this dependency.
requiredByStepOrder	JSON	Required within parent
requiredByStepOrder (anyOf 1)	integer	Alternative	The order number of the step that requires this dependency. Format: int32
requiredByStepOrder (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
updatedAt	string	Required within parent	The date and time when this dependency was last updated, in ISO 8601 format. Format: date-time

Retrieve sequence — sequences get By Sequence Id — response body — steps item

Field	Type	Presence	Description and constraints
$	object	Root
actionType	string	Required within parent	The type of action to be performed in this step. Valid values include 'EMAIL', 'TASK', and 'FINISH_ENROLLMENT'. Known values: ADAPTIVE_CONTAINER, EMAIL, FINISH_ENROLLMENT, TASK
createdAt	string	Required within parent	The date and time when this step was created, in ISO 8601 format. Format: date-time
delayMillis	JSON	Required within parent
delayMillis (anyOf 1)	integer	Alternative	The delay before executing this step, specified in milliseconds as a 64-bit integer. Format: int64
delayMillis (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
emailPattern	Model	Optional	Expand Update sequence — response body — steps item email Pattern
id	string	Required within parent	The unique identifier for this sequence step, represented as a string.
stepOrder	JSON	Required within parent
stepOrder (anyOf 1)	integer	Alternative	An integer indicating the order of this step within the sequence. Format: int32
stepOrder (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
taskPattern	Model	Optional	Expand Retrieve sequence — sequences get By Sequence Id — response body — steps item task Pattern
updatedAt	string	Required within parent	The date and time when this step was last updated, in ISO 8601 format. Format: date-time

Referenced models: Update sequence — response body — steps item email Pattern, Retrieve sequence — sequences get By Sequence Id — response body — steps item task Pattern

Update sequence — response body — steps item email Pattern

Field	Type	Presence	Description and constraints
$	object	Root
createdAt	string	Required within parent	The date and time when this email pattern was created, in ISO 8601 format. Format: date-time
id	string	Required within parent	The unique identifier for this email pattern. It is a string.
templateId	string	Required within parent	The identifier of the email template associated with this pattern. It is a string.
threadEmailToStepOrder	JSON	Optional
threadEmailToStepOrder (anyOf 1)	integer	Alternative	An integer representing the order of the step to which this email pattern is threaded. Format: int32
threadEmailToStepOrder (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
updatedAt	string	Required within parent	The date and time when this email pattern was last updated, in ISO 8601 format. Format: date-time

Policy, approvals and errors

SDK function policy ID: hubspot.sequences_get_by_sequence_id. Catalog operation: sequences_get_by_sequence_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: ["automation.sequences.read"]

Official provider source