Get engagement | AskElephant

curl -G https://app.askelephant.ai/api/v2/engagements/engagement_id \
     -H "Authorization: Bearer <token>" \
     -H "Content-Type: application/json" \
     --data-urlencode expand=companies,contacts,owner,action_items,signals,transcript,media_url,tags

{
  "object": "engagement",
  "id": "ngmt_9X7F3K2LQ8",
  "title": "Q1 Sales Strategy Meeting",
  "engagement_type": "MEETING",
  "processing_status": "COMPLETED",
  "created_at": "2024-01-10T14:00:00Z",
  "updated_at": "2024-01-15T11:00:00Z",
  "description": "Discussing sales targets and strategies for Q1 2024.",
  "data_source": "Zoom",
  "is_internal": false,
  "engagement_at": "2024-01-15T09:30:00Z",
  "start_at": "2024-01-15T09:30:00Z",
  "end_at": "2024-01-15T10:15:00Z",
  "duration_seconds": 2700,
  "meeting_url": "https://zoom.us/j/1234567890",
  "owner_user_id": "usr_4B7D9F2KLM",
  "host_user_id": "usr_8J3K1L9MNO",
  "transcript": "Welcome everyone to the Q1 sales strategy meeting. Today we will cover the new targets and initiatives...",
  "media_url": "https://storage.askelephant.ai/media/ngmt_9X7F3K2LQ8/recording.mp4?signature=abc123&expires=1700000000",
  "companies": [
    {
      "object": "engagement_company",
      "id": "cmp_7G5H2J9KLM",
      "name": "Acme Corporation",
      "domains": [
        "acme.com",
        "acmecorp.com"
      ],
      "crm_association": {
        "object_type": "Account",
        "crm_object_id": "0015g00000XyzAbc",
        "source": "Salesforce"
      }
    }
  ],
  "contacts": [
    {
      "object": "contact",
      "id": "cnt_01HQY3JMS2QAXJGX6X7CH7CM6X",
      "created_at": "2023-11-01T12:00:00Z",
      "updated_at": "2024-01-10T08:45:00Z",
      "first_name": "Ada",
      "last_name": "Lovelace",
      "description": "Primary customer contact for analytical projects.",
      "company": {
        "id": "cmp_7G5H2J9KLM",
        "object": "engagement_company"
      },
      "emails": [
        {
          "email": "ada.lovelace@acme.com",
          "is_primary": true
        }
      ],
      "phone_numbers": [
        {
          "phone_number": "+1-555-0100",
          "is_primary": true
        }
      ],
      "crm_association": {
        "object_type": "Contact",
        "crm_object_id": "0035g00000XyzAda",
        "source": "Salesforce"
      },
      "time_zone": "America/Los_Angeles"
    }
  ],
  "owner": {
    "object": "user",
    "id": "usr_4B7D9F2KLM",
    "role": "OWNER",
    "created_at": "2022-05-20T10:00:00Z",
    "updated_at": "2024-01-14T16:30:00Z",
    "first_name": "John",
    "last_name": "Doe",
    "job_title": "Sales Manager",
    "emails": [
      {
        "email": "john.doe@acme.com",
        "is_primary": true
      }
    ],
    "time_zone": "America/New_York",
    "last_activity_at": "2024-01-15T09:00:00Z"
  },
  "action_items": [
    {
      "object": "engagement_action_item",
      "id": "ai_1234567890",
      "title": "Follow up with marketing team",
      "description": "Coordinate with marketing to align sales campaigns.",
      "created_at": "2024-01-15T10:20:00Z",
      "updated_at": "2024-01-15T10:25:00Z",
      "due_on": "2024-01-20",
      "assigned_to_user_id": "usr_5C8D1E3FJK",
      "assigned_to_user_name": "Emily Smith",
      "assigned_to_user_email": "emily.smith@acme.com"
    }
  ],
  "signals": [
    {
      "object": "engagement_signal",
      "id": "sig_9876543210",
      "annotation_definition_id": "ann_0011223344",
      "name": "Positive Sentiment",
      "data_type": "boolean",
      "value": true,
      "description": "Detected positive sentiment in the conversation."
    }
  ],
  "tags": [
    {
      "object": "tag",
      "id": "tag_abc123xyz",
      "name": "Q1-2024",
      "created_at": "2024-01-10T14:00:00Z",
      "updated_at": "2024-01-10T14:00:00Z",
      "hex_color": "#1E90FF",
      "description": "Engagements related to Q1 2024 planning",
      "auto_tagging_enabled": false
    }
  ]
}

Returns a single workspace engagement. This operation requires the engagements:read scope. Requesting expand=companies also requires companies:read. Requesting expand=contacts also requires contacts:read. Requesting expand=owner also requires users:read.

Authentication

AuthorizationBearer

Bearer authentication of the form Bearer <token>, where token is your auth token.

Path parameters

engagement_idstringRequired

Query parameters

expandlist of enumsOptional

Comma-separated list of additional fields to include in the response. Valid values: companies, contacts, owner, action_items, signals, transcript, media_url, tags. companies additionally requires companies:read. contacts additionally requires contacts:read. owner additionally requires users:read.

Comma-separated list of additional fields to include in the response. Valid values: `companies`, `contacts`, `owner`, `action_items`, `signals`, `transcript`, `media_url`, `tags`. `companies` additionally requires `companies:read`. `contacts` additionally requires `contacts:read`. `owner` additionally requires `users:read`.

Response headers

ETagstring

X-Api-Versionstring

Response

Engagement response.

objectenum

Allowed values:

idstringformat: "^ngmt_[A-Za-z0-9]+$"

titlestring

engagement_typeenum

processing_statusenum

Allowed values:

created_atdatetime

updated_atdatetime

descriptionstring

data_sourcestring

is_internalboolean

engagement_atdatetime

start_atdatetime

end_atdatetime

duration_secondsinteger

meeting_urlstringformat: "uri"

owner_user_idstringformat: "^usr_[A-Za-z0-9]+$"

host_user_idstringformat: "^usr_[A-Za-z0-9]+$"

transcriptstring or null

Full text transcript of the engagement. Only included when expand contains transcript.

media_urlstring or nullformat: "uri"

Temporary signed URL for downloading the engagement recording media. Only included when expand contains media_url. The URL expires after a short period.

companieslist of objects

Companies associated with this engagement. Only included when expand contains companies.

contactslist of objects

Contact participants associated with this engagement. Only included when expand contains contacts.

ownerobject or null

Workspace user who owns this engagement. Only included when expand contains owner.

action_itemslist of objects

Action items created from this engagement. Only included when expand contains action_items.

signalslist of objects

Signals (annotations) extracted from this engagement. Only included when expand contains signals.

tagslist of objects

Tags applied to this engagement. Only included when expand contains tags.

Errors

401

Unauthorized Error

403

Forbidden Error

404

Not Found Error

429

Too Many Requests Error

500

Internal Server Error