Cypher
Community
Enterprise

List saved queries

Changed on

Get all saved queries for the current user

get/api/v2/saved-queries

Request

  • Base URL: / (relative, and the document was published on a file host, not at the API’s origin)
  • URL: /api/v2/saved-queries
  • Auth: one of:
    • HTTP bearer
    • API key in header Authorization and API key in header RequestDate and API key in header Signature

Query parameters

skipinteger

The number of items to skip in a paginated response.

This query parameter is used for determining the number of objects to skip in pagination.

limitinteger

The limit of results requested by the client.

This query parameter is used for setting an upper limit of objects returned in paginated responses.

sort_bystring

Sort by column. Can be used multiple times; prepend a hyphen for descending order. See parameter description for details about which columns are sortable.

Sortable columns are user_id, name, query, id, extension_id, category, created_at, updated_at, deleted_at.

namestring

Filter results by column string value. Valid filter predicates are eq, ~eq, neq.

querystring

Filter results by column string value. Valid filter predicates are eq, ~eq, neq.

user_idstring

Filter results by column string value. Valid filter predicates are eq, ~eq, neq.

extension_idstring

Filter results by column integer value. Valid filter predicates are eq, neq, gt, gte, lt, lte.

categorystring

Filter results by column string value. Valid filter predicates are eq, ~eq, neq.

scope'all' | 'owned' | 'shared' | 'public'

Response

OK

countinteger

The total number of results.

skipinteger

The number of items to skip in a paginated response.

limitinteger

The limit of results requested by the client.

Changes

  • 48c1cd093fe1Revision changes
    • info

      added the new optional query request parameter category

    • info

      added the new optional query request parameter extension_id

    • info

      added the optional property //////// to the response with the status

    • info

      added the optional property //////// to the response with the status

  • 40bf219eced6Revision changes
    • breaking

      added the pattern ^((eq|~eq|neq):)?[^:]+$ to the query request parameter name

    • breaking

      added the pattern ^((eq|~eq|neq):)?[^:]+$ to the query request parameter query

    • breaking

      added the pattern ^((eq|~eq|neq):)?[^:]+$ to the query request parameter user_id