GET

/Communication

When to Use

Retrieve communication records by communicationID or externalCommunicationId
Verify email addresses before sending distribution notifications
Access communication details for cross-entity relationship management
Look up communication information independently of BizEntity operations

Prerequisites

CommunicationID or ExternalCommunicationId to identify the communication

Considerations

Returns complete communication data with entity ownership details
CommunicationID provides faster lookup than ExternalCommunicationId
Each communication belongs to exactly one entity (BizEntity, Person, or Organisation)

Description

Retrieves a specific communication record from the 7G platform using either communicationID or externalCommunicationId. Returns the complete communication data including type, contact value, and entity ownership.

Advanced Resource: Communication records are typically created and managed through BizEntity operations, but can be accessed independently via this endpoint for verification, cross-entity lookups, or notification purposes.

Required Headers - See Authentication

Header	Value	Description
Authorization	{accessToken}	Bearer token for API access
Version	2.0	API version identifier

Query Parameters

Parameter	Type	Required	Description
`CommunicationID` >	integer	> Conditional...	The unique system identifier for the communication record. Provide this to retrieve a specific communication by its internal ID.
`ExternalCommunicationId` >	string	> Conditional...	The external system identifier for the communication record. Use this when integrating with external systems that maintain their own ID references.

CommunicationID

integer

> Conditional...

The unique system identifier for the communication record. Provide this to retrieve a specific communication by its internal ID.

ExternalCommunicationId

string

> Conditional...

The external system identifier for the communication record. Use this when integrating with external systems that maintain their own ID references.

Example Requests

bash

# Get a communication record by internal ID
curl -X GET https://api.7g.com.au/Communication?CommunicationID=12345 \
  -H "Authorization: {accessToken}" \
  -H "Version: 2.0"

# Get a communication record by external ID
curl -X GET "https://api.7g.com.au/Communication?ExternalCommunicationId=EXT-COMM-001" \
  -H "Authorization: {accessToken}" \
  -H "Version: 2.0"

Response Examples

json

{
  "result": true,
  "message": null,
  "recordCount": 1,
  "data": {
    "communicationID": 12345,
    "externalCommunicationId": "EXT-COMM-001",
    "communicationTypeID": 1,
    "name": "john.smith@example.com",
    "bizEntityID": 789,
    "externalBizEntityId": "EXT-BIZ-456",
    "personID": null,
    "externalPersonId": null,
    "organisationID": null,
    "externalOrganisationId": null
  }
}