Skip to main content

Get list of keys

GET 
/v2/key-value-stores/:storeId/keys

Returns a list of objects describing keys of a given key-value store, as well as some information about the values (e.g. size).

This endpoint is paginated using exclusiveStartKey and limit parameters

Request

Path Parameters

    storeId string required

    Key-value store ID or username~store-name.


    Example: WkzbQMuFYuamGv3YF

Query Parameters

    exclusiveStartKey string

    All keys up to this one (including) are skipped from the result.


    Example: Ihnsp8YrvJ8102Kj
    limit double

    Number of keys to be returned. Maximum value is 1000.


    Example: 100
    collection string

    Limit the results to keys that belong to a specific collection from the key-value store schema. The key-value store need to have a schema defined for this parameter to work.


    Example: postImages
    prefix string

    Limit the results to keys that start with a specific prefix.


    Example: post-images-
    signature string

    Signature used to access the keys.


    Example: 2wTI46Bg8qWQrV7tavlPI

Status 200

Response Headers
    {
      "data": {
        "items": [
          {
            "key": "second-key",
            "size": 36,
            "recordPublicUrl": "https://api.apify.com/v2/key-value-stores/WkzbQMuFYuamGv3YF/records/second-key?signature=abc123"
          },
          {
            "key": "third-key",
            "size": 128,
            "recordPublicUrl": "https://api.apify.com/v2/key-value-stores/WkzbQMuFYuamGv3YF/records/third-key?signature=abc123"
          }
        ],
        "count": 2,
        "limit": 2,
        "exclusiveStartKey": "some-key",
        "isTruncated": true,
        "nextExclusiveStartKey": "third-key"
      }
    }