get_sequence
Retrieve detailed information about Apollo.io email sequences, including steps, performance statistics, and configuration settings for sales outreach management.
Instructions
Get detailed information about a specific sequence including steps, stats, and settings.
Input Schema
TableJSON Schema
| Name | Required | Description | Default |
|---|---|---|---|
| id | Yes | Sequence ID |
Implementation Reference
- src/index.ts:812-841 (handler)The main handler function for the 'get_sequence' tool. It makes an API call to retrieve the specific sequence by ID from Apollo's emailer_campaigns endpoint, formats the details including name, status, creation date, number of steps, and lists each step with type, wait time, and subject.
private async getSequence(args: any) { const response = await this.axiosInstance.get(`/emailer_campaigns/${args.id}`); const seq = response.data.emailer_campaign; let result = `Sequence Details:\n\n`; result += `Name: ${seq.name}\n`; result += `ID: ${seq.id}\n`; result += `Status: ${seq.active ? "Active" : "Inactive"}\n`; result += `Created: ${seq.created_at ? new Date(seq.created_at).toLocaleDateString() : "N/A"}\n`; result += `Steps: ${seq.num_steps || 0}\n\n`; if (seq.emailer_steps && seq.emailer_steps.length > 0) { result += `Sequence Steps:\n`; seq.emailer_steps.forEach((step: any, index: number) => { result += `\nStep ${index + 1}:\n`; result += ` Type: ${step.type || "Email"}\n`; result += ` Wait: ${step.wait_time || 0} days\n`; result += ` Subject: ${step.subject || "N/A"}\n`; }); } return { content: [ { type: "text", text: result, }, ], }; } - src/index.ts:311-325 (registration)The tool registration in the getTools() array, including name, description, and input schema requiring a 'sequence ID'.
{ name: "get_sequence", description: "Get detailed information about a specific sequence including steps, stats, and settings.", inputSchema: { type: "object", properties: { id: { type: "string", description: "Sequence ID", }, }, required: ["id"], }, }, - src/index.ts:315-324 (schema)The input schema definition for the 'get_sequence' tool, specifying that it requires an object with a mandatory 'id' string parameter representing the Sequence ID.
inputSchema: { type: "object", properties: { id: { type: "string", description: "Sequence ID", }, }, required: ["id"], }, - src/index.ts:74-75 (registration)The switch case in the CallToolRequestHandler that routes calls to the 'get_sequence' handler function.
case "get_sequence": return await this.getSequence(args);