Communications GET API Documentation

Purpose

This API endpoint retrieves all email communications associated with a specific account. It returns details of each email including sender, recipients, subject, message content, attachments, and metadata such as creation date and status. This endpoint is designed to help users or systems track the full communication history for a particular account, improving transparency and record-keeping in business interactions.

Use Case

This API is used when an organization needs to view or audit email communications related to a specific customer, supplier, or partner account. For instance, a customer support representative can use this endpoint to quickly view all emails sent to or received from a particular account to resolve disputes, verify correspondence, or analyze communication trends. It is also useful in CRM integrations or reporting tools that require detailed communication logs per account.

Path Parameters

Parameter	Type	Description
account_id	string	The unique identifier of the account whose email communications are being retrieved.

Query Parameters

This endpoint does not require query parameters.

Request Body

This endpoint does not accept a request body.

Response

The API returns all email communications associated with the specified account. Each email entry includes information such as sender and recipient addresses, carbon copy (CC) and blind carbon copy (BCC) lists, subject line, body content, and timestamps indicating when the email was created and last updated. It also includes attachment details for each message, such as file name, storage path, size, and MIME type. Additionally, pagination information is provided to support large datasets, allowing clients to navigate through multiple pages of email records efficiently.

Response Body

                JSON
              

                      {
    "account": {
        "communication": {
            "emails": [
                {
                    "uuid": "EMAIL_UUID_1",
                    "message_type": "MESSAGE_TYPE",
                    "status": "STATUS",
                    "from": "SENDER_EMAIL",
                    "to": "RECIPIENT_EMAIL",
                    "cc": [
                        "CC_EMAIL_1",
                        "CC_EMAIL_2"
                    ],
                    "bcc": [
                        "BCC_EMAIL_1",
                        "BCC_EMAIL_2"
                    ],
                    "subject": "EMAIL_SUBJECT",
                    "body": "EMAIL_BODY",
                    "additional_template": "TEMPLATE_NAME",
                    "created_at": "CREATED_AT_TIMESTAMP",
                    "last_updated_at": "LAST_UPDATED_AT_TIMESTAMP",
                    "attachments": [
                        {
                            "name": "FILE_NAME",
                            "path": "FILE_PATH",
                            "size": 0,
                            "type": "FILE_TYPE"
                        }
                    ]
                }
            ],
            "pagination": {
                "records": 0,
                "limit": 0,
                "offset": 0,
                "previous_page": "PREVIOUS_PAGE_URL",
                "next_page": "NEXT_PAGE_URL"
            }
        }
    }
}

                    

Attribute	Type	Description
account	object	Contains account-related communication data.
account.communication	object	Holds all communication records related to the account.
account.communication.emails	array	A list of all email messages related to the account.
account.communication.emails.uuid	string	Unique identifier of the email message.
account.communication.emails.message_type	string	Type of message, example: SENT or RECEIVED.
account.communication.emails.status	string	Status of the email message, example: ACTIVE or ARCHIVED.
account.communication.emails.from	string	The email address of the sender.
account.communication.emails.to	string	The email address of the primary recipient.
account.communication.emails.cc	array	List of email addresses included as carbon copy recipients.
account.communication.emails.bcc	array	List of email addresses included as blind carbon copy recipients.
account.communication.emails.subject	string	Subject line of the email message.
account.communication.emails.body	string	Content or body of the email message.
account.communication.emails.additional_template	string	Name or identifier of any additional email template used.
account.communication.emails.created_at	string	Date and time when the email was created.
account.communication.emails.last_updated_at	string	Date and time when the email record was last updated.
account.communication.emails.attachments	array	List of attachments included in the email.
account.communication.emails.attachments.name	string	Name of the attached file.
account.communication.emails.attachments.path	string	File storage path or directory reference.
account.communication.emails.attachments.size	integer	File size in bytes.
account.communication.emails.attachments.type	string	MIME type of the attached file.
account.communication.pagination	object	Contains metadata about the paginated response.
account.communication.pagination.records	integer	Total number of email records found.
account.communication.pagination.limit	integer	Maximum number of records returned per page.
account.communication.pagination.offset	integer	Starting point for pagination.
account.communication.pagination.previous_page	string	URL to the previous page of results (if applicable).
account.communication.pagination.next_page	string	URL to the next page of results (if applicable).

Purpose

This API endpoint retrieves the details of a specific email communication associated with a given account. It returns the complete metadata of the email, including sender and recipient information, CC and BCC lists, subject, body content, attachments, and timestamps. This endpoint is primarily used to view or audit a single email record within an account’s communication history.

Use Case

This API is used when a user or system needs to view a specific email communication tied to an account, such as during customer service audits, quality assurance reviews, or compliance checks. For example, a support team member can use this endpoint to fetch and display the content and attachments of a particular email to verify what was sent, to whom, and when. It is especially useful for systems that display email logs or generate detailed communication reports for business records.

Path Parameters

Parameter	Type	Description
account_id	string	The unique identifier of the account whose email communication is being retrieved.
email_uuid	string	The unique identifier (UUID) of the specific email record to fetch.

Query Parameters

This endpoint does not require query parameters.

Request Body

This endpoint does not accept a request body.

Response

The API returns detailed information about a specific email message associated with an account. The response includes the sender, recipient, CC, and BCC addresses, as well as metadata such as message type, status, subject, and timestamps for creation and updates. Additionally, any file attachments linked to the email are provided with their file names, storage paths, sizes, and MIME types. This endpoint ensures that users can access a full record of the specific communication, maintaining data transparency and traceability for customer or internal correspondence.

Response Body

                JSON
              

                      {
    "account": {
        "communication": {
            "email": {
                "uuid": "EMAIL_UUID",
                "message_type": "MESSAGE_TYPE",
                "status": "STATUS",
                "from": "SENDER_EMAIL",
                "to": "RECIPIENT_EMAIL",
                "cc": [
                    "CC_EMAIL_1",
                    "CC_EMAIL_2"
                ],
                "bcc": [
                    "BCC_EMAIL_1",
                    "BCC_EMAIL_2"
                ],
                "subject": "EMAIL_SUBJECT",
                "body": "EMAIL_BODY",
                "additional_template": "TEMPLATE_NAME",
                "created_at": "CREATED_AT_TIMESTAMP",
                "last_updated_at": "LAST_UPDATED_AT_TIMESTAMP",
                "attachments": [
                    {
                        "name": "FILE_NAME",
                        "path": "FILE_PATH",
                        "size": 0,
                        "type": "FILE_TYPE"
                    }
                ]
            }
        }
    }
}

                    

Attribute	Type	Description
account	object	Contains account-related communication data.
account.communication	object	Holds all communication records related to the account.
account.communication.email	object	Contains details of the specific email message.
account.communication.email.uuid	string	Unique identifier of the email message.
account.communication.email.message_type	string	Type of message, example: SENT or RECEIVED.
account.communication.email.status	string	Status of the email message, example: ACTIVE or ARCHIVED.
account.communication.email.from	string	The sender’s email address.
account.communication.email.to	string	The primary recipient’s email address.
account.communication.email.cc	array	List of email addresses included as carbon copy recipients.
account.communication.email.bcc	array	List of email addresses included as blind carbon copy recipients.
account.communication.email.subject	string	Subject line of the email message.
account.communication.email.body	string	Main content or body of the email message.
account.communication.email.additional_template	string	Name or identifier of any additional email template used.
account.communication.email.created_at	string	Date and time when the email was created.
account.communication.email.last_updated_at	string	Date and time when the email record was last updated.
account.communication.email.attachments	array	List of attachments included in the email.
account.communication.email.attachments.name	string	Name of the attached file.
account.communication.email.attachments.path	string	File storage path or directory reference.
account.communication.email.attachments.size	integer	File size in bytes.
account.communication.email.attachments.type	string	MIME type of the attached file.

Retrieve Account Email Communications: /accounts/{account_id}/communications/emails

Purpose

Use Case

Path Parameters

Query Parameters

Request Body

Response

Response Body

Retrieve Account Email Communication by UUID: /accounts/{account_id}/communications/emails/{email_uuid}

Purpose

Use Case

Path Parameters

Query Parameters

Request Body

Response

Response Body