Skip to main content
GET
Find Call by Attribute

Overview

This endpoint allows you to find a call by searching for specific attributes in either the call’s params or external_identifiers fields. It returns the most recent call that matches your search criteria.

Search Options

You must provide at least one of the following search criteria:

Search by Parameters

  • param_key + param_value: Search for a call where the params field contains the specified key-value pair

Search by External Identifiers

  • external_identifier_key + external_identifier_value: Search for a call where the external_identifiers field contains the specified key-value pair

Example Use Cases

  1. Find a call by customer ID:
  2. Find a call by appointment type:

Response

Returns a CallFindByAttributeResponse object containing:
  • success: Boolean indicating if a call was found
  • call: The full call details (same as the Get Call endpoint) if found

Notes

  • Only returns the most recent call matching the criteria
  • Searches are case-sensitive
  • Returns 404 if no matching call is found
  • Returns 422 if no search criteria are provided

Authorizations

Authorization
string
header
required

Query Parameters

param_key
string

The key to search for in the call's params field

param_value
string

The value to match for the specified param_key

external_identifier_key
string

The key to search for in the call's external_identifiers field

external_identifier_value
string

The value to match for the specified external_identifier_key

Response

Successful Response

success
boolean
required

Indicates if the request was successful

call
CallDetailsResponse · object
required

The call details if found