YQueue DocsDevelopers

Schema

Cursor Search Request

A standard request body for cursor-based search endpoints.

  • Foundation

Overview

object · 2 properties · 0 required

Properties

cursor

string | null

The cursor from a previous request. See the "Cursor Pagination" documentation.

Example eyJ1dWlkIjoiYTUxODNmM2ItNDRjZC00Y2ZlLTk4N2UtZTU1NGU4MTkxYmQ0In0
Min length 1
Nullable Yes

cursor_limit

integer | null

The maximum number of results to return. See the "Cursor Pagination" documentation.

Minimum 1
Maximum 100
Nullable Yes

Used by

Raw YAML
Download source
title: Cursor Search Request
type: object
description: A standard request body for cursor-based search endpoints.
properties:
  cursor:
    type:
      - string
      - 'null'
    minLength: 1
    description: |-
      The cursor from a previous request.

      See the "Cursor Pagination" documentation.
    example: eyJ1dWlkIjoiYTUxODNmM2ItNDRjZC00Y2ZlLTk4N2UtZTU1NGU4MTkxYmQ0In0
  cursor_limit:
    type:
      - integer
      - 'null'
    minimum: 1
    maximum: 100
    description: |-
      The maximum number of results to return.

      See the "Cursor Pagination" documentation.
x-tags:
  - Foundation

Search documentation

Search across this documentation site.