Query parameters
-
List's id
Minimum length is
1
. Format should match the following pattern:^(?! *$).+$
. -
page integer
The page number to return
-
per_page integer
The number of list items to return per page
-
sort_field string
Determines which field is used to sort the results
Minimum length is
1
. Format should match the following pattern:^(?! *$).+$
. -
sort_order string
Determines the sort order, which can be
desc
orasc
Values are
desc
orasc
. -
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
-
400 application/json; Elastic-Api-Version=2023-10-31
Invalid input data response
-
401 application/json; Elastic-Api-Version=2023-10-31
Unsuccessful authentication response
-
403 application/json; Elastic-Api-Version=2023-10-31
Not enough privileges response
-
500 application/json; Elastic-Api-Version=2023-10-31
Internal server error response
curl \
-X GET https://localhost:5601/api/lists/items/_find?list_id=string
{
"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",
"deserializer": "string",
"id": "string",
"list_id": "string",
"meta": {},
"serializer": "string",
"tie_breaker_id": "string",
"type": "binary",
"updated_at": "2024-05-04T09:42:00+00:00",
"updated_by": "string",
"value": "string"
}
],
"page": 42,
"per_page": 42,
"total": 42
}
{
"error": "string",
"message": "string",
"statusCode": 42
}
{
"message": "string",
"status_code": 42
}
{
"error": "string",
"message": "string",
"statusCode": 42
}
{
"error": "string",
"message": "string",
"statusCode": 42
}
{
"message": "string",
"status_code": 42
}