---
title: "List inbox rule sources"
method: GET
path: "/communications/inbox_rule/source"
tags: ["Inbox rules"]
---

# List inbox rule sources

`GET /communications/inbox_rule/source`

## Request

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

Lists the source names an inbox rule can use, with the statuses and the fields each one exposes to templates and conditions.

## Response `200`

The sources an inbox rule can use.

- object
  - `results` Source[]
    - `entity` string: The source name to use in a rule's `source`.
    - `kind` string: How nullplatform receives the source's events.
    - `statuses` string[]: Every status the entity can be in.
    - `delivered_statuses` string[]: The statuses a rule can fire on.
    - `fields` object[]: The fields templates and conditions can read.
      - `name` string: The field name.
      - `type` union: The field's JSON type, or a list of types.
        - string
        - string[]

## 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/source/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)