Find Call by Attribute
Calls
Find Call by Attribute
Find the most recent call matching specific parameter or external identifier key/value pairs
GET
Find Call by Attribute
Overview
This endpoint allows you to find a call by searching for specific attributes in either the call’sparams 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 theparamsfield contains the specified key-value pair
Search by External Identifiers
external_identifier_key+external_identifier_value: Search for a call where theexternal_identifiersfield contains the specified key-value pair
Example Use Cases
-
Find a call by customer ID:
-
Find a call by appointment type:
Response
Returns aCallFindByAttributeResponse object containing:
success: Boolean indicating if a call was foundcall: 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
Query Parameters
The key to search for in the call's params field
The value to match for the specified param_key
The key to search for in the call's external_identifiers field
The value to match for the specified external_identifier_key