GET

/communication

Usage Notes

When

Retrieve communication by communicationID or externalCommunicationId
Verify contact details before notifications or correspondence
Access communication data for cross-entity queries

Requirements

CommunicationID or ExternalCommunicationId to identify the record

Notes

Returns complete communication data with entity ownership details
CommunicationID provides faster lookup than ExternalCommunicationId
Each communication links to exactly one entity type

Description

Retrieves a communication record with contact type, value, and entity association. Supports lookup by native communicationID or externalCommunicationId.

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 CommunicationID (recommended)
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": 2,
    "name": "john.smith@example.com",
    "bizEntityID": 789,
    "externalBizEntityId": "EXT-BIZ-456",
    "personID": null,
    "externalPersonId": null,
    "organisationID": null,
    "externalOrganisationId": null
  }
}