v2

latestOpenAPI 3.0.02026-07-26365590.3 KB

Calls

List calls

Returns a paginated list of calls scoped to the workspaces accessible by the API key. Use the workspaceIds query parameter to narrow results to a subset of those workspaces.

get/v1/calls

Query parameters

pagenumber

Example:1

Page number (starts at 1)

limitnumber

Example:10

Number of items per page

sortstring

Sort as a JSON string, e.g. ?sort={"orderBy":"createdAt","order":"desc"} (URL-encoded). Defaults to createdAt descending.

filtersstring

Filters as a JSON string. Each field wraps an operator object, e.g. ?filters={"createdAt":{"op":"between","from":"2026-06-01","to":"2026-06-30"}} or {"createdAt":{"op":"gt","from":"2026-06-25"}} (URL-encoded).

workspaceIdsstring

Example:550e8400-e29b-41d4-a716-446655440000,6ba7b810-9dad-11d1-80b4-00c04fd430c8

Workspace IDs to narrow down results. Must be a subset of the workspaces accessible by the API key. Omit to return data from every workspace in scope. Accepts either a comma-separated string (?workspaceIds=uuid1,uuid2) — the documented format — or repeated array params (?workspaceIds[]=uuid1&workspaceIds[]=uuid2).

Response

Paginated list of calls

totalnumber required

pagenumber required

limitnumber required

totalPagesnumber required

Example response

{
  "data": [
    {
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "callType": "CALL_SESSION",
      "phoneNumberId": "123e4567-e89b-12d3-a456-426614174002",
      "userProviderSid": "CA123456789",
      "providerConferenceId": "CF123456789",
      "status": "completed",
      "type": "outbound",
      "createdAt": "2024-03-20T08:55:00.000Z",
      "updatedAt": "2024-03-20T09:16:00.000Z",
      "sequenceRunId": "123e4567-e89b-12d3-a456-426614174003",
      "sequenceId": "123e4567-e89b-12d3-a456-426614174010",
      "deletedAt": "2024-03-20T09:15:00.000Z",
      "organizationId": "123e4567-e89b-12d3-a456-426614174004",
      "organizationMembershipId": "123e4567-e89b-12d3-a456-426614174005",
      "managedPhoneNumberId": "123e4567-e89b-12d3-a456-426614174006",
      "notes": "Call notes here",
      "contact": {
        "id": "123e4567-e89b-12d3-a456-426614174000",
        "firstName": "John",
        "lastName": "Doe"
      },
      "phoneNumber": {
        "value": "+33612345678"
      },
      "caller": {
        "firstName": "Alice",
        "lastName": "Martin"
      },
      "callerPhoneNumber": {
        "value": "+33612345678"
      }
    }
  ],
  "total": 100,
  "page": 1,
  "limit": 10,
  "totalPages": 10
}