---
title: "Retrieve bookmarks"
method: GET
path: "/bookmarks"
tags: ["Bookmarks"]
---

# Retrieve bookmarks

`GET /bookmarks`

This endpoint lists bookmarks, or a subset of bookmarks.

## Query parameters

- `id` union — Filter by bookmark IDs
  - string — Bookmark ID
  - string[]
- `name` union — Filter by bookmark name
  - string — Bookmark name
  - string[]
- `webhook_id` union — Filter by associated connection (webhook) ID
  - string — Connection (webhook) ID
  - string[]
- `event_data_id` union — Filter by associated event data ID
  - string — Event Data ID
  - string[]
- `label` union — Filter by label
  - string — Bookmark label
  - string[]
- `last_used_at` union — Filter by last used date
  - string, date-time, nullable — Last used date
  - Operators
    - `gt` string, date-time, nullable
    - `gte` string, date-time, nullable
    - `le` string, date-time, nullable
    - `lte` string, date-time, nullable
    - `any` boolean
    - `all` boolean
- `order_by` union — Sort key(s)
  - 'created_at'
  - string[]
- `dir` union — Sort direction(s)
  - 'asc' | 'desc'
  - string[]
- `limit` integer — Result set size
- `next` string — The ID to provide in the query to get the next set of results
- `prev` string — The ID to provide in the query to get the previous set of results

## Response `200`

List of bookmarks

- BookmarkPaginatedResult
  - `pagination` SeekPagination
    - `order_by` union
      - string
      - string[]
    - `dir` union
      - union
        - 'asc'
        - 'desc'
        - 'ASC'
        - 'DESC'
      - OrderByDirection[]
        - union
          - 'asc'
          - 'desc'
          - 'ASC'
          - 'DESC'
    - `limit` integer
    - `prev` string
    - `next` string
  - `count` integer
  - `models` Bookmark[]
    - `id` string, required — ID of the bookmark
    - `team_id` string, required — ID of the project
    - `webhook_id` string, required — ID of the associated connection (webhook)
    - `event_data_id` string, required — ID of the bookmarked event data
    - `label` string, required — Descriptive name of the bookmark
    - `alias` string, nullable — Alternate alias for the bookmark
    - `data` ShortEventData, nullable — Request data
      - `path` string, required — Request path
      - `query` string, nullable, required — Raw query param string
      - `parsed_query` union, required — JSON representation of query params
        - string, nullable
        - object
      - `headers` union, required — JSON representation of the headers
        - string
        - object
      - `body` union, required — JSON or string representation of the body
        - string
        - object
        - unknown[]
          - unknown
      - `is_large_payload` boolean, nullable — Whether the payload is considered large payload and not searchable
    - `last_used_at` string, date-time, nullable — Date the bookmark was last manually triggered
    - `updated_at` string, date-time, required — Date the bookmark was last updated
    - `created_at` string, date-time, required — Date the bookmark was created

## Other responses

- `400` — Bad Request
- `422` — Unprocessable Entity

---

[API](https://skmtc.dev/hookdeck/apis/hookdeck-admin-rest-api.md) · [All operations](https://skmtc.dev/hookdeck/apis/hookdeck-admin-rest-api/llms.txt) · [OpenAPI document](https://skmtc-service-production.skmtc.workers.dev/v1/apis/hookdeck/hookdeck-admin-rest-api/revisions/091808eac7fa/schema)