Skip to main content
GET
/
v3
/
orgs
/
{org_id}
/
customers
/
interactions
/
{customer_interaction_id}
cURL
curl --request GET \
  --url https://api.ctrl-hub.com/v3/orgs/{org_id}/customers/interactions/{customer_interaction_id} \
  --header 'X-Session-Token: <api-key>'
{
  "data": {
    "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "type": "<string>",
    "attributes": {
      "method": "email",
      "direction": "inbound",
      "date_time": "2023-11-07T05:31:56Z",
      "contacted": true,
      "status": "scheduled",
      "notes": "<string>"
    },
    "meta": {
      "created_at": "2023-11-07T05:31:56Z",
      "updated_at": "2023-11-07T05:31:56Z",
      "modified_at": "2023-11-07T05:31:56Z"
    },
    "relationships": {
      "author": {
        "data": {
          "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
          "type": "<string>"
        }
      },
      "organisation": {
        "data": {
          "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
          "type": "<string>"
        }
      },
      "representative": {
        "data": {
          "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
          "type": "<string>"
        }
      },
      "account": {
        "data": {
          "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
          "type": "<string>"
        }
      },
      "contact": {
        "data": {
          "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
          "type": "<string>"
        }
      },
      "property": {
        "data": {
          "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
          "type": "<string>"
        }
      }
    }
  },
  "jsonapi": {
    "version": "<string>"
  }
}

Authorizations

X-Session-Token
string
header
required

Session token for authentication.

Path Parameters

org_id
string<uuid>
required

The unique identifier for the organisation.

customer_interaction_id
string<uuid>
required

The unique identifier for the customer interaction.

Query Parameters

include
enum<string>[]

A comma separated list of related resources to include.

Available options:
account,
author,
contact,
organisation,
property,
representative

Response

Get a customer interaction.

JSON API response object

data
object
required

A customer interaction

jsonapi
object
required