---
title: "Retrieve the payload schema of a log event type"
method: GET
path: "/logs/schemas"
tags: ["Logs"]
---

# Retrieve the payload schema of a log event type

`GET /logs/schemas`

## Request

- Base URL: `https://api.clerk.com/v1`
- URL: `https://api.clerk.com/v1/logs/schemas`
- Auth: HTTP bearer

Returns the payload schema of a log event type: which fields its
payload carries, addressed by the dot-paths that the `payload_filter`
and `payload_fields` parameters of the list endpoint accept.

`type` accepts a concrete event type (`sign_in.completed`), a
trailing-`*` wildcard (`sign_in.*`), or a bare family name (`sign_in`,
normalized to `sign_in.*` when no concrete type matches — the
response's `event_type`
echoes the normalized form). For wildcard lookups the fields are the
intersection across every matching event type, and `matched_event_types`
lists what the intersection was computed over; per-type metadata
(description, severity, docs_group) is present only for concrete types.

The response is the same for every instance.

## Query parameters

- `type` string, required

## Response `200`

The payload schema of a log event type.

- LogSchema: The payload schema of a log event type: the fields its payload carries, addressed by the dot-paths that `payload_filter` and `payload_fields` accept. Field entries use JSON Schema vocabulary (`type` is the data type, `enum` the accepted values); the event type identifier lives in `event_type`.
  - `object` string, required: String representing the object's type. Always "log_schema".
  - `event_type` string, required: The event type this schema describes: a concrete type (`sign_in.completed`) or a trailing-`*` wildcard (`sign_in.*`). A bare family name in the request (`sign_in`) is normalized to its wildcard form here.
  - `description` string: Human-readable description of the event type. Present only for concrete types.
  - `severity` string: Severity of the event type (e.g. `info`, `success`, `warning_external`). Present only for concrete types.
  - `docs_group` string: The documentation group the event type belongs to. Present only for concrete types.
  - `matched_event_types` string[]: The concrete event types a wildcard expanded to. Present only for wildcard lookups, whose `fields` are the intersection across these types.
  - `fields` LogSchemaField[], required
    - `path` string, required: The field's dot-path (nested fields use dots, e.g. `captcha_attempt_payload.provider`) — the exact string `payload_filter` and `payload_fields` accept.
    - `type` 'string' | 'boolean' | 'integer' | 'number', required: The field's data type.
    - `optional` boolean, required: Whether the field is optional in the payload. Note that even non-optional fields can be absent from a stored event when they held their zero value at record time.
    - `enum` string[]: The accepted values, present for enum-backed fields (which have type `string`).

## Other responses

- `401`: Authentication invalid
- `403`: Authorization invalid
- `422`: Invalid request parameters
- `429`: Too many requests

## Changes

- **2026-10-30** `8bdc1f8790c7`: 1 info
  - endpoint added
- **2026-09-23** `4c42713b9fc0`: 1 breaking
  - api path removed without deprecation
- **2026-09-22** `dfe0b940d731`: 1 info
  - endpoint added

[Operation history](https://skmtc.dev/clerk/apis/clerk-backend-api/changes/logs/schemas/get.md)

---

[API](https://skmtc.dev/clerk/apis/clerk-backend-api.md) - [All operations](https://skmtc.dev/clerk/apis/clerk-backend-api/llms.txt) - [OpenAPI document](https://skmtc.dev/clerk/apis/clerk-backend-api/revisions/8bdc1f8790c7?raw)