Get Calls

GET

/calls

Copy

Retrieve a list of in-progress and completed calls made from your account.

Authorization

X-Struct-API-Keyheader

string

required

The API Key you generated using the Struct Dashboard.

Search Parameters

status

'created' | 'queued' | 'initiated' | 'ringing' | 'in-progress' | 'completed' | 'busy' | 'failed' | 'no-answer' | 'cancelled'

Filter calls logs by their status.

sort

'desc' | 'asc'

Sort calls logs by their creation date. Defaults to 'desc'.

offset

number

The number of items to skip before starting to collect the result set. Defaults to 0.

limit

number

The number of items to return. Defaults to 100.

Example Response

[
  {
    "id": "[CALL ID]",
    "callBlueprintId": "[CALL BLUEPRINT ID]",
    "firstName": "Gob",
    "lastName": "Bluth",
    "phoneNumber": "+447123456789",
    "answeredBy": "human",
    "callDuration": 120,
    "createdAt": "2024-04-16T15:16:09.000Z",
    "projectId": "[PROJECT ID]",
    "transferNumber": null,
    "firstMessage": "Hi there, my name is Lisa, how can I help you today?",
    "goodbyeMessage": "Thank you so much for your time. Have a great day!",
    "prompt": "Your name is Lisa, you work for a real estate company ....",
    "status": "completed"
  }
  {
    "id": "[CALL ID]",
    // ....
  }
]