Retrieves all communication rules, optionally filtered via OData query options.

Request Information

URI Parameters :

None.

Body Parameters :

None.

Response Information

Resource Description :

IHttpActionResult containing the list of communication rules.

communication
NameDescriptionTypeAdditional information
id

Primary Key

 globally unique identifier
name

Name of this communication rule.

 string
sales_organization_id

Foreign key of the sales organization this communication rule belongs to.

 globally unique identifier
trigger_code

Fixed value identifying the system event that triggers this communication (e.g. "JobApproval").

 string
enable_for_object_updated_after

Only trigger for objects updated after this date/time (used to avoid notifying for stale events).

 date
email_subject

Template for the email subject, supporting placeholders resolved at send time.

 string
email_body

Template for the email body, supporting placeholders resolved at send time.

 string
email_to

Template for the "To" recipient(s), supporting placeholders resolved at send time.

 string
email_cc

Template for the "Cc" recipient(s), supporting placeholders resolved at send time.

 string
email_bcc

Template for the "Bcc" recipient(s), supporting placeholders resolved at send time.

 string
sending_type

Determines how/when this communication is sent (e.g. immediately, batched).

 string
print_layout_id

Foreign key of the print layout used to render the email/attachment.

 globally unique identifier
pdf_template_id

Foreign key of the PDF template attached to this communication.

 globally unique identifier
enable_filter_job_type

Indicates this communication rule is filtered to specific job types.

 boolean
enable_filter_contract_type_id

Foreign key of the contract type this communication rule is filtered to, when applicable.

 globally unique identifier
enable_filter_no_contract_type

Indicates this communication rule only applies when there is no contract type.

 boolean
archived

Indicates whether this communication rule has been archived (no longer active).

 boolean
modified_dateutc

Readonly system field managed by database, filled with GetUtcDate when adding,updating

 date

Response Formats

application/json, text/json

Sample: 
{
  "id": "4396e29b-a133-4f00-96b7-c4a3e2ab0863",
  "name": "sample string 2",
  "sales_organization_id": "8381fe9f-0797-453b-824f-02a59cb6d4c6",
  "trigger_code": "sample string 4",
  "enable_for_object_updated_after": "2026-11-12T14:27:29.5090236+00:00",
  "email_subject": "sample string 6",
  "email_body": "sample string 7",
  "email_to": "sample string 8",
  "email_cc": "sample string 9",
  "email_bcc": "sample string 10",
  "sending_type": "sample string 11",
  "print_layout_id": "a6d56f0d-3300-4754-9799-f9b14c8e6435",
  "pdf_template_id": "37fb1ef5-b82b-46b2-a9f5-6db2ed1e152d",
  "enable_filter_job_type": true,
  "enable_filter_contract_type_id": "d445e29e-b747-4343-9e02-a388d09ffde6",
  "enable_filter_no_contract_type": true,
  "archived": true,
  "modified_dateutc": "2026-11-12T14:27:29.5090236+00:00"
}

application/xml, text/xml

Sample: 
<communication xmlns:i="http://www.w3.org/2001/XMLSchema-instance">
  <archived>true</archived>
  <email_bcc>sample string 10</email_bcc>
  <email_body>sample string 7</email_body>
  <email_cc>sample string 9</email_cc>
  <email_subject>sample string 6</email_subject>
  <email_to>sample string 8</email_to>
  <enable_filter_contract_type_id>d445e29e-b747-4343-9e02-a388d09ffde6</enable_filter_contract_type_id>
  <enable_filter_job_type>true</enable_filter_job_type>
  <enable_filter_no_contract_type>true</enable_filter_no_contract_type>
  <enable_for_object_updated_after>2026-11-12T14:27:29.509Z</enable_for_object_updated_after>
  <id>4396e29b-a133-4f00-96b7-c4a3e2ab0863</id>
  <modified_dateutc>2026-11-12T14:27:29.509Z</modified_dateutc>
  <name>sample string 2</name>
  <pdf_template_id>37fb1ef5-b82b-46b2-a9f5-6db2ed1e152d</pdf_template_id>
  <print_layout_id>a6d56f0d-3300-4754-9799-f9b14c8e6435</print_layout_id>
  <sales_organization_id>8381fe9f-0797-453b-824f-02a59cb6d4c6</sales_organization_id>
  <sending_type>sample string 11</sending_type>
  <trigger_code>sample string 4</trigger_code>
</communication>