---
id: inbox-rule-source-list
title: List inbox rule sources
description: >-
  Lists the source names an inbox rule can use, with the statuses and the fields
  each one exposes to templates and conditions.
sidebar_label: List inbox rule sources
hide_title: true
hide_table_of_contents: true
api: >-
  eJztWGtv3LYS/SsDfnGLK8u+FwmKq29G69y4SOrA3jQFXMM7K81arClSHVK73rvY/14MqX1o49hu0UcK1F+sB8U5MzxzZnaWKuCtV8WVOrMTdw/cGfLqOlMV+ZJ1G7SzqlBvtA8eQk3gXcclgcWGPKAFvfkMSrTQecpgrkOdFgcMnY8Lq/hgqslUHgjLGpwloPvWyfvgIFDTGgz94tLZSotxn/9oVaZcS4xyf1apQkWjh2L0MOEpjPZBZcpT2bEOC1VcLdWEkIlPulCr4up6dZ0pJt8668mrYqn+c3ws/4aOjjYufsK7XGWqdDaQDfI1tq3RZUR29JOXLZbKlzU1KFdh0ZIqlJv8RKXAa1n8CDoBYPKdCX5nITLjQmVKB2rScx2MvLiMkFT2xI5kQ3R+s6EPrO2t2j/O0fAgJfydJ9AWMDp74GGc3o/FX7rHpo04KmqNWzTi/CpTd9pWTxt77eZgO2PkdKeOG2AqSc9ol08HHmhGNvihOewqHS2tifRorAYoVvswTmfEi56R0XIKVjzXifg+MH2lSiYMyR/urE1XU23R6P9TJdeoTbxgZwxVNxMs71SmOntn3dyq64jA6BkxVTe/gwOjQUJtSTnVTOB+H/gCOuXoA0A/htOn86dSN8Jjwip/wM1PUFj4+DwCR+ORv0PSpBhJ/NIeD6V4/PbAw7eX59+BLMvAMSCIjICbxkeRi87S+TSqyf7pPPscRXh20fVPt3+ZevHDDw/jZPq5Ix+gdJ2p7EEQprbsSvKeqhxeOYZ+6wwQWmRsKBCD9qDtDI2ussh1pj7dK0de9qF77UN0euE6qJw8q3FG0BI32nvtbA6CYOKqhWyHYndiqIGKAmrjIR0gfHHx6mv474uXX335iDT23/7raYkcxuCbeDchD/MaA8zJBpizs7cZTJ0xbq7tbXRwDeIjlKI4GASaxFIzVZId0WrWy+taXqTsDcm4JtDjZDyB9xdnEASgrkRVproXNxFIoVMPKoezcJDqynodZ2BdiMyzd1nMHy1rojSKNFOUraBFpWvtN/65sux4Ty47tsWu0hbE7Lhg1wXyhzWZlrjoeXEYyZLSJBWZp930teOQQd01aA8lr3FiCHzXNMiLmDY1bXwdIBvVxATItKbllqsenO05Grm+lfsdSNoGuiV+UAdej0bv1rpeuorWQNbFfoDkxfHxSlhaPc/hIB5m0GBZa0tbn2Ngo7Uc3kvlDFJDa7SVBKSlUk91mVZJJkqSMUQnUhezd3AX5+9Hp5c3r0/fvDu9yM+++/7kzdk3N+9OLk7eXqZCIGR+CLEctyBSReCO9j1462LEUw5oZwEnrgv7uSQAI7f6E8hgXpMFnKGOew+wisFVppJrTxaJcxvrLC9EVzZnn5Tb8ZYEOZxbs4CWyQssZyGuTKCTrV9RQ+L+zysisf3pCfMIvGFXshW2G13J+Wj7tLUPMQU2TTDM0YM4W8BYNHacwfjnjlguHMM4pecYvmgx1DvZ8uUQS/wkQvC+ewanP9Qo8pLOfdOnR0QZ+K6sAT2M11I5jlD6uOy1gv1TsT1D032i0MZXSRvXDvf0YjI0QxuGu1oXDvHQds2EWLZuyHu8fVay7skS3bcGbWLQ+oAlRrlKNffRnVumEoPUiofS6lJIkzyTaEX9HGdwR22QegPSSs2RpRVqWgx6oo0Oi6QU/eoYWNGPMWjrQ98j/WbBDIwlnT2D8ye7tSeCfTTz4cyWpquiwMVX0i1IjccyDJt637Wt45CrdU/z8qGe5tI1FGop2jvy4+xgqwMPXouw/tN+/L3aj1hciolBe/cntRXnrvV5Lu+Zor7En+yB2KJJZeOP7SZefjbdxGfZJHzeEvs88nx2yhrjGmonc7Bbis0PyoRLHZWuaTrba54/irOrGxkTHPn1+MgTz0j6tqul6tioQtUhtL44OsJW57tm89I1Sn66rkdql6KZSZd2B2ubsMhGYiEuU0W/SGX9xatIL1Wobz+M1Cr2TFMnnwueFMF/58f58UYWC/X1wJ+PAv4WLd5S37ltZpdJCCsqdUWJwyzTRuqHji2xd/bA95/oYelJCujJViKLknXJNkzZNSnt3Hx3Kpgyr3U+NGi344s4L90dHvYjxX0fltuC9dePWPtzDHQfjlqD2oprkSTLnmJXqtw/ki3J5OwTza4zVTsfZP1yOUFP79msVvI4davF1bX0jKyTJl3J0KkmrIgjL+9oIelUltQKu/vm8uNJq5Bzkwn/Ox2pTOGQknsU3B3joF3s7L1cphUjd0d2tVJZDyLIvVpdr1arXwB6yB5j
sidebar_class_name: get api-method
info_path: docs/api/communications
custom_edit_url: null
canonical: 'https://docs.nullplatform.com/docs/api/inbox-rule-source-list'
---
<Heading
  as={"h1"}
  className={"openapi__heading"}
  children={"List inbox rule sources"}
>
</Heading>

<MethodEndpoint
  method={"get"}
  path={"/communications/inbox_rule/source"}
  context={"endpoint"}
>

</MethodEndpoint>

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

<ParamsDetails
  parameters={undefined}
>

</ParamsDetails>

<RequestSchema
  title={"Body"}
  body={undefined}
>

</RequestSchema>

<StatusCodes
  id={undefined}
  label={undefined}
  responses={{"200":{"description":"The sources an inbox rule can use.","content":{"application/json":{"schema":{"type":"object","properties":{"results":{"type":"array","items":{"title":"Source","type":"object","properties":{"entity":{"type":"string","description":"The source name to use in a rule's `source`.","example":"deployment"},"kind":{"type":"string","description":"How nullplatform receives the source's events.","example":"audit"},"statuses":{"type":"array","items":{"type":"string"},"description":"Every status the entity can be in.","example":["creating","running","finalized","failed","rolled_back","unknown"]},"delivered_statuses":{"type":"array","items":{"type":"string"},"description":"The statuses a rule can fire on.","example":["creating","running","finalized","failed","rolled_back"]},"fields":{"type":"array","description":"The fields templates and conditions can read.","items":{"type":"object","properties":{"name":{"type":"string","description":"The field name.","example":"status"},"type":{"description":"The field's JSON type, or a list of types.","oneOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}],"example":"string"}}}}}}}}}}}},"4XX":{"description":"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).","content":{"application/problem+json":{"schema":{"type":"object","description":"Describes what went wrong, following the RFC 9457 problem details format.","required":["type","title","status"],"properties":{"type":{"type":"string","description":"A URI that identifies the kind of problem. It's an identifier, not a link, and it's the same every time this problem occurs.","example":"urn:nullplatform:error:routes-helper:invalid-params"},"title":{"type":"string","description":"A short, human-readable summary of the problem.","example":"There are invalid parameters on the request"},"status":{"type":"integer","description":"The HTTP status code of the response.","example":400},"code":{"type":"string","description":"A stable, machine-readable error code. Use it to handle specific errors in your integrations.","example":"ROUTES_HELPER.INVALID_PARAMS"},"detail":{"type":"string","nullable":true,"description":"More information about what went wrong in this request, when available.","example":null},"errors":{"type":"array","description":"One entry per invalid field or parameter. Only present on validation errors.","items":{"type":"object","properties":{"field":{"type":"string","description":"The name of the invalid field or parameter.","example":"application_id"},"in":{"type":"string","description":"Where the field was sent: `body`, `query`, or `params` (path parameters).","example":"query"},"issue":{"type":"string","description":"What's wrong with the field, such as `required` or `invalid`.","example":"invalid"},"value":{"description":"The value that was sent, when relevant.","example":"not-a-number"},"message":{"type":"string","description":"A human-readable explanation of the issue."}}}},"message":{"type":"string","deprecated":true,"description":"Same value as `title`, kept for backward compatibility. Use `title` or `code` instead.","example":"There are invalid parameters on the request"},"traceId":{"type":"string","description":"An identifier for this request, when available. Include it when you contact nullplatform support."}}}}}},"5XX":{"description":"Something went wrong on nullplatform's side. The body is a problem details object (RFC 9457).","content":{"application/problem+json":{"schema":{"type":"object","description":"Describes what went wrong, following the RFC 9457 problem details format.","required":["type","title","status"],"properties":{"type":{"type":"string","description":"A URI that identifies the kind of problem. It's an identifier, not a link, and it's the same every time this problem occurs.","example":"about:blank"},"title":{"type":"string","description":"A short, human-readable summary of the problem.","example":"Oops.. there was an internal error"},"status":{"type":"integer","description":"The HTTP status code of the response.","example":500},"code":{"type":"string","description":"A stable, machine-readable error code. Use it to handle specific errors in your integrations."},"detail":{"type":"string","nullable":true,"description":"More information about what went wrong in this request, when available.","example":null},"message":{"type":"string","deprecated":true,"description":"Same value as `title`, kept for backward compatibility. Use `title` or `code` instead.","example":"Oops.. there was an internal error"},"traceId":{"type":"string","description":"An identifier for this request, when available. Include it when you contact nullplatform support."}}}}}}}}
>

</StatusCodes>