TCL / Support API / List Bookmarks
Back to Collection Items
load ./chilkat.dll
# This example assumes the Chilkat API to have been previously unlocked.
# See Global Unlock Sample for sample code.
set http [new_CkHttp]
CkHttp_put_BasicAuth $http 1
CkHttp_put_Login $http "login"
CkHttp_put_Password $http "password"
CkHttp_SetRequestHeader $http "Accept" "application/json"
set sbResponseBody [new_CkStringBuilder]
set success [CkHttp_QuickGetSb $http "https://example.zendesk.com/api/v2/bookmarks" $sbResponseBody]
if {$success == 0} then {
puts [CkHttp_lastErrorText $http]
delete_CkHttp $http
delete_CkStringBuilder $sbResponseBody
exit
}
set jResp [new_CkJsonObject]
CkJsonObject_LoadSb $jResp $sbResponseBody
CkJsonObject_put_EmitCompact $jResp 0
puts "Response Body:"
puts [CkJsonObject_emit $jResp]
set respStatusCode [CkHttp_get_LastStatus $http]
puts "Response Status Code = $respStatusCode"
if {$respStatusCode >= 400} then {
puts "Response Header:"
puts [CkHttp_lastHeader $http]
puts "Failed."
delete_CkHttp $http
delete_CkStringBuilder $sbResponseBody
delete_CkJsonObject $jResp
exit
}
# Sample JSON response:
# (Sample code for parsing the JSON response is shown below)
# {
# "count": "<integer>",
# "next_page": "<string>",
# "previous_page": "<string>",
# "bookmarks": [
# {
# "created_at": "<dateTime>",
# "id": "<integer>",
# "ticket": {
# "requester_id": "<integer>",
# "allow_attachments": "<boolean>",
# "allow_channelback": "<boolean>",
# "assignee_email": "<string>",
# "assignee_id": "<integer>",
# "attribute_value_ids": "<array>",
# "brand_id": "<integer>",
# "collaborator_ids": "<array>",
# "collaborators": [
# {
# "email": "<email>",
# "name": "<string>"
# },
# {
# "email": "<email>",
# "name": "<string>"
# }
# ],
# "comment": {},
# "created_at": "<dateTime>",
# "custom_fields": "<array>",
# "custom_status_id": "<integer>",
# "description": "<string>",
# "due_at": "<dateTime>",
# "email_cc_ids": "<array>",
# "email_ccs": {},
# "external_id": "<string>",
# "follower_ids": "<array>",
# "followers": {},
# "followup_ids": "<array>",
# "forum_topic_id": "<integer>",
# "from_messaging_channel": "<boolean>",
# "group_id": "<integer>",
# "has_incidents": "<boolean>",
# "id": "<integer>",
# "is_public": "<boolean>",
# "macro_id": "<integer>",
# "macro_ids": "<array>",
# "metadata": {},
# "organization_id": "<integer>",
# "priority": "normal",
# "problem_id": "<integer>",
# "raw_subject": "<string>",
# "recipient": "<string>",
# "requester": {},
# "safe_update": "<boolean>",
# "satisfaction_rating": {
# "qui_c2": "laboris in reprehenderit pariatur",
# "elit_74": 85725084.5127286
# },
# "sharing_agreement_ids": "<array>",
# "status": "solved",
# "subject": "<string>",
# "submitter_id": "<integer>",
# "tags": "<array>",
# "ticket_form_id": "<integer>",
# "type": "question",
# "updated_at": "<dateTime>",
# "updated_stamp": "<string>",
# "url": "<string>",
# "via": {
# "channel": "<string>",
# "source": {
# "ad_58d": "ex Duis est"
# }
# },
# "via_followup_source_id": "<integer>",
# "via_id": "<integer>",
# "voice_comment": {}
# },
# "url": "<string>"
# },
# {
# "created_at": "<dateTime>",
# "id": "<integer>",
# "ticket": {
# "requester_id": "<integer>",
# "allow_attachments": "<boolean>",
# "allow_channelback": "<boolean>",
# "assignee_email": "<string>",
# "assignee_id": "<integer>",
# "attribute_value_ids": "<array>",
# "brand_id": "<integer>",
# "collaborator_ids": "<array>",
# "collaborators": [
# {
# "email": "<email>",
# "name": "<string>"
# },
# {
# "email": "<email>",
# "name": "<string>"
# }
# ],
# "comment": {},
# "created_at": "<dateTime>",
# "custom_fields": "<array>",
# "custom_status_id": "<integer>",
# "description": "<string>",
# "due_at": "<dateTime>",
# "email_cc_ids": "<array>",
# "email_ccs": {},
# "external_id": "<string>",
# "follower_ids": "<array>",
# "followers": {},
# "followup_ids": "<array>",
# "forum_topic_id": "<integer>",
# "from_messaging_channel": "<boolean>",
# "group_id": "<integer>",
# "has_incidents": "<boolean>",
# "id": "<integer>",
# "is_public": "<boolean>",
# "macro_id": "<integer>",
# "macro_ids": "<array>",
# "metadata": {},
# "organization_id": "<integer>",
# "priority": "low",
# "problem_id": "<integer>",
# "raw_subject": "<string>",
# "recipient": "<string>",
# "requester": {},
# "safe_update": "<boolean>",
# "satisfaction_rating": {
# "dolor3b": true,
# "nonc7": false
# },
# "sharing_agreement_ids": "<array>",
# "status": "solved",
# "subject": "<string>",
# "submitter_id": "<integer>",
# "tags": "<array>",
# "ticket_form_id": "<integer>",
# "type": "task",
# "updated_at": "<dateTime>",
# "updated_stamp": "<string>",
# "url": "<string>",
# "via": {
# "channel": "<string>",
# "source": {
# "exercitation_19": "incididunt tempor minim",
# "proident_0": "proident qui ullamco"
# }
# },
# "via_followup_source_id": "<integer>",
# "via_id": "<integer>",
# "voice_comment": {}
# },
# "url": "<string>"
# }
# ]
# }
# Sample code for parsing the JSON response...
# Use this online tool to generate parsing code from sample JSON: Generate JSON Parsing Code
set count [CkJsonObject_stringOf $jResp "count"]
set next_page [CkJsonObject_stringOf $jResp "next_page"]
set previous_page [CkJsonObject_stringOf $jResp "previous_page"]
set i 0
set count_i [CkJsonObject_SizeOfArray $jResp "bookmarks"]
while {$i < $count_i} {
CkJsonObject_put_I $jResp $i
set created_at [CkJsonObject_stringOf $jResp "bookmarks[i].created_at"]
set id [CkJsonObject_stringOf $jResp "bookmarks[i].id"]
set Requester_id [CkJsonObject_stringOf $jResp "bookmarks[i].ticket.requester_id"]
set Allow_attachments [CkJsonObject_stringOf $jResp "bookmarks[i].ticket.allow_attachments"]
set Allow_channelback [CkJsonObject_stringOf $jResp "bookmarks[i].ticket.allow_channelback"]
set Assignee_email [CkJsonObject_stringOf $jResp "bookmarks[i].ticket.assignee_email"]
set Assignee_id [CkJsonObject_stringOf $jResp "bookmarks[i].ticket.assignee_id"]
set Attribute_value_ids [CkJsonObject_stringOf $jResp "bookmarks[i].ticket.attribute_value_ids"]
set Brand_id [CkJsonObject_stringOf $jResp "bookmarks[i].ticket.brand_id"]
set Collaborator_ids [CkJsonObject_stringOf $jResp "bookmarks[i].ticket.collaborator_ids"]
set Created_at [CkJsonObject_stringOf $jResp "bookmarks[i].ticket.created_at"]
set Custom_fields [CkJsonObject_stringOf $jResp "bookmarks[i].ticket.custom_fields"]
set Custom_status_id [CkJsonObject_stringOf $jResp "bookmarks[i].ticket.custom_status_id"]
set Description [CkJsonObject_stringOf $jResp "bookmarks[i].ticket.description"]
set Due_at [CkJsonObject_stringOf $jResp "bookmarks[i].ticket.due_at"]
set Email_cc_ids [CkJsonObject_stringOf $jResp "bookmarks[i].ticket.email_cc_ids"]
set External_id [CkJsonObject_stringOf $jResp "bookmarks[i].ticket.external_id"]
set Follower_ids [CkJsonObject_stringOf $jResp "bookmarks[i].ticket.follower_ids"]
set Followup_ids [CkJsonObject_stringOf $jResp "bookmarks[i].ticket.followup_ids"]
set Forum_topic_id [CkJsonObject_stringOf $jResp "bookmarks[i].ticket.forum_topic_id"]
set From_messaging_channel [CkJsonObject_stringOf $jResp "bookmarks[i].ticket.from_messaging_channel"]
set Group_id [CkJsonObject_stringOf $jResp "bookmarks[i].ticket.group_id"]
set Has_incidents [CkJsonObject_stringOf $jResp "bookmarks[i].ticket.has_incidents"]
set Id [CkJsonObject_stringOf $jResp "bookmarks[i].ticket.id"]
set Is_public [CkJsonObject_stringOf $jResp "bookmarks[i].ticket.is_public"]
set Macro_id [CkJsonObject_stringOf $jResp "bookmarks[i].ticket.macro_id"]
set Macro_ids [CkJsonObject_stringOf $jResp "bookmarks[i].ticket.macro_ids"]
set Organization_id [CkJsonObject_stringOf $jResp "bookmarks[i].ticket.organization_id"]
set Priority [CkJsonObject_stringOf $jResp "bookmarks[i].ticket.priority"]
set Problem_id [CkJsonObject_stringOf $jResp "bookmarks[i].ticket.problem_id"]
set Raw_subject [CkJsonObject_stringOf $jResp "bookmarks[i].ticket.raw_subject"]
set Recipient [CkJsonObject_stringOf $jResp "bookmarks[i].ticket.recipient"]
set Safe_update [CkJsonObject_stringOf $jResp "bookmarks[i].ticket.safe_update"]
set Qui_c2 [CkJsonObject_stringOf $jResp "bookmarks[i].ticket.satisfaction_rating.qui_c2"]
set Elit_74 [CkJsonObject_stringOf $jResp "bookmarks[i].ticket.satisfaction_rating.elit_74"]
set Sharing_agreement_ids [CkJsonObject_stringOf $jResp "bookmarks[i].ticket.sharing_agreement_ids"]
set Status [CkJsonObject_stringOf $jResp "bookmarks[i].ticket.status"]
set Subject [CkJsonObject_stringOf $jResp "bookmarks[i].ticket.subject"]
set Submitter_id [CkJsonObject_stringOf $jResp "bookmarks[i].ticket.submitter_id"]
set Tags [CkJsonObject_stringOf $jResp "bookmarks[i].ticket.tags"]
set Ticket_form_id [CkJsonObject_stringOf $jResp "bookmarks[i].ticket.ticket_form_id"]
set v_Type [CkJsonObject_stringOf $jResp "bookmarks[i].ticket.type"]
set Updated_at [CkJsonObject_stringOf $jResp "bookmarks[i].ticket.updated_at"]
set Updated_stamp [CkJsonObject_stringOf $jResp "bookmarks[i].ticket.updated_stamp"]
set v_Url [CkJsonObject_stringOf $jResp "bookmarks[i].ticket.url"]
set Channel [CkJsonObject_stringOf $jResp "bookmarks[i].ticket.via.channel"]
set Ad_58d [CkJsonObject_stringOf $jResp "bookmarks[i].ticket.via.source.ad_58d"]
set Via_followup_source_id [CkJsonObject_stringOf $jResp "bookmarks[i].ticket.via_followup_source_id"]
set Via_id [CkJsonObject_stringOf $jResp "bookmarks[i].ticket.via_id"]
set url [CkJsonObject_stringOf $jResp "bookmarks[i].url"]
set Dolor3b [CkJsonObject_BoolOf $jResp "bookmarks[i].ticket.satisfaction_rating.dolor3b"]
set Nonc7 [CkJsonObject_BoolOf $jResp "bookmarks[i].ticket.satisfaction_rating.nonc7"]
set Exercitation_19 [CkJsonObject_stringOf $jResp "bookmarks[i].ticket.via.source.exercitation_19"]
set Proident_0 [CkJsonObject_stringOf $jResp "bookmarks[i].ticket.via.source.proident_0"]
set j 0
set count_j [CkJsonObject_SizeOfArray $jResp "bookmarks[i].ticket.collaborators"]
while {$j < $count_j} {
CkJsonObject_put_J $jResp $j
set email [CkJsonObject_stringOf $jResp "bookmarks[i].ticket.collaborators[j].email"]
set name [CkJsonObject_stringOf $jResp "bookmarks[i].ticket.collaborators[j].name"]
set j [expr $j + 1]
}
set i [expr $i + 1]
}
delete_CkHttp $http
delete_CkStringBuilder $sbResponseBody
delete_CkJsonObject $jResp
Curl Command
curl -u login:password -X GET
-H "Accept: application/json"
https://example.zendesk.com/api/v2/bookmarks
Postman Collection Item JSON
{
"name": "List Bookmarks",
"request": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
}
],
"url": {
"raw": "{{baseUrl}}/api/v2/bookmarks",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"bookmarks"
]
},
"description": "#### Allowed For\n- Agents"
},
"response": [
{
"name": "Successful response",
"originalRequest": {
"method": "GET",
"header": [
{
"description": "Added as a part of security scheme: basic",
"key": "Authorization",
"value": "Basic <credentials>"
}
],
"url": {
"raw": "{{baseUrl}}/api/v2/bookmarks",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"bookmarks"
]
}
},
"status": "OK",
"code": 200,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [
],
"body": "{\n \"count\": \"<integer>\",\n \"next_page\": \"<string>\",\n \"previous_page\": \"<string>\",\n \"bookmarks\": [\n {\n \"created_at\": \"<dateTime>\",\n \"id\": \"<integer>\",\n \"ticket\": {\n \"requester_id\": \"<integer>\",\n \"allow_attachments\": \"<boolean>\",\n \"allow_channelback\": \"<boolean>\",\n \"assignee_email\": \"<string>\",\n \"assignee_id\": \"<integer>\",\n \"attribute_value_ids\": \"<array>\",\n \"brand_id\": \"<integer>\",\n \"collaborator_ids\": \"<array>\",\n \"collaborators\": [\n {\n \"email\": \"<email>\",\n \"name\": \"<string>\"\n },\n {\n \"email\": \"<email>\",\n \"name\": \"<string>\"\n }\n ],\n \"comment\": {},\n \"created_at\": \"<dateTime>\",\n \"custom_fields\": \"<array>\",\n \"custom_status_id\": \"<integer>\",\n \"description\": \"<string>\",\n \"due_at\": \"<dateTime>\",\n \"email_cc_ids\": \"<array>\",\n \"email_ccs\": {},\n \"external_id\": \"<string>\",\n \"follower_ids\": \"<array>\",\n \"followers\": {},\n \"followup_ids\": \"<array>\",\n \"forum_topic_id\": \"<integer>\",\n \"from_messaging_channel\": \"<boolean>\",\n \"group_id\": \"<integer>\",\n \"has_incidents\": \"<boolean>\",\n \"id\": \"<integer>\",\n \"is_public\": \"<boolean>\",\n \"macro_id\": \"<integer>\",\n \"macro_ids\": \"<array>\",\n \"metadata\": {},\n \"organization_id\": \"<integer>\",\n \"priority\": \"normal\",\n \"problem_id\": \"<integer>\",\n \"raw_subject\": \"<string>\",\n \"recipient\": \"<string>\",\n \"requester\": {},\n \"safe_update\": \"<boolean>\",\n \"satisfaction_rating\": {\n \"qui_c2\": \"laboris in reprehenderit pariatur\",\n \"elit_74\": 85725084.5127286\n },\n \"sharing_agreement_ids\": \"<array>\",\n \"status\": \"solved\",\n \"subject\": \"<string>\",\n \"submitter_id\": \"<integer>\",\n \"tags\": \"<array>\",\n \"ticket_form_id\": \"<integer>\",\n \"type\": \"question\",\n \"updated_at\": \"<dateTime>\",\n \"updated_stamp\": \"<string>\",\n \"url\": \"<string>\",\n \"via\": {\n \"channel\": \"<string>\",\n \"source\": {\n \"ad_58d\": \"ex Duis est\"\n }\n },\n \"via_followup_source_id\": \"<integer>\",\n \"via_id\": \"<integer>\",\n \"voice_comment\": {}\n },\n \"url\": \"<string>\"\n },\n {\n \"created_at\": \"<dateTime>\",\n \"id\": \"<integer>\",\n \"ticket\": {\n \"requester_id\": \"<integer>\",\n \"allow_attachments\": \"<boolean>\",\n \"allow_channelback\": \"<boolean>\",\n \"assignee_email\": \"<string>\",\n \"assignee_id\": \"<integer>\",\n \"attribute_value_ids\": \"<array>\",\n \"brand_id\": \"<integer>\",\n \"collaborator_ids\": \"<array>\",\n \"collaborators\": [\n {\n \"email\": \"<email>\",\n \"name\": \"<string>\"\n },\n {\n \"email\": \"<email>\",\n \"name\": \"<string>\"\n }\n ],\n \"comment\": {},\n \"created_at\": \"<dateTime>\",\n \"custom_fields\": \"<array>\",\n \"custom_status_id\": \"<integer>\",\n \"description\": \"<string>\",\n \"due_at\": \"<dateTime>\",\n \"email_cc_ids\": \"<array>\",\n \"email_ccs\": {},\n \"external_id\": \"<string>\",\n \"follower_ids\": \"<array>\",\n \"followers\": {},\n \"followup_ids\": \"<array>\",\n \"forum_topic_id\": \"<integer>\",\n \"from_messaging_channel\": \"<boolean>\",\n \"group_id\": \"<integer>\",\n \"has_incidents\": \"<boolean>\",\n \"id\": \"<integer>\",\n \"is_public\": \"<boolean>\",\n \"macro_id\": \"<integer>\",\n \"macro_ids\": \"<array>\",\n \"metadata\": {},\n \"organization_id\": \"<integer>\",\n \"priority\": \"low\",\n \"problem_id\": \"<integer>\",\n \"raw_subject\": \"<string>\",\n \"recipient\": \"<string>\",\n \"requester\": {},\n \"safe_update\": \"<boolean>\",\n \"satisfaction_rating\": {\n \"dolor3b\": true,\n \"nonc7\": false\n },\n \"sharing_agreement_ids\": \"<array>\",\n \"status\": \"solved\",\n \"subject\": \"<string>\",\n \"submitter_id\": \"<integer>\",\n \"tags\": \"<array>\",\n \"ticket_form_id\": \"<integer>\",\n \"type\": \"task\",\n \"updated_at\": \"<dateTime>\",\n \"updated_stamp\": \"<string>\",\n \"url\": \"<string>\",\n \"via\": {\n \"channel\": \"<string>\",\n \"source\": {\n \"exercitation_19\": \"incididunt tempor minim\",\n \"proident_0\": \"proident qui ullamco\"\n }\n },\n \"via_followup_source_id\": \"<integer>\",\n \"via_id\": \"<integer>\",\n \"voice_comment\": {}\n },\n \"url\": \"<string>\"\n }\n ]\n}"
}
]
}
