---
title: "Read the inbox rule schema"
method: GET
path: "/communications/inbox_rule/schema"
tags: ["Inbox rules"]
---

# Read the inbox rule schema

`GET /communications/inbox_rule/schema`

## Request

- Base URL: `https://api.nullplatform.com`
- URL: `https://api.nullplatform.com/communications/inbox_rule/schema`
- Auth: HTTP bearer

Returns the JSON Schema of an inbox rule definition, with every field documented. Use it to validate definitions or to power completion in your editor.

## Response `200`

The JSON Schema of an inbox rule definition.

- object
  - `schema` object: A JSON Schema document describing every field of an inbox rule definition.

## Other responses

- `4XX`: The request couldn't be processed. For example, a parameter is invalid, the resource doesn't exist, or you don't have permission. The body is a problem details object (RFC 9457).
- `5XX`: Something went wrong on nullplatform's side. The body is a problem details object (RFC 9457).

## Changes

- **2026-10-22** `3d300f7f8452`: 1 info
  - endpoint added

[Operation history](https://skmtc.dev/nullplatform/apis/nullplatform-api/changes/communications/inbox_rule/schema/get.md)

---

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