Skip to main content
GET
/
meetings
Retrieve a list of meetings
curl --request GET \
  --url https://api.momentum.io/v1/meetings \
  --header 'X-API-Key: <api-key>'
{
  "meetings": [
    {
      "id": "<string>",
      "title": "<string>",
      "startTime": "2023-11-07T05:31:56Z",
      "endTime": "2023-11-07T05:31:56Z",
      "host": {
        "email": "<string>",
        "name": "<string>"
      },
      "attendees": [
        {
          "name": "<string>",
          "email": "[email protected]",
          "isInternal": true,
          "id": "<string>",
          "salesforceCaseId": "<string>",
          "salesforceLeadId": "<string>"
        }
      ],
      "transcript": {
        "entries": [
          {
            "text": "<string>",
            "speaker": {
              "name": "<string>",
              "attendeeId": "<string>"
            },
            "timestamp": "<string>",
            "timestampSeconds": 123
          }
        ]
      },
      "salesforceAccountId": "<string>",
      "salesforceOpportunityId": "<string>"
    }
  ],
  "pageCount": 123
}

Authorizations

​
X-API-Key
string
header
required

API key for authenticating requests

Query Parameters

​
from
string<date-time>

Filter meetings starting from this date-time (ISO 8601 format) inclusively.

​
to
string<date-time>

Filter meetings ending before this date-time (ISO 8601 format) inclusively.

​
pageNumber
number<int32>
default:1

The page number to retrieve (1-based indexing). Defaults to 1 if not specified.

Required range: x >= 1
​
pageSize
number<int32>
default:10

The maximum number of meetings to return per page. Must be between 1 and 100. Defaults to 10 if not specified.

Required range: 1 <= x <= 50
​
salesforceAccountId
string

Filter meetings associated with a specific Salesforce account. Optional, must be 18 characters in length. Cannot be used with salesforceOpportunityId.

Required string length: 18
​
salesforceOpportunityId
string

Filter meetings associated with a specific Salesforce opportunity. Optional, must be 18 characters in length. Cannot be used with salesforceAccountId.

Required string length: 18
​
attendeeEmailAddresses
string<email>[]

Filter meetings that include all of the provided attendee email addresses.

Response

200 - application/json

A list of meetings.

​
meetings
object[]
required
​
pageCount
number<int32>

Total number of pages available for the current query.