---
updatedAt: 2026-08-19T12:42:10.000Z
agentTools:
  projectIndex: https://docs.delivr.ai/llms.txt
---

# Get the full event schema

Every field the events API knows about, across all tiers. Non-billable.


# OpenAPI definition

```json
{
  "openapi": "3.0.3",
  "info": {
    "title": "Events & Identity",
    "description": "Query the resolved on-domain events your pixel captures, and resolve identities for the people behind them. Once your pixel is installed (see **Pixel Tracking**), use these endpoints to pull page views, clicks, and other events with the resolved person and company attached, inspect the event schema, resolve hashed emails (HEM), and look up a contact.\n\n**Pick a tier, and you pick the price.** Events are read through four tier routes rather than one endpoint. Each route returns the columns at or below its enrichment tier and bills the matching meter, so the cost of a call is legible from its URL before you make it. Start at `web_event`, which carries no identity resolution and is the cheapest way to establish volume or scope a window, and move up only for the identity fields you actually need.\n\n**Authentication:** organization API key. Send `X-Api-Key` + `X-Api-Secret` on every request. (Legacy JWT bearer auth still works but is deprecated.)\n\n**Base URL:** `https://api.delivr.ai`\n",
    "version": "1.0",
    "contact": {
      "name": "Delivr.ai Support",
      "url": "https://delivr.ai"
    }
  },
  "servers": [
    {
      "url": "https://api.delivr.ai",
      "description": "Production"
    }
  ],
  "security": [
    {
      "ApiKeyAuth": [],
      "ApiSecretAuth": []
    }
  ],
  "tags": [
    {
      "name": "Events",
      "description": "Query on-domain pixel events through the tier routes, with filtering, pagination and projection. The route sets both the billable meter and the fields it can return."
    }
  ],
  "paths": {
    "/api/v3/events_schema": {
      "get": {
        "tags": [
          "Events"
        ],
        "summary": "Get the full event schema",
        "operationId": "getEventSchema",
        "description": "Every field the events API knows about, across all tiers. Non-billable.\n",
        "responses": {
          "200": {
            "description": "The full event schema.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/SchemaResponse"
                }
              }
            }
          },
          "401": {
            "description": "Missing or invalid API key."
          }
        }
      }
    }
  },
  "components": {
    "securitySchemes": {
      "ApiKeyAuth": {
        "type": "apiKey",
        "in": "header",
        "name": "X-Api-Key",
        "description": "Organization API key (`dlvr_` prefixed), created in the dashboard at `https://app.delivr.ai/{org_id}/settings/api-keys`. Must be paired with the `X-Api-Secret` header."
      },
      "ApiSecretAuth": {
        "type": "apiKey",
        "in": "header",
        "name": "X-Api-Secret",
        "description": "Secret half of the organization API key, paired with `X-Api-Key`. Both headers are required on every request."
      }
    },
    "schemas": {
      "SchemaResponse": {
        "type": "object",
        "required": [
          "fields"
        ],
        "properties": {
          "fields": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/SchemaFieldDescriptor"
            },
            "description": "Column descriptors that make up the event schema."
          }
        }
      },
      "SchemaFieldDescriptor": {
        "type": "object",
        "required": [
          "name",
          "data_type",
          "nullable"
        ],
        "properties": {
          "name": {
            "type": "string",
            "description": "Column name."
          },
          "data_type": {
            "type": "string",
            "description": "Logical data type (e.g., Utf8, Int64, List<Utf8>)."
          },
          "nullable": {
            "type": "boolean",
            "description": "Whether the column allows NULL values."
          }
        }
      }
    }
  }
}
```