---
updatedAt: 2026-09-29T23:38:36.000Z
agentTools:
  projectIndex: https://dev.kevel.com/llms.txt
---

# Read User Record

This endpoint returns all data about a specific user record in UserDB.

## Response Parameters

Refer to our [UserDB doc](https://dev.kevel.com/docs/userdb-1) for more information on each of the parameters.

> 📘
>
> You can ignore the following fields: `dirtyCookies`, `cookieMonster`, `siteViewtimes`, and `pendingConversion`.

> 👍
>
> Note that the user key supplied in the `user` object will override a user key set via the `azk` cookie.

# OpenAPI definition

```json
{
  "openapi": "3.1.0",
  "info": {
    "title": "userdb",
    "version": "1.0"
  },
  "servers": [
    {
      "url": "https://e-{networkId}.adzerk.net/udb/{networkId}",
      "variables": {
        "networkId": {
          "default": "networkId"
        }
      }
    }
  ],
  "security": [
    {}
  ],
  "paths": {
    "/read": {
      "get": {
        "summary": "Read User Record",
        "description": "This endpoint returns all data about a specific user record in UserDB.",
        "operationId": "read-a-users-record",
        "parameters": [
          {
            "name": "networkId",
            "in": "path",
            "description": "Your account (network) ID",
            "schema": {
              "type": "integer",
              "format": "int32"
            },
            "required": true
          }
        ],
        "responses": {
          "200": {
            "description": "200",
            "content": {
              "application/json": {
                "examples": {
                  "Result": {
                    "value": "{\n    \"key\": \"ue1-e397eb5990\",\n    \"interests\": [\n        \"news\",\n        \"sports\"\n    ],\n    \"segments\": [\n        79\n    ],\n    \"blockedItems\": {\n        \"advertisers\": [\n            1234,\n            1235\n        ],\n        \"campaigns\": [\n            12345,\n            12346\n        ],\n        \"creatives\": [\n            123456,\n            123457\n        ],\n        \"flights\": [\n            234567,\n            234568\n        ]\n    },\n    \"partnerUserIds\": {\n        \"p1\": [\n            \"0shj0we09hw\"\n        ]\n    },\n    \"retargetingSegments\": {\n        \"b12345\": [\n            2,\n            3,\n            4\n        ]\n    },\n    \"custom\": {\n        \"anything\": \"goes\",\n        \"lookAtMe\": [\n            \"itsAnArray\",\n            42\n        ]\n    },\n    \"consent\": {\n        \"gdpr\": true\n    },\n    \"optOut\": false,\n    \"ip\": \"10.10.10.10\"\n}"
                  }
                },
                "schema": {
                  "type": "object",
                  "properties": {
                    "key": {
                      "type": "string",
                      "example": "ue1-e397eb5990"
                    },
                    "interests": {
                      "type": "array",
                      "items": {
                        "type": "string",
                        "example": "news"
                      }
                    },
                    "segments": {
                      "type": "array",
                      "items": {
                        "type": "integer",
                        "example": 79,
                        "default": 0
                      }
                    },
                    "blockedItems": {
                      "type": "object",
                      "properties": {
                        "advertisers": {
                          "type": "array",
                          "items": {
                            "type": "integer",
                            "example": 1234,
                            "default": 0
                          }
                        },
                        "campaigns": {
                          "type": "array",
                          "items": {
                            "type": "integer",
                            "example": 12345,
                            "default": 0
                          }
                        },
                        "creatives": {
                          "type": "array",
                          "items": {
                            "type": "integer",
                            "example": 123456,
                            "default": 0
                          }
                        },
                        "flights": {
                          "type": "array",
                          "items": {
                            "type": "integer",
                            "example": 234567,
                            "default": 0
                          }
                        }
                      }
                    },
                    "partnerUserIds": {
                      "type": "object",
                      "properties": {
                        "p1": {
                          "type": "array",
                          "items": {
                            "type": "string",
                            "example": "0shj0we09hw"
                          }
                        }
                      }
                    },
                    "retargetingSegments": {
                      "type": "object",
                      "properties": {
                        "b12345": {
                          "type": "array",
                          "items": {
                            "type": "integer",
                            "example": 2,
                            "default": 0
                          }
                        }
                      }
                    },
                    "custom": {
                      "type": "object",
                      "properties": {
                        "anything": {
                          "type": "string",
                          "example": "goes"
                        },
                        "lookAtMe": {
                          "type": "array"
                        }
                      }
                    },
                    "consent": {
                      "type": "object",
                      "properties": {
                        "gdpr": {
                          "type": "boolean",
                          "example": true,
                          "default": true
                        }
                      }
                    },
                    "optOut": {
                      "type": "boolean",
                      "example": false,
                      "default": true
                    },
                    "ip": {
                      "type": "string",
                      "example": "10.10.10.10"
                    }
                  }
                }
              }
            }
          }
        },
        "deprecated": false,
        "security": [],
        "x-readme": {
          "code-samples": [
            {
              "language": "curl",
              "code": "curl -b \"azk=ue1-e397eb5990\" \"https://e-23.adzerk.net/udb/23/read\""
            },
            {
              "language": "javascript",
              "code": "const Adzerk = require('@adzerk/decision-sdk');\n\n// Demo network ID; find your own via the Adzerk UI!\nlet client = new Adzerk.Client({networkId: 23});\nclient.userDb.read(\"ue1-e397eb5990\").then(response => console.log(response));"
            },
            {
              "language": "java",
              "code": "import com.adzerk.sdk.*;\nimport com.adzerk.sdk.generated.ApiException;\nimport com.adzerk.sdk.model.UserRecord;\nimport org.apache.commons.lang3.builder.ToStringBuilder;\n\npublic class FetchUserDb {\n  public static void main(String[] argv) throws ApiException {\n    // Demo network ID; find your own via the Adzerk UI!    \n    Client client = new Client(new ClientOptions(23));\n    UserRecord record = client.userDb().read(\"ue1-e397eb5990\");\n    System.out.println(ToStringBuilder.reflectionToString(record));\n  }  \n}\n"
            },
            {
              "language": "python",
              "code": "import adzerk_decision_sdk\n\n# Demo network ID; find your own via the Adzerk UI!\nclient = adzerk_decision_sdk.Client(23)\nrecord = client.user_db.read(\"ue1-e397eb5990\")\nprint(record)"
            },
            {
              "language": "ruby",
              "code": "require \"adzerk_decision_sdk\"\n\n# Demo network ID; find your own via the Adzerk UI!\nclient = AdzerkDecisionSdk::Client.new(network_id: 23)\npp client.user_db.read(\"ue1-e397eb5990\")"
            },
            {
              "language": "clojure",
              "code": "(ns read-userdb-sample\n  (:use clojure.pprint)\n  (:import (com.adzerk.sdk Client ClientOptions)))\n\n(defn -main []\n  ; Demo network ID; find your own via the Adzerk UI!\n  (let [client (Client. (doto (ClientOptions. (int 23))))]\n    (pprint (bean (-> client (.userDb) (.read \"ue1-e397eb5990\"))))))\n"
            },
            {
              "language": "swift",
              "code": "import AdzerkSDK\n\n// Demo network ID; find your own via the Adzerk UI!\nDecisionSDK.defaultNetworkId = 23\n\nlet keyStore = UserKeyStoreKeychain()\nkeyStore.save(userKey: \"ue1-e397eb5990\")\n\nlet client = DecisionSDK(keyStore: keyStore)\n\nclient.userDB().readUser() {response in\n  dump(response)\n}"
            }
          ],
          "samples-languages": [
            "curl",
            "javascript",
            "java",
            "python",
            "ruby",
            "clojure",
            "swift"
          ]
        }
      }
    }
  },
  "x-readme": {
    "headers": [],
    "explorer-enabled": false,
    "proxy-enabled": true
  },
  "x-readme-fauxas": true
}
```