Zendesk

Zendesk Bookmarks API

The Zendesk Bookmarks API lets you programmatically manage an agents personal starred items in Zendesk, providing endpoints to list, create, and delete bookmarks. A bookmark is a lightweight record that points to another Zendesk resource (for example, something an agent wants quick access to in the interface), and its scoped to the user who created it. With the API you can fetch all of a users bookmarks, add new ones to surface important work, and remove those that are no longer relevant.

GitHub OpenAPI

Documentation

📖
Documentation
https://developer.zendesk.com/api-reference/ticketing/ticket-management/bookmarks/

Specifications

⚙
OpenAPI
https://raw.githubusercontent.com/api-evangelist/zendesk/refs/heads/main/openapi/bookmarks-openapi-original.yml

OpenAPI Specification

bookmarks-openapi-original.yml Raw ↑ 
openapi: 3.1.0
info:
  version: "1.0"
  title: Zendesk Bookmarks
  description: Needs a description.
paths:
  /api/v2/bookmarks:
    get:
      operationId: ListBookmarks
      tags:
        - Bookmarks
      summary: Zendesk Get  Api V2 Bookmarks
      description: |-
        #### Allowed For
        - Agents
      responses:
        '200':
          description: Successful response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BookmarksResponse'
              examples:
                default:
                  $ref: '#/components/examples/BookmarksResponse'
    post:
      operationId: CreateBookmark
      tags:
        - Bookmarks
      summary: Zendesk Post  Api V2 Bookmarks
      description: |-
        #### Allowed For
        - Agents
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/BookmarkCreateRequest'
            examples:
              default:
                $ref: '#/components/examples/BookmarkCreateRequest'
      responses:
        '200':
          description: Successfully created
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BookmarkResponse'
              examples:
                default:
                  $ref: '#/components/examples/BookmarkResponse'
        '201':
          description: Successfully created
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BookmarkResponse'
              examples:
                default:
                  $ref: '#/components/examples/BookmarkResponse'
  /api/v2/bookmarks/{bookmark_id}:
    parameters:
      - $ref: '#/components/parameters/BookmarkId'
    delete:
      operationId: DeleteBookmark
      tags:
        - Bookmarks
      summary: Zendesk Delete  Api V2 Bookmarks Bookmark_id
      description: >-
        #### Allowed For

        - Agents (own bookmarks only)


        If the bookmark already exists with a specified ticket id, the response
        status will be `http Status: 200 OK`.
      responses:
        '204':
          description: No content
components:
  schemas:
    BookmarksResponse:
      title: Bookmarks
      type: object
      allOf:
        - $ref: '#/components/schemas/OffsetPaginationObject'
        - type: object
          properties:
            bookmarks:
              type: array
              items:
                $ref: '#/components/schemas/BookmarkObject'
    BookmarkResponse:
      type: object
      properties:
        bookmark:
          $ref: '#/components/schemas/BookmarkObject'
tags:
  - name: Bookmarks