Skip to main content
GET
/
v1
/
core
/
recordings
{
  "data": [
    {
      "id": "<string>",
      "repFirstName": "<string>",
      "repLastName": "<string>",
      "dateCreated": "<string>",
      "durationInMilliseconds": 123,
      "result": "<string>",
      "title": "<string>",
      "isPrivate": true,
      "userId": "<string>",
      "discoverable": true,
      "followups": [
        {
          "id": "<string>",
          "score": 123
        }
      ],
      "crmCustomer": {
        "id": "<string>",
        "name": "<string>",
        "crmUrl": "<string>",
        "customerType": "ACCOUNT",
        "lastActivityAt": "<string>",
        "emailAddress": "<string>",
        "phoneNumber": "<string>",
        "externalId": "<string>",
        "matchingSource": "DIRECT",
        "opportunityId": "<string>",
        "engagementId": "<string>",
        "opportunity": {
          "id": "<string>",
          "externalId": "<string>",
          "name": "<string>",
          "amount": 123,
          "closedAt": "<string>",
          "disposition": "<string>",
          "createdAt": "<string>",
          "updatedAt": "<string>",
          "recordingId": "<string>",
          "accountId": "<string>",
          "organizationId": "<string>",
          "account": "<any>",
          "opportunityUsers": [
            "<any>"
          ]
        },
        "contactAccount": {
          "id": "<string>",
          "name": "<string>",
          "externalId": "<string>"
        },
        "address": "<string>",
        "integrationConnectionId": "<string>",
        "integrationPlatform": "MERGE",
        "integrationName": "<string>"
      }
    }
  ],
  "cursor": "<string>"
}

Query Parameters

​
limit
string

Number of results to return per page (default is 100, max is 100)

​
conversationType
string

Filter by conversation type name(s), e.g. "My Best Convo". Multiple types can be specified as comma-separated values

​
discoverable
enum<string>

Filter by discoverable status.

Available options:
true,
false
​
result

Result of the recording (e.g., closed, not closed).

​
organizationId
string

Filter by organization ID

​
jumpToTags:text
string

Filter by jump-to-tag text. Multiple tags can be specified as comma-separated values

​
teamId
string

Filter by team ID(s). Multiple teams can be specified as comma-separated values

​
dateCreated:gt
string

Return results created after the given date. Format: ISO 8601 timestamp (YYYY-MM-DDTHH:mm:ss.sssZ)

​
dateCreated:lt
string

Return results created before the given date. Format: ISO 8601 timestamp (YYYY-MM-DDTHH:mm:ss.sssZ)

​
orderBy
string

Field to order results by. It is possible to order by any filterable field.

​
orderDirection
enum<string>

Order direction: "asc" or "desc"

Available options:
asc,
desc
​
cursor
string

Cursor for pagination

​
crmLinkStatus
enum<string>

Filter by CRM link status: "unlinked" finds recordings with no definitively linked opportunity or engagement that is linked to a customer (account/contact/lead)

Available options:
unlinked
​
showCrmCustomer
enum<string>

Whether to include CRM customer data for each recording

Available options:
true,
false
​
showFollowups
enum<string>

Whether to include followups for each recording

Available options:
true,
false
​
scope
enum<string>

Which users to return results for. 'own' returns the caller's recordings, 'team' returns all the recordings for the teams the user coaches

Available options:
own,
team
​
hasConversationTime
enum<string>

Filter for recordings that have a conversation time greater than 0

Available options:
true,
false

Response

Get recordings

​
data
object[]
required
​
cursor
string | null
required

Opaque cursor for pagination