List company engagements | AskElephant

curl https://app.askelephant.ai/api/v2/companies/company_id/engagements \
     -H "Authorization: Bearer <token>" \
     -H "Content-Type: application/json"

{
  "object": "list",
  "data": [
    {
      "object": "engagement",
      "id": "ngmt_7F4X9K2LQ8",
      "title": "Q1 Sales Strategy Meeting",
      "engagement_type": "MEETING",
      "processing_status": "COMPLETED",
      "created_at": "2024-04-01T10:00:00Z",
      "updated_at": "2024-04-10T15:05:00Z",
      "description": "Discuss quarterly sales targets and strategies.",
      "data_source": "zoom",
      "is_internal": false,
      "engagement_at": "2024-04-10T14:00:00Z",
      "start_at": "2024-04-10T14:00:00Z",
      "end_at": "2024-04-10T15:00:00Z",
      "duration_seconds": 3600,
      "meeting_url": "https://zoom.us/j/1234567890",
      "owner_user_id": "usr_9X7Y6Z5W4V",
      "host_user_id": "usr_9X7Y6Z5W4V",
      "transcript": "Welcome everyone to the Q1 sales strategy meeting. Let's review last quarter's results...",
      "media_url": "https://media.askelephant.ai/recordings/ngmt_7F4X9K2LQ8?token=eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9",
      "companies": [
        {
          "object": "engagement_company",
          "id": "cmp_8J3K2L9M0N",
          "name": "Acme Corporation",
          "domains": [
            "acmecorp.com"
          ],
          "crm_association": {
            "object_type": "account",
            "crm_object_id": "0015g00000XyzAbcD",
            "source": "salesforce"
          }
        }
      ],
      "contacts": [
        {
          "object": "contact",
          "id": "cnt_01HQY3JMS2QAXJGX6X7CH7CM6X",
          "created_at": "2023-12-15T08:30:00Z",
          "updated_at": "2024-04-05T16:45:00Z",
          "first_name": "Ada",
          "last_name": "Lovelace",
          "description": "Primary customer contact for analytical projects.",
          "company": {
            "id": "cmp_8J3K2L9M0N",
            "object": "engagement_company"
          },
          "emails": [
            {
              "email": "ada.lovelace@acmecorp.com",
              "is_primary": true
            }
          ],
          "phone_numbers": [
            {
              "phone_number": "+1-555-0100",
              "is_primary": true
            }
          ],
          "crm_association": {
            "object_type": "contact",
            "crm_object_id": "0035g00000XyzAbcE",
            "source": "salesforce"
          },
          "time_zone": "America/Los_Angeles"
        }
      ],
      "owner": {
        "object": "user",
        "id": "usr_9X7Y6Z5W4V",
        "role": "OWNER",
        "created_at": "2022-01-10T09:00:00Z",
        "updated_at": "2024-04-10T15:10:00Z",
        "first_name": "John",
        "last_name": "Doe",
        "job_title": "Sales Manager",
        "emails": [
          {
            "email": "john.doe@acmecorp.com",
            "is_primary": true
          }
        ],
        "time_zone": "America/New_York",
        "last_activity_at": "2024-04-10T15:10:00Z"
      },
      "action_items": [
        {
          "object": "engagement_action_item",
          "id": "ai_1234567890",
          "title": "Prepare Q2 Sales Forecast",
          "description": "Compile sales data and prepare forecast for Q2.",
          "created_at": "2024-04-10T15:00:00Z",
          "updated_at": "2024-04-10T15:00:00Z",
          "due_on": "2024-04-20",
          "assigned_to_user_id": "usr_9X7Y6Z5W4V",
          "assigned_to_user_name": "John Doe",
          "assigned_to_user_email": "john.doe@acmecorp.com"
        }
      ],
      "signals": [
        {
          "object": "engagement_signal",
          "id": "sig_9876543210",
          "annotation_definition_id": "ann_001",
          "name": "Positive Sentiment",
          "data_type": "boolean",
          "value": true,
          "description": "Detected positive sentiment in discussion."
        }
      ],
      "tags": [
        {
          "object": "tag",
          "id": "tag_abc123xyz",
          "name": "Q1",
          "created_at": "2024-01-01T00:00:00Z",
          "updated_at": "2024-01-01T00:00:00Z",
          "hex_color": "#1E90FF",
          "description": "Engagements related to Q1 activities",
          "auto_tagging_enabled": false
        }
      ]
    }
  ],
  "has_more": true,
  "next_cursor": "eyJpZCI6Im5nbXRfN0Y0WDlLMkxROCJ9"
}

Returns engagements associated with a single workspace company using cursor pagination ordered by updated_at descending by default. Supports limit, cursor, and expand only. 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.

Returns engagements associated with a single workspace company using cursor pagination ordered by `updated_at` descending by default. Supports `limit`, `cursor`, and `expand` only. 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

company_idstringRequired

Query parameters

limitintegerOptional1-100Defaults to 25

Maximum number of results to return. Defaults to 25 and is capped at 100.

cursorstringOptional

Opaque cursor from a previous list response.

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. Requesting companies also requires companies:read. Requesting contacts also requires contacts:read. Requesting owner also 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`. Requesting `companies` also requires `companies:read`. Requesting `contacts` also requires `contacts:read`. Requesting `owner` also requires `users:read`.

Response headers

X-Api-Versionstring

Response

Paginated engagements list for the company.

objectenum

Allowed values:

datalist of objects

has_moreboolean

next_cursorstring or null

Errors

401

Unauthorized Error

403

Forbidden Error

404

Not Found Error

429

Too Many Requests Error

500

Internal Server Error