## Retrieve a sequence `client.Sequence.Get(ctx, id) (*SequenceRetrieveResponse, error)` **get** `/v1/sequences/{id}` Retrieves a single sequence by its ID. Edits that have not been published are not included; those can be read with [Retrieve a sequence draft](/api/resources/sequence/methods/retrieveDraft). **[Required scope](/using-the-api/scopes/):** `sequences:read` **[Rate limit category](/using-the-api/rate-limits/):** Read ### Parameters - `id string` Unique identifier of the sequence to retrieve. ### Returns - `type SequenceRetrieveResponse struct{…}` - `ID string` Unique identifier of the sequence. - `Channels []string` Channels the published steps send on; empty before the first publish. - `const SequenceRetrieveResponseChannelEmail SequenceRetrieveResponseChannel = "EMAIL"` - `const SequenceRetrieveResponseChannelLinkedin SequenceRetrieveResponseChannel = "LINKEDIN"` - `CreatedAt string` ISO 8601 creation timestamp. - `Definition SequenceRetrieveResponseDefinition` Published configuration, or null before the first publish. - `Description string` What this version of the sequence is for. - `Messaging SequenceRetrieveResponseDefinitionMessaging` Messaging inputs that frame every step. - `CallToAction string` What the recipient is asked to do. - `Persona string` Who the sequence targets. - `Trigger string` Why the outreach is timely. - `ValueProp string` The value proposition. - `Pacing SequenceRetrieveResponseDefinitionPacing` How the whole sequence paces each step type it sends, keyed by sequence step type. - `Email SequenceRetrieveResponseDefinitionPacingEmail` Email steps. - `DailyLimit int64` Most sends of this step type across the whole sequence in any rolling 24 hours, or null when the sequence sets no daily cap. Workspace and sender limits still apply. - `LinkedinInvite SequenceRetrieveResponseDefinitionPacingLinkedinInvite` LinkedIn connection requests. - `DailyLimit int64` Most sends of this step type across the whole sequence in any rolling 24 hours, or null when the sequence sets no daily cap. Workspace and sender limits still apply. - `LinkedinMessage SequenceRetrieveResponseDefinitionPacingLinkedinMessage` LinkedIn messages. - `DailyLimit int64` Most sends of this step type across the whole sequence in any rolling 24 hours, or null when the sequence sets no daily cap. Workspace and sender limits still apply. - `Priority string` Send priority relative to other sequences. - `const SequenceRetrieveResponseDefinitionPriorityHigh SequenceRetrieveResponseDefinitionPriority = "HIGH"` - `const SequenceRetrieveResponseDefinitionPriorityNormal SequenceRetrieveResponseDefinitionPriority = "NORMAL"` - `SendWindow SequenceRetrieveResponseDefinitionSendWindow` When the sequence may send. - `DaysOfWeek []int64` Days sends may go out, 0 = Sunday. - `EndHour int64` Local hour sends stop, exclusive (1–24). - `StartHour int64` First local hour sends may go out (0–23). - `Timezone string` IANA timezone of the window. - `Steps []SequenceRetrieveResponseDefinitionStepUnion` Email, LinkedIn and wait steps in execution order. - `type SequenceRetrieveResponseDefinitionStepObject struct{…}` - `ID string` Step identifier, referenced by enrollment `currentStepId` and message `sequenceStepId`. - `DeliveryMode string` `AUTO` sends without manual approval, subject to the send window and limits; `FOR_REVIEW` requires a person to approve the draft before sending. - `const SequenceRetrieveResponseDefinitionStepObjectDeliveryModeAuto SequenceRetrieveResponseDefinitionStepObjectDeliveryMode = "AUTO"` - `const SequenceRetrieveResponseDefinitionStepObjectDeliveryModeForReview SequenceRetrieveResponseDefinitionStepObjectDeliveryMode = "FOR_REVIEW"` - `Mode string` How each message is written: `AGENT` composes it from `prompt`; `TEMPLATE` sends `template` to every contact, with its variables filled in. - `const SequenceRetrieveResponseDefinitionStepObjectModeAgent SequenceRetrieveResponseDefinitionStepObjectMode = "AGENT"` - `Name string` Display name of the step. - `Prompt string` Instructions the agent follows when composing this message. - `Type string` Step type. - `const SequenceRetrieveResponseDefinitionStepObjectTypeEmail SequenceRetrieveResponseDefinitionStepObjectType = "EMAIL"` - `const SequenceRetrieveResponseDefinitionStepObjectTypeLinkedinMessage SequenceRetrieveResponseDefinitionStepObjectType = "LINKEDIN_MESSAGE"` - `type SequenceRetrieveResponseDefinitionStepObject2 struct{…}` - `ID string` Step identifier, referenced by enrollment `currentStepId` and message `sequenceStepId`. - `DeliveryMode string` `AUTO` sends without manual approval, subject to the send window and limits; `FOR_REVIEW` requires a person to approve the draft before sending. - `const SequenceRetrieveResponseDefinitionStepObject2DeliveryModeAuto SequenceRetrieveResponseDefinitionStepObject2DeliveryMode = "AUTO"` - `const SequenceRetrieveResponseDefinitionStepObject2DeliveryModeForReview SequenceRetrieveResponseDefinitionStepObject2DeliveryMode = "FOR_REVIEW"` - `IncludeNote bool` Whether the connection request carries a note. A step authored before this setting existed reads as true. - `Mode string` How each message is written: `AGENT` composes it from `prompt`; `TEMPLATE` sends `template` to every contact, with its variables filled in. - `const SequenceRetrieveResponseDefinitionStepObject2ModeAgent SequenceRetrieveResponseDefinitionStepObject2Mode = "AGENT"` - `Name string` Display name of the step. - `Prompt string` Instructions the agent follows when composing this message. - `Type string` Step type. - `const SequenceRetrieveResponseDefinitionStepObject2TypeLinkedinInvite SequenceRetrieveResponseDefinitionStepObject2Type = "LINKEDIN_INVITE"` - `type SequenceRetrieveResponseDefinitionStepObject3 struct{…}` - `ID string` Step identifier, referenced by enrollment `currentStepId` and message `sequenceStepId`. - `DeliveryMode string` `AUTO` sends without manual approval, subject to the send window and limits; `FOR_REVIEW` requires a person to approve the draft before sending. - `const SequenceRetrieveResponseDefinitionStepObject3DeliveryModeAuto SequenceRetrieveResponseDefinitionStepObject3DeliveryMode = "AUTO"` - `const SequenceRetrieveResponseDefinitionStepObject3DeliveryModeForReview SequenceRetrieveResponseDefinitionStepObject3DeliveryMode = "FOR_REVIEW"` - `Mode string` How each message is written: `AGENT` composes it from `prompt`; `TEMPLATE` sends `template` to every contact, with its variables filled in. - `const SequenceRetrieveResponseDefinitionStepObject3ModeTemplate SequenceRetrieveResponseDefinitionStepObject3Mode = "TEMPLATE"` - `Name string` Display name of the step. - `Template SequenceRetrieveResponseDefinitionStepObject3Template` The email every contact receives. - `Body string` Email body as Markdown, without the sign-off or signature, which are added when the message is written. Each `{{ }}` is a variable filled in per contact, with a fallback for a contact missing the value; a field variable names the field by the `ad_` ID the field-definitions endpoints list. - `Subject string` Plain-text subject line. Each `{{ }}` is a variable filled in per contact, with a fallback for a contact missing the value; a field variable names the field by the `ad_` ID the field-definitions endpoints list. - `Type string` Step type. - `const SequenceRetrieveResponseDefinitionStepObject3TypeEmail SequenceRetrieveResponseDefinitionStepObject3Type = "EMAIL"` - `type SequenceRetrieveResponseDefinitionStepObject4 struct{…}` - `ID string` Step identifier, referenced by enrollment `currentStepId` and message `sequenceStepId`. - `DeliveryMode string` `AUTO` sends without manual approval, subject to the send window and limits; `FOR_REVIEW` requires a person to approve the draft before sending. - `const SequenceRetrieveResponseDefinitionStepObject4DeliveryModeAuto SequenceRetrieveResponseDefinitionStepObject4DeliveryMode = "AUTO"` - `const SequenceRetrieveResponseDefinitionStepObject4DeliveryModeForReview SequenceRetrieveResponseDefinitionStepObject4DeliveryMode = "FOR_REVIEW"` - `Mode string` How each message is written: `AGENT` composes it from `prompt`; `TEMPLATE` sends `template` to every contact, with its variables filled in. - `const SequenceRetrieveResponseDefinitionStepObject4ModeTemplate SequenceRetrieveResponseDefinitionStepObject4Mode = "TEMPLATE"` - `Name string` Display name of the step. - `Template SequenceRetrieveResponseDefinitionStepObject4Template` The message every contact receives; for an invite, its connection note, sent only with `includeNote`. - `Body string` Plain-text message. Each `{{ }}` is a variable filled in per contact, with a fallback for a contact missing the value; a field variable names the field by the `ad_` ID the field-definitions endpoints list. - `Type string` Step type. - `const SequenceRetrieveResponseDefinitionStepObject4TypeLinkedinMessage SequenceRetrieveResponseDefinitionStepObject4Type = "LINKEDIN_MESSAGE"` - `type SequenceRetrieveResponseDefinitionStepObject5 struct{…}` - `ID string` Step identifier, referenced by enrollment `currentStepId` and message `sequenceStepId`. - `DeliveryMode string` `AUTO` sends without manual approval, subject to the send window and limits; `FOR_REVIEW` requires a person to approve the draft before sending. - `const SequenceRetrieveResponseDefinitionStepObject5DeliveryModeAuto SequenceRetrieveResponseDefinitionStepObject5DeliveryMode = "AUTO"` - `const SequenceRetrieveResponseDefinitionStepObject5DeliveryModeForReview SequenceRetrieveResponseDefinitionStepObject5DeliveryMode = "FOR_REVIEW"` - `IncludeNote bool` Whether the connection request carries a note. A step authored before this setting existed reads as true. - `Mode string` How each message is written: `AGENT` composes it from `prompt`; `TEMPLATE` sends `template` to every contact, with its variables filled in. - `const SequenceRetrieveResponseDefinitionStepObject5ModeTemplate SequenceRetrieveResponseDefinitionStepObject5Mode = "TEMPLATE"` - `Name string` Display name of the step. - `Template SequenceRetrieveResponseDefinitionStepObject5Template` The message every contact receives; for an invite, its connection note, sent only with `includeNote`. - `Body string` Plain-text message. Each `{{ }}` is a variable filled in per contact, with a fallback for a contact missing the value; a field variable names the field by the `ad_` ID the field-definitions endpoints list. - `Type string` Step type. - `const SequenceRetrieveResponseDefinitionStepObject5TypeLinkedinInvite SequenceRetrieveResponseDefinitionStepObject5Type = "LINKEDIN_INVITE"` - `type SequenceRetrieveResponseDefinitionStepObject6 struct{…}` - `ID string` Step identifier. - `Duration int64` Length of the wait. - `Type string` `WAIT` pauses for a fixed time; `WAIT_FOR_CONNECTION` waits up to that long for a LinkedIn invite to be accepted. - `const SequenceRetrieveResponseDefinitionStepObject6TypeWait SequenceRetrieveResponseDefinitionStepObject6Type = "WAIT"` - `const SequenceRetrieveResponseDefinitionStepObject6TypeWaitForConnection SequenceRetrieveResponseDefinitionStepObject6Type = "WAIT_FOR_CONNECTION"` - `Unit string` Unit of `duration`. - `const SequenceRetrieveResponseDefinitionStepObject6UnitDay SequenceRetrieveResponseDefinitionStepObject6Unit = "DAY"` - `const SequenceRetrieveResponseDefinitionStepObject6UnitMinute SequenceRetrieveResponseDefinitionStepObject6Unit = "MINUTE"` - `FirstActivatedAt string` When the sequence was first activated. - `LastActivatedAt string` When the sequence was most recently activated. - `Name string` Name of the sequence. - `ObjectType SequenceRetrieveResponseObjectType` Always `sequence`. - `const SequenceRetrieveResponseObjectTypeSequence SequenceRetrieveResponseObjectType = "sequence"` - `Reviewers []SequenceRetrieveResponseReviewer` Extra members who may approve this sequence’s `FOR_REVIEW` messages before they send. The sending member and the sequence’s creator always review, whether or not they are listed. - `ID string` ID of the member. - `ObjectType string` Always `member`. - `const SequenceRetrieveResponseReviewerObjectTypeMember SequenceRetrieveResponseReviewerObjectType = "member"` - `Senders []SequenceRetrieveResponseSender` The senders this sequence sends from; new contacts rotate across them. An archived sender stays listed but never sends; any change to the list drops it. - `ID string` ID of the sender. - `ObjectType string` Always `sender`. - `const SequenceRetrieveResponseSenderObjectTypeSender SequenceRetrieveResponseSenderObjectType = "sender"` - `Status SequenceRetrieveResponseStatus` `DRAFT` has not been published; `ACTIVE` is enabled for sending; `DEACTIVATED` is published but paused. - `const SequenceRetrieveResponseStatusDraft SequenceRetrieveResponseStatus = "DRAFT"` - `const SequenceRetrieveResponseStatusActive SequenceRetrieveResponseStatus = "ACTIVE"` - `const SequenceRetrieveResponseStatusDeactivated SequenceRetrieveResponseStatus = "DEACTIVATED"` ### Example ```go package main import ( "context" "fmt" "github.com/Lightfld/lightfield-go" "github.com/Lightfld/lightfield-go/option" ) func main() { client := githubcomlightfldlightfieldgo.NewClient( option.WithAPIKey("My API Key"), ) sequenceRetrieveResponse, err := client.Sequence.Get(context.TODO(), "id") if err != nil { panic(err.Error()) } fmt.Printf("%+v\n", sequenceRetrieveResponse.ID) } ``` #### Response ```json { "id": "id", "channels": [ "EMAIL" ], "createdAt": "createdAt", "definition": { "description": "description", "messaging": { "callToAction": "callToAction", "persona": "persona", "trigger": "trigger", "valueProp": "valueProp" }, "pacing": { "EMAIL": { "dailyLimit": -9007199254740991 }, "LINKEDIN_INVITE": { "dailyLimit": -9007199254740991 }, "LINKEDIN_MESSAGE": { "dailyLimit": -9007199254740991 } }, "priority": "HIGH", "sendWindow": { "daysOfWeek": [ -9007199254740991 ], "endHour": -9007199254740991, "startHour": -9007199254740991, "timezone": "timezone" }, "steps": [ { "id": "id", "deliveryMode": "AUTO", "mode": "AGENT", "name": "name", "prompt": "prompt", "type": "EMAIL" } ] }, "firstActivatedAt": "firstActivatedAt", "lastActivatedAt": "lastActivatedAt", "name": "name", "objectType": "sequence", "reviewers": [ { "id": "x", "objectType": "member" } ], "senders": [ { "id": "x", "objectType": "sender" } ], "status": "DRAFT" } ```