Skip to main content

List keys in an entity namespace

List all keys in the specified entity namespace with pagination.

  • entity: Entity namespace (user or event)
  • limit: Number of keys to return (1-1000, default 100)
  • cursor: Pagination cursor from previous response
  • sort: Sort order (asc or desc, default asc)

Returns a paginated list of keys with metadata. Use the cursor from the response to fetch the next page. The has_more field indicates if there are more results.

Path Parameters
entity KVEntity REQUIRED

Possible values: [user, event]

Entity namespace types for KV storage

Query Parameters
limit Limit

Possible values: 1 ≤ value ≤ 1000

Number of keys to return

Number of keys to return

cursor Cursor

Pagination cursor

Pagination cursor

sort Sort

Sort order: asc or desc

Sort order: asc or desc

Responses
200

Successful Response

Schema OPTIONAL
ok Ok OPTIONAL

Indicates if the request was successful or not.

data object

Response data for list operation

entity KVEntity

Possible values: [user, event]

Entity namespace types for KV storage

keys object[]
key Key
content_type Content Type
size_bytes Size Bytes
created_at date-time
updated_at date-time
expires_at Expires At
cursor Cursor
has_more Has More
total_count Total Count
default

Default Response

Schema OPTIONAL
ok Ok OPTIONAL

Indicates if the request was successful or not.

errors object[]

List of errors

type uri

Possible values: 1 ≤ length ≤ 2083

A string containing a URI reference that identifies the problem type.

status Status

Possible values: 399 < value < 600

A number indicating the HTTP status code.

title Title

Possible values: 5 ≤ length

A string containing a short, human-readable summary of the problem type.

detail Detail

Possible values: 5 ≤ length

A string containing a human-readable explanation specific to this occurrence of the problem.

instance Instance

Possible values: 1 ≤ length

A string containing a URI reference that identifies the specific occurrence of the problem.

error_code Error Code

A Number that indicates the error type that occurred.