Get lists

GET /api/lists/_find

Get a paginated subset of lists. By default, the first page is returned, with 20 results per page.

Query parameters

  • page integer

    The page number to return

  • per_page integer

    The number of lists to return per page

  • Determines which field is used to sort the results

    Minimum length is 1. Format should match the following pattern: ^(?! *$).+$.

  • Determines the sort order, which can be desc or asc

    Values are desc or asc.

  • cursor string

    Returns the list that come after the last list returned in the previous call (use the cursor value returned in the previous call). This parameter uses the tie_breaker_id field to ensure all lists are sorted and returned correctly.

    Minimum length is 1. Format should match the following pattern: ^(?! *$).+$.

  • filter string

    Filters the returned results according to the value of the specified field, using the : syntax.

Responses

  • 200 application/json; Elastic-Api-Version=2023-10-31

    Successful response

    Hide response attributes Show response attributes object
    • cursor string Required

      A string that is not empty and does not contain only whitespace

      Minimum length is 1. Format should match the following pattern: ^(?! *$).+$.

    • data array[object] Required
      Hide data attributes Show data attributes object
      • _version string
      • @timestamp string(date-time)
      • created_at string(date-time) Required
      • created_by string Required
      • description string Required

        A string that is not empty and does not contain only whitespace

        Minimum length is 1. Format should match the following pattern: ^(?! *$).+$.

      • id string Required

        A string that is not empty and does not contain only whitespace

        Minimum length is 1. Format should match the following pattern: ^(?! *$).+$.

      • immutable boolean Required
      • meta object

        Additional properties are allowed.

      • name string Required

        A string that is not empty and does not contain only whitespace

        Minimum length is 1. Format should match the following pattern: ^(?! *$).+$.

      • tie_breaker_id string Required
      • type string Required

        Values are binary, boolean, byte, date, date_nanos, date_range, double, double_range, float, float_range, geo_point, geo_shape, half_float, integer, integer_range, ip, ip_range, keyword, long, long_range, shape, short, or text.

      • updated_at string(date-time) Required
      • updated_by string Required
      • version integer Required

        Minimum value is 1.

    • page integer Required

      Minimum value is 0.

    • per_page integer Required

      Minimum value is 0.

    • total integer Required

      Minimum value is 0.

  • 400 application/json; Elastic-Api-Version=2023-10-31

    Invalid input data response

    One of:
  • 401 application/json; Elastic-Api-Version=2023-10-31

    Unsuccessful authentication response

    Hide response attributes Show response attributes object
  • 403 application/json; Elastic-Api-Version=2023-10-31

    Not enough privileges response

    Hide response attributes Show response attributes object
  • 500 application/json; Elastic-Api-Version=2023-10-31

    Internal server error response

    Hide response attributes Show response attributes object
GET /api/lists/_find
curl \
 -X GET https://localhost:5601/api/lists/_find
Response examples (200)
{
  "cursor": "string",
  "data": [
    {
      "_version": "string",
      "@timestamp": "2024-05-04T09:42:00+00:00",
      "created_at": "2024-05-04T09:42:00+00:00",
      "created_by": "string",
      "description": "string",
      "deserializer": "string",
      "id": "string",
      "immutable": true,
      "meta": {},
      "name": "string",
      "serializer": "string",
      "tie_breaker_id": "string",
      "type": "binary",
      "updated_at": "2024-05-04T09:42:00+00:00",
      "updated_by": "string",
      "version": 42
    }
  ],
  "page": 42,
  "per_page": 42,
  "total": 42
}
Response examples (400)
{
  "error": "string",
  "message": "string",
  "statusCode": 42
}
{
  "message": "string",
  "status_code": 42
}
Response examples (401)
{
  "error": "string",
  "message": "string",
  "statusCode": 42
}
Response examples (403)
{
  "error": "string",
  "message": "string",
  "statusCode": 42
}
Response examples (500)
{
  "message": "string",
  "status_code": 42
}