Calls

List calls

Retrieve paginated list of calls with optional filters.

Metadata Filtering: Filter calls by JSONB metadata fields using the format: ?metadata[path.to.field][operator]=value

By default, unqualified paths target call.metadata. You can also scope filters to related data:

  • call.some_field -> call.metadata.some_field
  • target.some_field -> runExecution.target.metadata.some_field
  • phone.some_field -> runExecution.phone.metadata.some_field
  • variableData.some_field -> runExecution.variableData.some_field
  • runExecution.target.metadata.some_field -> explicit target metadata path
  • runExecution.variableData.some_field -> explicit execution variable data path

Supported Operators:

  • equals: Exact match
  • not: Not equal
  • gt: Greater than (numeric)
  • gte: Greater than or equal (numeric)
  • lt: Less than (numeric)
  • lte: Less than or equal (numeric)
  • contains: String contains (case-insensitive)
  • array_contains: Array contains value

Examples:

  • /calls?metadata[call.duration][gt]=30 - Calls longer than 30 seconds
  • /calls?metadata[insight.property_value][gte]=1000000 - High-value properties
  • /calls?metadata[tags][array_contains]=important - Calls tagged as important
  • /calls?metadata[target.source][equals]=hubspot - Filter by target metadata source
  • /calls?metadata[runExecution.target.metadata.source][equals]=hubspot - Same filter with explicit scope
  • /calls?metadata[variableData.external_id][equals]=123 - Filter by run execution variable data
  • /calls?metadata[status][equals]=completed&campaignId=xxx - Combine with other filters

Limits:

  • Maximum 10 metadata filters per request
  • Path must be alphanumeric with dots (e.g., "call.duration", "insight.value")
get/api/v1/calls

Request

  • Base URL: http://localhost:8080
  • URL: http://localhost:8080/api/v1/calls
  • Auth: bearerAuth (a scheme the document does not define)

Query parameters

pageinteger
limitinteger
campaignIdstring uuid

Filter by campaign ID

runIdstring uuid

Filter by run ID

targetIdstring uuid

Filter by target ID

statusstring

Filter by call status

createdAtGtstring

Filter by createdAt greater than (ISO 8601 with timezone support)

createdAtGtestring

Filter by createdAt greater than or equal (ISO 8601 with timezone support)

createdAtLtstring

Filter by createdAt less than (ISO 8601 with timezone support)

createdAtLtestring

Filter by createdAt less than or equal (ISO 8601 with timezone support)

updatedAtGtstring

Filter by updatedAt greater than (ISO 8601 with timezone support)

updatedAtGtestring

Filter by updatedAt greater than or equal (ISO 8601 with timezone support)

updatedAtLtstring

Filter by updatedAt less than (ISO 8601 with timezone support)

updatedAtLtestring

Filter by updatedAt less than or equal (ISO 8601 with timezone support)

Response

Paginated list of calls

successtrue required

Changes

No recorded changes to this operation across all 1 revision of this API.