---
title: "Get Calls Bulk"
method: POST
path: "/v2/Pearl/{pearlId}/Calls/Bulk"
tags: ["Pearl"]
---

# Get Calls Bulk

`POST /v2/Pearl/{pearlId}/Calls/Bulk`

Retrieves calls within a date range like Get Calls, but lets the caller opt into additional fields (transcript, collected info, summary, recording, sentiment, credits, ...) via the Fields property. Only the requested fields are returned.

## Path parameters

- `pearlId` string, required

## Request body

- CallsBulkSearchApi
  - `skip` integer — Number of entries to skip for pagination.
  - `limit` integer — Limit on the number of entries to return.
  - `sortProp` string, nullable — Property name to sort by.
  - `isAscending` boolean — Whether the sort order is ascending.
  - `fromDate` string, date-time, required — The start date for filtering the search results.
  - `toDate` string, date-time, required — The end date for filtering the search results.
  - `tags` string[], nullable — List of tags to filter by.
  - `statuses` EConversationStatusView[], nullable — List of Status to filter by.
  - `searchInput` string, nullable — Text to filter by.
  - `fields` string[], nullable — Optional list selecting which additional fields are included in each returned call. Only the requested fields are populated; all others are omitted. Allowed values: Tags, Name, Summary, Recording, Transcript, CollectedInfo, OverallSentiment, IsCallTransferred, QueueDuration, CreditDebited, SmsCreditDebited, LeadId.

## Response `200`

Calls within the specified date range, including the requested fields.

- CallBulkApiViewTableSearchResult
  - `count` integer — The total number of items matching the search criteria.
  - `results` CallBulkApiView[], nullable — The list of results for the current page, based on the search criteria.
    - `id` string, nullable — The unique identifier of the call.
    - `pearlId` string, nullable — The unique identifier of the Pearl associated with the call.
    - `relatedId` string, nullable — The unique identifier of the related inbound or outbound entity.
    - `startTime` string, date-time, nullable — The date and time when the call processing started.
    - `conversationStatus` integer — The outcome of the conversation during the call. To determine the definition of 'Success' or 'Not Successful,' please refer to the [Create a Pearl](/pages/create_pearl#pearl-name) page at step 4. `10 - NotAnswered` `40 - OnGoing` `70 - VoiceMailLeft` `100 - Success` `110 - NotSuccessful` `130 - Completed` `150 - Unreachable` `220 - Blacklisted` `300 - QueueAbandon` `500 - Error`
    - `status` integer — Represents the current status of a call. `3 - InProgress` `4 - Completed` `5 - Busy` `6 - Failed` `7 - NoAnswer` `8 - Canceled` `10 - OnGoingText`
    - `from` string, nullable — The phone number from which the call was made.
    - `to` string, nullable — The phone number to which the call was made.
    - `duration` integer, nullable — The duration of the call in seconds.
    - `tags` string[], nullable — The tags or labels triggered during the conversation.
    - `name` string, nullable — The name associated with the call, if available.
    - `summary` string, nullable — A summary of the conversation.
    - `recording` string, nullable — The URL of the recording of the call, if available.
    - `transcript` AgentChatMessageApiView[], nullable — The transcript of the conversation, represented as a list of chat messages.
      - `role` integer — `2 - Pearl` `3 - Client` `4 - PlatformUser`
      - `content` string, nullable — The content of the message
      - `startTime` number, float, nullable — The moment the message starts
      - `endTime` number, float, nullable — The moment the message ends
    - `collectedInfo` CollectedInfoView[], nullable — A list containing information collected during the call.
      - `id` string, nullable — The ID of the variable collected
      - `name` string, nullable — The display name of the variable collected.
      - `value` unknown
    - `overallSentiment` integer — Represents the overall emotional tone detected from the client during the conversation. `1 - Negative` `2 - SlightlyNegative` `3 - Neutral` `4 - SlightlyPositive` `5 - Positive`
    - `isCallTransferred` boolean, nullable — Indicates whether the call was transferred to a human agent or another endpoint.
    - `queueDuration` integer, nullable — The time (in seconds) the user spent in the queue before being connected or transferred to an agent (inbound only).
    - `creditDebited` integer, nullable — The total amount of credits debited for the entire conversation.
    - `smsCreditDebited` integer, nullable — The total amount of SMS credits debited for the entire conversation.
    - `leadId` string, nullable — If the call is related to a lead, this is the unique identifier of that lead. Otherwise, this value is null.

## Other responses

- `400` — Error

---

[API](https://skmtc.net/nlpearl/apis/nlpearl-client-api.md) · [All operations](https://skmtc.net/nlpearl/apis/nlpearl-client-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/nlpearl/nlpearl-client-api/revisions/52d64fc5d6e9/schema)