---
id: inbox-rule-schema
title: Read the inbox rule schema
description: >-
  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.
sidebar_label: Read the inbox rule schema
hide_title: true
hide_table_of_contents: true
api: >-
  eJztWG1v2zYQ/isHbkBaTLGzoUUxfQvadE3RNkVe1gJZENPi2WIjkerxFMcw/N+HI2XHSrIkwLAhA9YvTiXy7rm7h8+duFCsp0Hlp2rfjf0VUFthUGeZMhgKsg1b71SuDpFbcgG4RHh/dPAJjooSaw1+AtqBXW8FgxPrrOzKYGa5BLxEmsPEYmXA+KKt0TGaAZwEBMvAHi51ZY3mzb0BPMmrxs+QoPB1U6E8B+tg7lsCNJY9Df5wKlO+QdLydt+oXEUs24IlDxGjylTAoiXLc5WfLtQYNSHttlyq/PRseZYpwtB4FzCofKF+2dmRn374x48Pe6AyVXjH6Fjs6KapbBHhDb8FMbZQHa58oXjeoMqVH3/DglWmGpJg2CYof72uj263h22VZEiLxtZNe0V4ADteacm2eP1xBUCVzE0+jAFsp4cDT9OhIT3h7Z1Xw/TsB5XdQkr4vbWERhhmjdTCt1SgJEkzTj3NY30uMdYnU7o1Fl2B6myZ/mXqxdevd1dEbGNgKHxbGbfFMEZoyBcYgjDsrSfooslAQ6NJ18hIYANYF1mXRUITJlBgPAaxg1c2cCYcnPsWjJdnpb5EaJBqG4KkCgTB2Ju5mNPid1xhDQZZ2ypASgA8O3z7Gn598fLV83t40e396WF+9HPwJhUYA8xKzTCTos/Iu2kGE19VfiallwBXIG6hnHiqNQ9u1Cl6zRRbruQ3sOY2akKfngncGmRgsm56BzlPDveBBaA16NhOLCYdubAusrEDNYB93gqRm6t1lIHzDBoq6y4y0M6AlTWyO+gaO16zrRG4tGEdny+KlkKPzqoll7u2qppKs8SdI5GnnHzLGLZLrBqkvOPFdiRLUMtVFh4RZig9cQZlW2u3TaiNHlcIoa1rTXOJU1CvYu0hOy6REDThipbXXA3gXcfRyHVB1NXjGpJ1jFOkW5iEoe+Ojz9D2gGFN7gCstK8HpIXOztLYal5XMAsEWZQ66K0Dq9jjomN3jZlvtTOSEIaLOzEFmlVWCt6DCLp+I3CHR6cHO8dnb/b+/B573Cw/+n33Q/7b84/7x7ufjySfCQy34VYyi2IVM7U4s0IPvqY8XQGpLnosW/55lkSgJFbXQUymJXoQF9qG233sIrDZaZSaBuINJGe30rhgUNAxzQXXVnXvlNpuibBAA5cNYeGMAgs71YtU0AnX4LCMtbh4a4S7T9cXyGPkzPWEeYeeL1qbQjbuTVSH+se9vYlHgHxk+zPdAAJNoeRaOwog9H3Fkn+8ASjdDxH8KzRXG6clud9LHFLhBBC+whOfym1yEuqe5xe1ogyCG1Rgg4wWknlKELp8jLqe+6eiu9LXSXft/MbXyVtXAXc0YuwwkvtuG/Ved7W266tx0hiusYQ9PRRh/WGLOFVU2mXGLQqsORooFLPvddyQyjN29x9rI6ENCkyyVbUz1EGF9iw9BsY6+JipsnEsU6zHdvK8jwpRbc6Jlb0YwTWBUZt/pZgMukC9x/B+d3N3hPB3nvyYd8VVWuiwMVXMi1Ij9cFw2argdA2jSdO2ZX8vrxrpjnyNXIpTXtDfrzrmdoKEKwI6//jx39r/IjNJR9X2l38S2PFgW/CYCDvCaO+xLGfkZyuUtv4Z6eJl09mmniSQ8LTltjHkefJKWvMK5debgKmGIcfLR/6alj4um5dp3lhGL9/z+X7d7hxTUCXKHPb6UK1VHXfvSEfDnVjB5tuB4WvlVwdrG4W4rd30qXN+4V1WsSQeIjLVN4tUln3x9tIL5Wr91+O1TLOTBMv2wVPyuDPg53BzloWc/W6F8+thH/UTk+xm9zWFztJCA0W1mDiMKEuSgwgPzKGBu+2QrfF9ltPUsCAzogsyqlLvmFCvk7Hzs82bxbSyWt84FrHziLzZLxM0uYGMlgXoRfG4rpnPekrqK7KjFc8bCptnQQeKbToCHiqipsFu6bgihlaulzpA8v6xWKsA55QtVzK4zTL5qdnMlGSTYp1erbMVInaIEXWXuBcDltRYCPc70bP25dQQt31Oflt7zhevPQIe4Og0frqY8bNN2wvFmnFsb9At1yqrAPB8n+1lGucPwFtJSf0
sidebar_class_name: get api-method
info_path: docs/api/communications
custom_edit_url: null
canonical: 'https://docs.nullplatform.com/docs/api/inbox-rule-schema'
---
<Heading
  as={"h1"}
  className={"openapi__heading"}
  children={"Read the inbox rule schema"}
>
</Heading>

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

</MethodEndpoint>

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.

<ParamsDetails
  parameters={undefined}
>

</ParamsDetails>

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

</RequestSchema>

<StatusCodes
  id={undefined}
  label={undefined}
  responses={{"200":{"description":"The JSON Schema of an inbox rule definition.","content":{"application/json":{"schema":{"type":"object","properties":{"schema":{"type":"object","description":"A JSON Schema document describing every field of an inbox rule definition.","example":{"$schema":"http://json-schema.org/draft-07/schema#","type":"object","required":["id","source","category","severity","audience"]}}}}}}},"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>