Retrieves the communication rule with the specified key.

Request Information

URI Parameters :

NameDescriptionTypeAdditional information
id

The communication rule id.

 globally unique identifier

Required

Body Parameters :

None.

Response Information

Resource Description :

IHttpActionResult containing the communication rule, or 404 Not Found if it doesn't exist.

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": "6734d2a9-0aa4-483a-8acf-6a3acf947851",
  "name": "sample string 2",
  "sales_organization_id": "658dae2d-b6b9-4920-8579-de899b1dfdb3",
  "trigger_code": "sample string 4",
  "enable_for_object_updated_after": "2026-09-16T09:23:50.464848+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": "0516aa5a-53f8-4745-ab56-ecf89a7669d8",
  "pdf_template_id": "8a5a3df8-4c8f-4bf8-b3e4-0cde1a0583e7",
  "enable_filter_job_type": true,
  "enable_filter_contract_type_id": "2617f9bc-1957-45e2-8ef4-74e88fd37264",
  "enable_filter_no_contract_type": true,
  "archived": true,
  "modified_dateutc": "2026-09-16T09:23:50.464848+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>2617f9bc-1957-45e2-8ef4-74e88fd37264</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-09-16T09:23:50.464Z</enable_for_object_updated_after>
  <id>6734d2a9-0aa4-483a-8acf-6a3acf947851</id>
  <modified_dateutc>2026-09-16T09:23:50.464Z</modified_dateutc>
  <name>sample string 2</name>
  <pdf_template_id>8a5a3df8-4c8f-4bf8-b3e4-0cde1a0583e7</pdf_template_id>
  <print_layout_id>0516aa5a-53f8-4745-ab56-ecf89a7669d8</print_layout_id>
  <sales_organization_id>658dae2d-b6b9-4920-8579-de899b1dfdb3</sales_organization_id>
  <sending_type>sample string 11</sending_type>
  <trigger_code>sample string 4</trigger_code>
</communication>