List all scripts with optional filtering.

GET

https://host.com/v1/scripts

GET

/v1/scripts

1 const url = 'https://host.com/v1/scripts';
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     "subject": null,
4     "body": null,
5     "$type": "PhoneScript",
6     "id": "d3f9a1b2-4c7e-4f8a-9f3d-2b7e5c6a1f9e",
7     "type": "phone",
8     "direction": "outbound",
9     "name": "Appointment Confirmation Script",
10     "status": "active"
11   },
12   {
13     "subject": "Follow-up on Your Support Request",
14     "body": "Dear Marcus Johnson,\n\nWe wanted to check in and ensure your issue has been resolved. Please reply to this email if you need further assistance.\n\nBest regards,\nCustomer Support Team",
15     "$type": "EmailScript",
16     "id": "a7c8e2d4-9f1b-4c3a-8d7f-5e2b9c0d4f1a",
17     "type": "email_blaster",
18     "direction": "inbound",
19     "name": "Support Follow-up Email",
20     "status": "active"
21   },
22   {
23     "message": "Hello Sarah Chen, this is a reminder for your appointment scheduled tomorrow at 3 PM. Please reply YES to confirm or call us to reschedule.",
24     "$type": "TextScript",
25     "id": "f1b2c3d4-e5f6-7a8b-9c0d-1e2f3a4b5c6d",
26     "type": "text_blaster",
27     "direction": "outbound",
28     "name": "Appointment Reminder SMS",
29     "status": "active"
30   },
31   {
32     "message": "This is a mass notification to all customers about our updated support hours starting next week.",
33     "$type": "BlasterScript",
34     "id": "b2c3d4e5-f6a7-8b9c-0d1e-2f3a4b5c6d7e",
35     "type": "phone_blaster",
36     "direction": "outbound",
37     "name": "Support Hours Update",
38     "status": "archived"
39   }
40 ]

Authentication

X-API-Keystring

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

Query parameters

directionenumOptional

Optional direction filter (Inbound, Outbound).

Allowed values:

statusstringOptionalDefaults to

Optional status filter (e.g., “active”, “archived”).

Response

EmailScriptobject

Represents email script response.

TextScriptobject

Represents text script response.

PhoneScriptobject

Represetns a phone script response.

BlasterScriptobject

Represents blaster script response.