Get a specific touchpoint by ID.

GET

https://host.com/v1/campaigns/:id/touchpoints/:touchpointId

GET

/v1/campaigns/:id/touchpoints/:touchpointId

1 const url = 'https://host.com/v1/campaigns/id/touchpoints/touchpointId';
2 const options = {method: 'GET', headers: {'X-API-Key': '<apiKey>'}};
3 
4 try {
5   const response = await fetch(url, options);
6   const data = await response.json();
7   console.log(data);
8 } catch (error) {
9   console.error(error);
10 }

1 {
2   "touchpointId": "string",
3   "contactId": "string",
4   "contactFirstName": "string",
5   "contactLastName": "string",
6   "phoneNumber": "string",
7   "externalId": "string",
8   "outreachId": "string",
9   "timezone": "string",
10   "type": "string",
11   "outcome": "string",
12   "publishedAt": "2024-01-15T09:30:00Z",
13   "finishedAt": "2024-01-15T09:30:00Z",
14   "duration": 1,
15   "transcript": [
16     {
17       "role": "string",
18       "content": "string",
19       "startMs": 1,
20       "endMs": 1
21     }
22   ],
23   "additionalData": {},
24   "errorMessage": "string",
25   "message": "string"
26 }

Authentication

X-API-Keystring

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

Path parameters

idstringRequiredformat: "uuid"

The unique identifier of the campaign.

touchpointIdstringRequiredformat: "uuid"

The unique identifier of the touchpoint.

Query parameters

includeTranscriptsbooleanOptionalDefaults to false

When true, includes call transcript in the response.

Response

touchpointIdstringOptionalformat: "uuid"

contactIdstringOptionalformat: "uuid"

contactFirstNamestring or nullOptional

contactLastNamestring or nullOptional

phoneNumberstring or nullOptional

externalIdstring or nullOptional

outreachIdstringOptionalformat: "uuid"

timezonestring or nullOptional

typestring or nullOptional

outcomestring or nullOptional

publishedAtdatetime or nullOptional

finishedAtdatetime or nullOptional

durationinteger or nullOptional

transcriptlist of objects or nullOptional

additionalDatamap from strings to any or nullOptional

errorMessagestring or nullOptional

messagestring or nullOptional

Errors

404

Not Found Error