Back to Collection Items
// This example assumes the Chilkat API to have been previously unlocked.
// See Global Unlock Sample for sample code.
Dim http As New Chilkat.Http
Dim success As Boolean
// Adds the "Authorization: Bearer <access_token>" header.
http.AuthToken = "<access_token>"
Dim sbResponseBody As New Chilkat.StringBuilder
success = http.QuickGetSb("https://domain.com/crm/v2.1/settings/email_templates",sbResponseBody)
If (success = False) Then
System.DebugLog(http.LastErrorText)
Return
End If
Dim jResp As New Chilkat.JsonObject
success = jResp.LoadSb(sbResponseBody)
jResp.EmitCompact = False
System.DebugLog("Response Body:")
System.DebugLog(jResp.Emit())
Dim respStatusCode As Int32
respStatusCode = http.LastStatus
System.DebugLog("Response Status Code = " + Str(respStatusCode))
If (respStatusCode >= 400) Then
System.DebugLog("Response Header:")
System.DebugLog(http.LastHeader)
System.DebugLog("Failed.")
Return
End If
// Sample JSON response:
// (Sample code for parsing the JSON response is shown below)
// {
// "email_templates": [
// {
// "created_time": "2021-02-04T14:22:19+05:30",
// "attachments": null,
// "subject": "Thank you mail",
// "module": {
// "api_name": "Contacts",
// "id": "4150868000000002179"
// },
// "type": "custom_templates",
// "created_by": {
// "name": "Patricia Boyle",
// "id": "4150868000000225013"
// },
// "modified_time": "2021-02-04T14:22:19+05:30",
// "folder": {
// "name": "Public Email Templates",
// "id": "4150868000000000077"
// },
// "last_usage_time": null,
// "associated": true,
// "name": "Thank you for registeration",
// "consent_linked": false,
// "modified_by": {
// "name": "Patricia Boyle",
// "id": "4150868000000225013"
// },
// "id": "4150868000004557001",
// "editor_mode": "gallery",
// "favorite": false
// },
// {
// "created_time": "2020-03-18T10:14:49+05:30",
// "attachments": null,
// "subject": "This is a sample email template",
// "module": {
// "api_name": "Contacts",
// "id": "4150868000000002179"
// },
// "type": "custom_templates",
// "created_by": {
// "name": "Patricia Boyle",
// "id": "4150868000000225013"
// },
// "modified_time": "2020-03-18T10:14:49+05:30",
// "folder": {
// "name": "Public Email Templates",
// "id": "4150868000000000077"
// },
// "last_usage_time": null,
// "associated": true,
// "name": "Sample1",
// "consent_linked": false,
// "modified_by": {
// "name": "Patricia Boyle",
// "id": "4150868000000225013"
// },
// "id": "4150868000001658001",
// "editor_mode": "gallery",
// "favorite": false
// },
// {
// "created_time": "2019-09-23T16:56:45+05:30",
// "attachments": null,
// "subject": "this is a test email",
// "module": {
// "api_name": "Leads",
// "id": "4150868000000002175"
// },
// "type": "custom_templates",
// "created_by": {
// "name": "Patricia Boyle",
// "id": "4150868000000225013"
// },
// "modified_time": "2019-09-23T16:56:45+05:30",
// "folder": {
// "name": "Public Email Templates",
// "id": "4150868000000000077"
// },
// "last_usage_time": "2019-09-29T20:00:03+05:30",
// "associated": true,
// "name": "Sample",
// "consent_linked": false,
// "modified_by": {
// "name": "Patricia Boyle",
// "id": "4150868000000225013"
// },
// "id": "4150868000000475003",
// "editor_mode": "gallery",
// "favorite": false
// },
// {
// "created_time": "2019-08-20T11:21:31+05:30",
// "attachments": null,
// "subject": "Big Deal Alert",
// "module": {
// "api_name": "Deals",
// "id": "4150868000000002181"
// },
// "type": "system_templates",
// "created_by": null,
// "modified_time": "2019-08-20T11:21:31+05:30",
// "folder": {
// "name": "Public Email Templates",
// "id": "4150868000000000077"
// },
// "last_usage_time": "2020-02-25T10:59:44+05:30",
// "associated": true,
// "name": "Big Deal Alert",
// "consent_linked": false,
// "modified_by": null,
// "id": "4150868000000000079",
// "editor_mode": "gallery",
// "favorite": false
// }
// ],
// "info": {
// "per_page": 200,
// "count": 4,
// "page": 1,
// "more_records": false
// }
// }
// Sample code for parsing the JSON response...
// Use this online tool to generate parsing code from sample JSON: Generate JSON Parsing Code
Dim created_time As String
Dim attachments As String
Dim subject As String
Dim Api_name As String
Dim Id As String
Dim v_type As String
Dim Name As String
Dim created_byId As String
Dim modified_time As String
Dim folderName As String
Dim folderId As String
Dim last_usage_time As String
Dim associated As Boolean
Dim name As String
Dim consent_linked As Boolean
Dim modified_byName As String
Dim modified_byId As String
Dim id As String
Dim editor_mode As String
Dim favorite As Boolean
Dim created_by As String
Dim modified_by As String
Dim Per_page As Int32
Per_page = jResp.IntOf("info.per_page")
Dim Count As Int32
Count = jResp.IntOf("info.count")
Dim Page As Int32
Page = jResp.IntOf("info.page")
Dim More_records As Boolean
More_records = jResp.BoolOf("info.more_records")
Dim i As Int32
i = 0
Dim count_i As Int32
count_i = jResp.SizeOfArray("email_templates")
While i < count_i
jResp.I = i
created_time = jResp.StringOf("email_templates[i].created_time")
attachments = jResp.StringOf("email_templates[i].attachments")
subject = jResp.StringOf("email_templates[i].subject")
Api_name = jResp.StringOf("email_templates[i].module.api_name")
Id = jResp.StringOf("email_templates[i].module.id")
v_type = jResp.StringOf("email_templates[i].type")
Name = jResp.StringOf("email_templates[i].created_by.name")
created_byId = jResp.StringOf("email_templates[i].created_by.id")
modified_time = jResp.StringOf("email_templates[i].modified_time")
folderName = jResp.StringOf("email_templates[i].folder.name")
folderId = jResp.StringOf("email_templates[i].folder.id")
last_usage_time = jResp.StringOf("email_templates[i].last_usage_time")
associated = jResp.BoolOf("email_templates[i].associated")
name = jResp.StringOf("email_templates[i].name")
consent_linked = jResp.BoolOf("email_templates[i].consent_linked")
modified_byName = jResp.StringOf("email_templates[i].modified_by.name")
modified_byId = jResp.StringOf("email_templates[i].modified_by.id")
id = jResp.StringOf("email_templates[i].id")
editor_mode = jResp.StringOf("email_templates[i].editor_mode")
favorite = jResp.BoolOf("email_templates[i].favorite")
created_by = jResp.StringOf("email_templates[i].created_by")
modified_by = jResp.StringOf("email_templates[i].modified_by")
i = i + 1
Wend
Curl Command
curl -X GET
-H "Authorization: Bearer <access_token>"
https://domain.com/crm/v2.1/settings/email_templates
Postman Collection Item JSON
{
"name": "Email Templates",
"request": {
"auth": {
"type": "bearer",
"bearer": [
{
"key": "token",
"value": "{{access-token}}",
"type": "string"
}
]
},
"method": "GET",
"header": [
],
"url": {
"raw": "{{api-domain}}/crm/v2.1/settings/email_templates",
"host": [
"{{api-domain}}"
],
"path": [
"crm",
"v2.1",
"settings",
"email_templates"
]
}
},
"response": [
{
"name": "SUCCESS RESPONSE",
"originalRequest": {
"method": "GET",
"header": [
],
"url": {
"raw": "{{api-domain}}/crm/v2.1/settings/email_templates",
"host": [
"{{api-domain}}"
],
"path": [
"crm",
"v2.1",
"settings",
"email_templates"
]
}
},
"status": "OK",
"code": 200,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Server",
"value": "ZGS"
},
{
"key": "Date",
"value": "Mon, 10 May 2021 12:19:25 GMT"
},
{
"key": "Content-Type",
"value": "application/json;charset=utf-8"
},
{
"key": "Transfer-Encoding",
"value": "chunked"
},
{
"key": "Connection",
"value": "keep-alive"
},
{
"key": "Referrer-Policy",
"value": "strict-origin"
},
{
"key": "X-Content-Type-Options",
"value": "nosniff"
},
{
"key": "X-XSS-Protection",
"value": "1; mode=block"
},
{
"key": "Pragma",
"value": "no-cache"
},
{
"key": "Cache-Control",
"value": "no-cache"
},
{
"key": "Expires",
"value": "Thu, 01 Jan 1970 00:00:00 GMT"
},
{
"key": "X-Frame-Options",
"value": "SAMEORIGIN"
},
{
"key": "X-ACCESSTOKEN-RESET",
"value": "2021-05-10T18:42:26+05:30"
},
{
"key": "clientVersion",
"value": "4016246"
},
{
"key": "clientsubVersion",
"value": "59f8474ad0046d6a2f6204e0448818d0"
},
{
"key": "Content-Disposition",
"value": "attachment; filename=response.json"
},
{
"key": "vary",
"value": "accept-encoding"
},
{
"key": "Content-Encoding",
"value": "gzip"
},
{
"key": "Content-Language",
"value": "en-US"
},
{
"key": "Strict-Transport-Security",
"value": "max-age=63072000"
}
],
"cookie": [
],
"body": "{\n \"email_templates\": [\n {\n \"created_time\": \"2021-02-04T14:22:19+05:30\",\n \"attachments\": null,\n \"subject\": \"Thank you mail\",\n \"module\": {\n \"api_name\": \"Contacts\",\n \"id\": \"4150868000000002179\"\n },\n \"type\": \"custom_templates\",\n \"created_by\": {\n \"name\": \"Patricia Boyle\",\n \"id\": \"4150868000000225013\"\n },\n \"modified_time\": \"2021-02-04T14:22:19+05:30\",\n \"folder\": {\n \"name\": \"Public Email Templates\",\n \"id\": \"4150868000000000077\"\n },\n \"last_usage_time\": null,\n \"associated\": true,\n \"name\": \"Thank you for registeration\",\n \"consent_linked\": false,\n \"modified_by\": {\n \"name\": \"Patricia Boyle\",\n \"id\": \"4150868000000225013\"\n },\n \"id\": \"4150868000004557001\",\n \"editor_mode\": \"gallery\",\n \"favorite\": false\n },\n {\n \"created_time\": \"2020-03-18T10:14:49+05:30\",\n \"attachments\": null,\n \"subject\": \"This is a sample email template\",\n \"module\": {\n \"api_name\": \"Contacts\",\n \"id\": \"4150868000000002179\"\n },\n \"type\": \"custom_templates\",\n \"created_by\": {\n \"name\": \"Patricia Boyle\",\n \"id\": \"4150868000000225013\"\n },\n \"modified_time\": \"2020-03-18T10:14:49+05:30\",\n \"folder\": {\n \"name\": \"Public Email Templates\",\n \"id\": \"4150868000000000077\"\n },\n \"last_usage_time\": null,\n \"associated\": true,\n \"name\": \"Sample1\",\n \"consent_linked\": false,\n \"modified_by\": {\n \"name\": \"Patricia Boyle\",\n \"id\": \"4150868000000225013\"\n },\n \"id\": \"4150868000001658001\",\n \"editor_mode\": \"gallery\",\n \"favorite\": false\n },\n {\n \"created_time\": \"2019-09-23T16:56:45+05:30\",\n \"attachments\": null,\n \"subject\": \"this is a test email\",\n \"module\": {\n \"api_name\": \"Leads\",\n \"id\": \"4150868000000002175\"\n },\n \"type\": \"custom_templates\",\n \"created_by\": {\n \"name\": \"Patricia Boyle\",\n \"id\": \"4150868000000225013\"\n },\n \"modified_time\": \"2019-09-23T16:56:45+05:30\",\n \"folder\": {\n \"name\": \"Public Email Templates\",\n \"id\": \"4150868000000000077\"\n },\n \"last_usage_time\": \"2019-09-29T20:00:03+05:30\",\n \"associated\": true,\n \"name\": \"Sample\",\n \"consent_linked\": false,\n \"modified_by\": {\n \"name\": \"Patricia Boyle\",\n \"id\": \"4150868000000225013\"\n },\n \"id\": \"4150868000000475003\",\n \"editor_mode\": \"gallery\",\n \"favorite\": false\n },\n {\n \"created_time\": \"2019-08-20T11:21:31+05:30\",\n \"attachments\": null,\n \"subject\": \"Big Deal Alert\",\n \"module\": {\n \"api_name\": \"Deals\",\n \"id\": \"4150868000000002181\"\n },\n \"type\": \"system_templates\",\n \"created_by\": null,\n \"modified_time\": \"2019-08-20T11:21:31+05:30\",\n \"folder\": {\n \"name\": \"Public Email Templates\",\n \"id\": \"4150868000000000077\"\n },\n \"last_usage_time\": \"2020-02-25T10:59:44+05:30\",\n \"associated\": true,\n \"name\": \"Big Deal Alert\",\n \"consent_linked\": false,\n \"modified_by\": null,\n \"id\": \"4150868000000000079\",\n \"editor_mode\": \"gallery\",\n \"favorite\": false\n }\n ],\n \"info\": {\n \"per_page\": 200,\n \"count\": 4,\n \"page\": 1,\n \"more_records\": false\n }\n}"
},
{
"name": "AUTHENTICATION_FAILURE",
"originalRequest": {
"method": "GET",
"header": [
],
"url": {
"raw": "{{api-domain}}/crm/v2.1/settings/email_templates",
"host": [
"{{api-domain}}"
],
"path": [
"crm",
"v2.1",
"settings",
"email_templates"
]
}
},
"status": "Unauthorized",
"code": 401,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Server",
"value": "ZGS"
},
{
"key": "Date",
"value": "Mon, 10 May 2021 12:21:01 GMT"
},
{
"key": "Content-Type",
"value": "application/json;charset=utf-8"
},
{
"key": "Content-Length",
"value": "98"
},
{
"key": "Connection",
"value": "keep-alive"
},
{
"key": "Referrer-Policy",
"value": "strict-origin"
},
{
"key": "X-Content-Type-Options",
"value": "nosniff"
},
{
"key": "X-XSS-Protection",
"value": "1; mode=block"
},
{
"key": "Pragma",
"value": "no-cache"
},
{
"key": "Cache-Control",
"value": "no-cache"
},
{
"key": "Expires",
"value": "Thu, 01 Jan 1970 00:00:00 GMT"
},
{
"key": "X-Frame-Options",
"value": "SAMEORIGIN"
},
{
"key": "X-Download-Options",
"value": "noopen"
}
],
"cookie": [
],
"body": "{\n \"code\": \"AUTHENTICATION_FAILURE\",\n \"details\": {},\n \"message\": \"Authentication failed\",\n \"status\": \"error\"\n}"
},
{
"name": "INVALID_URL_PATTERN",
"originalRequest": {
"method": "GET",
"header": [
],
"url": {
"raw": "{{api-domain}}/crm/v2.1/settings/email_template",
"host": [
"{{api-domain}}"
],
"path": [
"crm",
"v2.1",
"settings",
"email_template"
]
}
},
"status": "Not Found",
"code": 404,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Server",
"value": "ZGS"
},
{
"key": "Date",
"value": "Mon, 10 May 2021 12:21:23 GMT"
},
{
"key": "Content-Type",
"value": "application/json;charset=utf-8"
},
{
"key": "Content-Length",
"value": "131"
},
{
"key": "Connection",
"value": "keep-alive"
},
{
"key": "Referrer-Policy",
"value": "strict-origin"
},
{
"key": "X-Content-Type-Options",
"value": "nosniff"
},
{
"key": "X-XSS-Protection",
"value": "1; mode=block"
},
{
"key": "Pragma",
"value": "no-cache"
},
{
"key": "Cache-Control",
"value": "no-cache"
},
{
"key": "Expires",
"value": "Thu, 01 Jan 1970 00:00:00 GMT"
},
{
"key": "X-Frame-Options",
"value": "SAMEORIGIN"
},
{
"key": "X-ACCESSTOKEN-RESET",
"value": "2021-05-10T18:42:26+05:30"
},
{
"key": "Content-Disposition",
"value": "attachment; filename=response.json"
},
{
"key": "X-Download-Options",
"value": "noopen"
},
{
"key": "Content-Language",
"value": "en-US"
}
],
"cookie": [
],
"body": "{\n \"code\": \"INVALID_URL_PATTERN\",\n \"details\": {},\n \"message\": \"Please check if the URL trying to access is a correct one\",\n \"status\": \"error\"\n}"
},
{
"name": "OAUTH_SCOPE_MISMATCH",
"originalRequest": {
"method": "GET",
"header": [
],
"url": {
"raw": "{{api-domain}}/crm/v2.1/settings/email_templates",
"host": [
"{{api-domain}}"
],
"path": [
"crm",
"v2.1",
"settings",
"email_templates"
]
}
},
"status": "Unauthorized",
"code": 401,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Server",
"value": "ZGS"
},
{
"key": "Date",
"value": "Thu, 13 May 2021 08:43:48 GMT"
},
{
"key": "Content-Type",
"value": "application/json;charset=utf-8"
},
{
"key": "Content-Length",
"value": "113"
},
{
"key": "Connection",
"value": "keep-alive"
},
{
"key": "Referrer-Policy",
"value": "strict-origin"
},
{
"key": "X-Content-Type-Options",
"value": "nosniff"
},
{
"key": "X-XSS-Protection",
"value": "1; mode=block"
},
{
"key": "Pragma",
"value": "no-cache"
},
{
"key": "Cache-Control",
"value": "no-cache"
},
{
"key": "Expires",
"value": "Thu, 01 Jan 1970 00:00:00 GMT"
},
{
"key": "X-Frame-Options",
"value": "SAMEORIGIN"
},
{
"key": "X-Download-Options",
"value": "noopen"
}
],
"cookie": [
],
"body": "{\n \"code\": \"OAUTH_SCOPE_MISMATCH\",\n \"details\": {},\n \"message\": \"invalid oauth scope to access this URL\",\n \"status\": \"error\"\n}"
}
]
}
