Skip to main content
GET
/
v2
/
calls
Get Calls
curl --request GET \
  --url https://api.example.com/v2/calls \
  --header 'Authorization: Bearer <token>'
{
  "data": [
    {
      "created_at": "2023-11-07T05:31:56Z",
      "modified_at": "2023-11-07T05:31:56Z",
      "id": "<string>",
      "approver": {
        "created_at": "2023-11-07T05:31:56Z",
        "modified_at": "2023-11-07T05:31:56Z",
        "id": "<string>",
        "email": "<string>",
        "name": "<string>",
        "given_name": "<string>",
        "family_name": "<string>",
        "profile_picture": "<string>",
        "object": "<string>"
      },
      "classifications": [
        {
          "created_at": "2023-11-07T05:31:56Z",
          "modified_at": "2023-11-07T05:31:56Z",
          "id": "<string>",
          "object": "<string>"
        }
      ],
      "disconnection_reason": "<string>",
      "from_number": "<string>",
      "in_voicemail": true,
      "invoices": [
        {
          "created_at": "2023-11-07T05:31:56Z",
          "modified_at": "2023-11-07T05:31:56Z",
          "id": "<string>",
          "number": "<string>",
          "amount_due": "<string>",
          "amount_paid": "<string>",
          "amount_remaining": "<string>",
          "pending_amount_remaining": "<string>",
          "total_amount": "<string>",
          "due_date": "2023-11-07T05:31:56Z",
          "issued_at": "2023-11-07T05:31:56Z",
          "paid_at": "2023-11-07T05:31:56Z",
          "purchase_order_number": "<string>",
          "order_number": "<string>",
          "partner": {
            "created_at": "2023-11-07T05:31:56Z",
            "modified_at": "2023-11-07T05:31:56Z",
            "id": "<string>",
            "account_number": "<string>",
            "assignee_id": "<string>",
            "business_unit_id": "<string>",
            "email": "<string>",
            "name": "<string>",
            "legal_name": "<string>",
            "phone": "<string>",
            "parent_id": "<string>",
            "remote_id": "<string>",
            "object": "<string>"
          },
          "object": "<string>"
        }
      ],
      "call_reason": "<string>",
      "start_time": "2023-11-07T05:31:56Z",
      "end_time": "2023-11-07T05:31:56Z",
      "partner": {
        "created_at": "2023-11-07T05:31:56Z",
        "modified_at": "2023-11-07T05:31:56Z",
        "id": "<string>",
        "account_number": "<string>",
        "assignee_id": "<string>",
        "business_unit_id": "<string>",
        "email": "<string>",
        "name": "<string>",
        "legal_name": "<string>",
        "phone": "<string>",
        "parent_id": "<string>",
        "remote_id": "<string>",
        "object": "<string>"
      },
      "provider": "<string>",
      "tasks": [
        {
          "created_at": "2023-11-07T05:31:56Z",
          "modified_at": "2023-11-07T05:31:56Z",
          "id": "<string>",
          "label": "<string>",
          "description": "<string>",
          "assignee_id": "<string>",
          "object": "<string>"
        }
      ],
      "to_number": "<string>",
      "workflow": {
        "created_at": "2023-11-07T05:31:56Z",
        "modified_at": "2023-11-07T05:31:56Z",
        "id": "<string>",
        "name": "<string>",
        "is_active": true,
        "object": "<string>"
      },
      "workflow_run": {
        "created_at": "2023-11-07T05:31:56Z",
        "modified_at": "2023-11-07T05:31:56Z",
        "id": "<string>",
        "scheduled_for": "2023-11-07T05:31:56Z",
        "object": "<string>"
      },
      "object": "<string>",
      "display_tasks": [
        {
          "created_at": "2023-11-07T05:31:56Z",
          "modified_at": "2023-11-07T05:31:56Z",
          "id": "<string>",
          "label": "<string>",
          "description": "<string>",
          "assignee_id": "<string>",
          "object": "<string>"
        }
      ]
    }
  ],
  "current_page": 0,
  "total_records": 1,
  "next_page": 123
}

Documentation Index

Fetch the complete documentation index at: https://docs.api.stuut.co/llms.txt

Use this file to discover all available pages before exploring further.

Authorizations

​
Authorization
string
header
required

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

Query Parameters

​
page
integer
default:0

Page number, 0 indexed.

Required range: x >= 0
​
limit
integer
default:100

Number of records per page.

Required range: 1 <= x <= 500
​
business_unit_id__in
string[] | null

Filter by business unit IDs.

​
sentiment
enum<string>[] | null

Filter by one or more sentiment values.

Available options:
positive,
negative,
neutral,
unknown
​
classification
enum<string>[] | null

Filter by one or more call classification values.

Enumerates the possible classifications for an interaction (email or call).

Available options:
payment_inquiry,
payment_promise,
account_inquiry,
invoice_inquiry,
refund_request,
cancellation_request,
support_request,
complaint,
feedback,
wrong_contact,
message_forwarding_request,
cc_inclusion_request,
not_available,
contact_inquiry,
dispute,
resolution,
delivery_failure,
payment_processing_request,
other
​
direction
enum<string> | null

Filter by call direction.

Available options:
inbound,
outbound
​
partner_id
string | null

Filter by partner ID.

​
invoice_id
string | null

Filter by invoice ID.

​
workflow_id
string | null

Filter by workflow ID.

​
before
string<date-time> | null

Return calls that started or were created before this time.

​
after
string<date-time> | null

Return calls that started or were created after this time.

Response

Successful Response

​
data
CallList · object[]
required

The list of records.

​
current_page
integer
default:0
required

The current page.

​
total_records
integer | null
required

Total number of records.

Required range: x >= 0
​
next_page
integer | null
required

The next page number, if one exists.