List all sequences with optional status filtering.

GET

https://host.com/v1/sequences

GET

/v1/sequences

1 const url = 'https://host.com/v1/sequences';
2 const options = {
3   method: 'GET',
4   headers: {'X-API-Key': '<apiKey>', 'Content-Type': 'application/json'},
5   body: '{}'
6 };
7 
8 try {
9   const response = await fetch(url, options);
10   const data = await response.json();
11   console.log(data);
12 } catch (error) {
13   console.error(error);
14 }

200Retrieved

1 [
2   {
3     "id": "a3f1c9d2-4b7e-4f8a-9c3d-2e5b7f6a1d9c",
4     "status": "active",
5     "name": "Appointment Reminder Sequence",
6     "description": "Sequence to remind customers about upcoming appointments via calls, texts, and emails.",
7     "criteria": "appointmentDate >= today",
8     "schedules": [
9       {
10         "dayOffset": 0,
11         "hour": 9,
12         "minute": 0,
13         "delayInMinutes": 0,
14         "phoneScript": {
15           "agentName": "Sarah Chen",
16           "greeting": "Hello, this is Sarah from Acme Clinic calling to remind you of your appointment today.",
17           "goodbye": "Thank you for your time. We look forward to seeing you soon!",
18           "useCaseAssociations": [
19             {
20               "id": "d4e5f6a7-b8c9-4d0e-9f1a-2b3c4d5e6f7a",
21               "order": 1,
22               "status": "active"
23             }
24           ],
25           "giveSurvey": true,
26           "faqs": [
27             {
28               "question": "What should I bring to my appointment?",
29               "answer": "Please bring a valid ID and your insurance card.",
30               "details": "If you have any recent medical records, please bring those as well."
31             }
32           ],
33           "postCallScripts": [
34             {
35               "textScriptId": "e7f8a9b0-c1d2-4e3f-8a9b-0c1d2e3f4a5b",
36               "description": "Send follow-up SMS with appointment details."
37             }
38           ],
39           "voicemail": "Hi, this is Sarah from Acme Clinic. We wanted to remind you of your appointment today. Please call us back if you need to reschedule.",
40           "voice": "female",
41           "voiceProvider": {
42             "value": "Amazon Polly - Joanna"
43           },
44           "knowledgeBase": {
45             "documentIds": [
46               "f1e2d3c4-b5a6-7890-1234-56789abcdef0"
47             ],
48             "documentTags": [
49               "appointment",
50               "reminder",
51               "clinic"
52             ]
53           },
54           "$type": "PhoneScript",
55           "id": "b1c2d3e4-f5a6-7890-1234-56789abcdef1",
56           "type": "phone",
57           "direction": "outbound",
58           "name": "Appointment Reminder Call Script",
59           "status": "active"
60         },
61         "emailScript": {
62           "subject": "Reminder: Your Appointment is Today",
63           "body": "Dear Marcus Johnson,\n\nThis is a friendly reminder that you have an appointment scheduled for today at 10:00 AM.\n\nPlease let us know if you need to reschedule.\n\nBest regards,\nAcme Clinic",
64           "$type": "EmailScript",
65           "id": "c2d3e4f5-a6b7-8901-2345-6789abcdef12",
66           "type": "phone",
67           "direction": "outbound",
68           "name": "Appointment Reminder Email",
69           "status": "active"
70         },
71         "textScript": {
72           "message": "Hi Marcus, this is a reminder from Acme Clinic about your appointment today at 10:00 AM. Reply YES to confirm or call us to reschedule.",
73           "$type": "TextScript",
74           "id": "d3e4f5a6-b7c8-9012-3456-789abcdef123",
75           "type": "phone",
76           "direction": "outbound",
77           "name": "Appointment Reminder SMS",
78           "status": "active"
79         },
80         "blasterScript": {
81           "message": "Reminder: Your appointment at Acme Clinic is today. Please confirm or reschedule.",
82           "$type": "BlasterScript",
83           "id": "e4f5a6b7-c8d9-0123-4567-89abcdef1234",
84           "type": "phone_blaster",
85           "direction": "outbound",
86           "name": "Appointment Reminder Blaster",
87           "status": "active"
88         },
89         "scripts": [
90           {
91             "subject": "Reminder: Your Appointment is Today",
92             "body": "Dear Marcus Johnson,\n\nThis is a friendly reminder that you have an appointment scheduled for today at 10:00 AM.\n\nPlease let us know if you need to reschedule.\n\nBest regards,\nAcme Clinic",
93             "$type": "EmailScript",
94             "id": "c2d3e4f5-a6b7-8901-2345-6789abcdef12",
95             "type": "phone",
96             "direction": "outbound",
97             "name": "Appointment Reminder Email",
98             "status": "active"
99           }
100         ]
101       }
102     ],
103     "timezone": "America/New_York"
104   }
105 ]

Authentication

X-API-Keystring

API Key authentication. Generate your API key in the Gail Portal under General > Integrations > API Keys.

Query parameters

statusstringOptionalDefaults to active

Comma-separated list of statuses to filter by (e.g., “active”, “archived”).

Response

idstringOptionalformat: "uuid"

statusstring or nullOptional

namestring or nullOptional

descriptionstring or nullOptional

criteriastring or nullOptional

scheduleslist of objects or nullOptional

timezonestring or nullOptional