autoit / Support API / List Bookmarks
Back to Collection Items
; This example assumes the Chilkat API to have been previously unlocked.
; See Global Unlock Sample for sample code.
$oHttp = ObjCreate("Chilkat.Http")
Local $bSuccess
$oHttp.BasicAuth = True
$oHttp.Login = "login"
$oHttp.Password = "password"
$oHttp.SetRequestHeader "Accept","application/json"
$oSbResponseBody = ObjCreate("Chilkat.StringBuilder")
$bSuccess = $oHttp.QuickGetSb("https://example.zendesk.com/api/v2/bookmarks",$oSbResponseBody)
If ($bSuccess = False) Then
ConsoleWrite($oHttp.LastErrorText & @CRLF)
Exit
EndIf
$oJResp = ObjCreate("Chilkat.JsonObject")
$oJResp.LoadSb($oSbResponseBody)
$oJResp.EmitCompact = False
ConsoleWrite("Response Body:" & @CRLF)
ConsoleWrite($oJResp.Emit() & @CRLF)
Local $iRespStatusCode = $oHttp.LastStatus
ConsoleWrite("Response Status Code = " & $iRespStatusCode & @CRLF)
If ($iRespStatusCode >= 400) Then
ConsoleWrite("Response Header:" & @CRLF)
ConsoleWrite($oHttp.LastHeader & @CRLF)
ConsoleWrite("Failed." & @CRLF)
Exit
EndIf
; 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
Local $sCreated_at
Local $sId
Local $sRequester_id
Local $sAllow_attachments
Local $sAllow_channelback
Local $sAssignee_email
Local $sAssignee_id
Local $sAttribute_value_ids
Local $sBrand_id
Local $sCollaborator_ids
Local $sCreated_at
Local $sCustom_fields
Local $sCustom_status_id
Local $sDescription
Local $sDue_at
Local $sEmail_cc_ids
Local $sExternal_id
Local $sFollower_ids
Local $sFollowup_ids
Local $sForum_topic_id
Local $sFrom_messaging_channel
Local $sGroup_id
Local $sHas_incidents
Local $sId
Local $sIs_public
Local $sMacro_id
Local $sMacro_ids
Local $sOrganization_id
Local $sPriority
Local $sProblem_id
Local $sRaw_subject
Local $sRecipient
Local $sSafe_update
Local $sQui_c2
Local $sElit_74
Local $sSharing_agreement_ids
Local $sStatus
Local $sSubject
Local $sSubmitter_id
Local $sTags
Local $sTicket_form_id
Local $sV_Type
Local $sUpdated_at
Local $sUpdated_stamp
Local $sV_Url
Local $sChannel
Local $sAd_58d
Local $sVia_followup_source_id
Local $sVia_id
Local $sUrl
Local $bDolor3b
Local $bNonc7
Local $sExercitation_19
Local $sProident_0
Local $iJ
Local $iCount_j
Local $sEmail
Local $sName
Local $sCount = $oJResp.StringOf("count")
Local $sNext_page = $oJResp.StringOf("next_page")
Local $sPrevious_page = $oJResp.StringOf("previous_page")
Local $i = 0
Local $iCount_i = $oJResp.SizeOfArray("bookmarks")
While $i < $iCount_i
$oJResp.I = $i
$sCreated_at = $oJResp.StringOf("bookmarks[i].created_at")
$sId = $oJResp.StringOf("bookmarks[i].id")
$sRequester_id = $oJResp.StringOf("bookmarks[i].ticket.requester_id")
$sAllow_attachments = $oJResp.StringOf("bookmarks[i].ticket.allow_attachments")
$sAllow_channelback = $oJResp.StringOf("bookmarks[i].ticket.allow_channelback")
$sAssignee_email = $oJResp.StringOf("bookmarks[i].ticket.assignee_email")
$sAssignee_id = $oJResp.StringOf("bookmarks[i].ticket.assignee_id")
$sAttribute_value_ids = $oJResp.StringOf("bookmarks[i].ticket.attribute_value_ids")
$sBrand_id = $oJResp.StringOf("bookmarks[i].ticket.brand_id")
$sCollaborator_ids = $oJResp.StringOf("bookmarks[i].ticket.collaborator_ids")
$sCreated_at = $oJResp.StringOf("bookmarks[i].ticket.created_at")
$sCustom_fields = $oJResp.StringOf("bookmarks[i].ticket.custom_fields")
$sCustom_status_id = $oJResp.StringOf("bookmarks[i].ticket.custom_status_id")
$sDescription = $oJResp.StringOf("bookmarks[i].ticket.description")
$sDue_at = $oJResp.StringOf("bookmarks[i].ticket.due_at")
$sEmail_cc_ids = $oJResp.StringOf("bookmarks[i].ticket.email_cc_ids")
$sExternal_id = $oJResp.StringOf("bookmarks[i].ticket.external_id")
$sFollower_ids = $oJResp.StringOf("bookmarks[i].ticket.follower_ids")
$sFollowup_ids = $oJResp.StringOf("bookmarks[i].ticket.followup_ids")
$sForum_topic_id = $oJResp.StringOf("bookmarks[i].ticket.forum_topic_id")
$sFrom_messaging_channel = $oJResp.StringOf("bookmarks[i].ticket.from_messaging_channel")
$sGroup_id = $oJResp.StringOf("bookmarks[i].ticket.group_id")
$sHas_incidents = $oJResp.StringOf("bookmarks[i].ticket.has_incidents")
$sId = $oJResp.StringOf("bookmarks[i].ticket.id")
$sIs_public = $oJResp.StringOf("bookmarks[i].ticket.is_public")
$sMacro_id = $oJResp.StringOf("bookmarks[i].ticket.macro_id")
$sMacro_ids = $oJResp.StringOf("bookmarks[i].ticket.macro_ids")
$sOrganization_id = $oJResp.StringOf("bookmarks[i].ticket.organization_id")
$sPriority = $oJResp.StringOf("bookmarks[i].ticket.priority")
$sProblem_id = $oJResp.StringOf("bookmarks[i].ticket.problem_id")
$sRaw_subject = $oJResp.StringOf("bookmarks[i].ticket.raw_subject")
$sRecipient = $oJResp.StringOf("bookmarks[i].ticket.recipient")
$sSafe_update = $oJResp.StringOf("bookmarks[i].ticket.safe_update")
$sQui_c2 = $oJResp.StringOf("bookmarks[i].ticket.satisfaction_rating.qui_c2")
$sElit_74 = $oJResp.StringOf("bookmarks[i].ticket.satisfaction_rating.elit_74")
$sSharing_agreement_ids = $oJResp.StringOf("bookmarks[i].ticket.sharing_agreement_ids")
$sStatus = $oJResp.StringOf("bookmarks[i].ticket.status")
$sSubject = $oJResp.StringOf("bookmarks[i].ticket.subject")
$sSubmitter_id = $oJResp.StringOf("bookmarks[i].ticket.submitter_id")
$sTags = $oJResp.StringOf("bookmarks[i].ticket.tags")
$sTicket_form_id = $oJResp.StringOf("bookmarks[i].ticket.ticket_form_id")
$sV_Type = $oJResp.StringOf("bookmarks[i].ticket.type")
$sUpdated_at = $oJResp.StringOf("bookmarks[i].ticket.updated_at")
$sUpdated_stamp = $oJResp.StringOf("bookmarks[i].ticket.updated_stamp")
$sV_Url = $oJResp.StringOf("bookmarks[i].ticket.url")
$sChannel = $oJResp.StringOf("bookmarks[i].ticket.via.channel")
$sAd_58d = $oJResp.StringOf("bookmarks[i].ticket.via.source.ad_58d")
$sVia_followup_source_id = $oJResp.StringOf("bookmarks[i].ticket.via_followup_source_id")
$sVia_id = $oJResp.StringOf("bookmarks[i].ticket.via_id")
$sUrl = $oJResp.StringOf("bookmarks[i].url")
$bDolor3b = $oJResp.BoolOf("bookmarks[i].ticket.satisfaction_rating.dolor3b")
$bNonc7 = $oJResp.BoolOf("bookmarks[i].ticket.satisfaction_rating.nonc7")
$sExercitation_19 = $oJResp.StringOf("bookmarks[i].ticket.via.source.exercitation_19")
$sProident_0 = $oJResp.StringOf("bookmarks[i].ticket.via.source.proident_0")
$iJ = 0
$iCount_j = $oJResp.SizeOfArray("bookmarks[i].ticket.collaborators")
While $iJ < $iCount_j
$oJResp.J = $iJ
$sEmail = $oJResp.StringOf("bookmarks[i].ticket.collaborators[j].email")
$sName = $oJResp.StringOf("bookmarks[i].ticket.collaborators[j].name")
$iJ = $iJ + 1
Wend
$i = $i + 1
Wend
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}"
}
]
}
