Skip to main content

Get record

GET 
/v2/key-value-stores/:storeId/records/:recordKey

Gets 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.

Please note that for security reasons, Apify API can perform small modifications to HTML documents before they are served via this endpoint. To fetch the raw HTML content without any modifications, use the attachment query parameter.

Request

Path Parameters

    storeId string required

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


    Example: WkzbQMuFYuamGv3YF
    recordKey string required

    Key of the record.


    Example: someKey

Query Parameters

    signature string

    Signature used to access the record.


    Example: 2wTI46Bg8qWQrV7tavlPI
    attachment boolean

    If true or 1, the response will be served with Content-Disposition: attachment header, causing web browsers to offer downloading HTML records instead of displaying them.


    Example: true

Status 200

Response Headers
    {
      "foo": "bar"
    }