Get record

GET 
https://api.apify.com/v2/key-value-stores/:storeId/records/:recordKey

ClientsGets a value stored in the key-value store under a specific key.

The response body has the same Content-Encoding header as it was set in Put record.

If the request does not define the Accept-Encoding HTTP header with the right encoding, the record will be decompressed.

Most HTTP clients support decompression by default. After using the HTTP client with decompression support, the Accept-Encoding header is set by the client and body is decompressed automatically.

Request

Path Parameters

storeId stringrequired

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

recordKey stringrequired

Key of the record.

Responses

200

Response Headers

application/json

Schema

Schema

foostringrequired

Example (auto)

{
  "foo": "bar"
}

Example

{
  "foo": "bar"
}

302

Response Headers

Location

Authorization: token

name: tokentype: apiKeyin: querydescription: API authentication token. It is required only when using the `username~store-name` format for `storeId`.

• CLI
• JavaScript
• Python
• PHP
• Java
• C
• C#
• Go
• Rust
• Node.js
• Ruby
• PowerShell
• Dart
• Objective-C
• OCaml
• R
• Swift
• Kotlin

• Apify CLI

apify key-value-stores get-value <STORE ID> INPUT

• CURL

curl -L 'https://api.apify.com/v2/key-value-stores/:storeId/records/:recordKey' \
-H 'Accept: application/json'

Request Collapse all

Base URL

https://api.apify.com

Auth

Security Scheme

apiKeyStoreIdhttpBearerStoreId

apiKeyStoreId

Parameters

storeId — pathrequired

recordKey — pathrequired

ResponseClear

Click the Send API Request button above and see the response here!