Get data

GET /api/v1/data_sets/search?customer_contact_number=<num>

Retrieve previously stored data before it expires.

Headers

HeaderDescription
AuthorizationRequires "Bearer " plus the API Token of the Data Set Template
content-typeRequires application/json

Parameters

ParameterDescription
urlThe full URL of the endpoint with the customer_contact_number appended (example: https://datastore.mindfulcx.com/api/v1/data_sets/search?customer_contact_number=555-555-5555)

Example request

curl 
--request GET \ 
--url 'https://api-ds.getmindful.com/api/v1/data_sets/search? customer_contact_number=555-555-5555' \ 	
--header 'Authorization: Bearer f4k39htnuoSEbClJCVqaql/De1fJfSGf4k3xzwEgQIo=' \ 
--header 'content-type: application/json'

Status codes

Status codeDescription
200 OKThe request was processed successfully.
401 Unauthorized"error": "InvalidToken" indicates an issue with the Authorization header.

Example response

{
    "customer_contact_number": "5555555555",
    "ani": "5555555555",
    "ecbt": null,
    "time_to_expire": "2022-08-08T21:07:22.000Z",
    "AccNum": "Example Value",
    "LastName": "Example Value",
    "FirstName": "Example Value",
    "Callid": "Example Value"
}

Model

PropertyDescriptionData Type
customer_contact_number

The customer callback number to be used as the search key for the data you submit.

If the customer enters a different callback number, Mindful will automatically update the value of customer_contact_number.

string
aniThe detected customer ANI, which could differ from the customer_contact_number if the customer provides a different callback number.integer
ecbtThe Estimated Callback Time set by Mindful after a callback is registered for the customer_contact_number.integer (seconds)
time_to_expireA timestamp indicating when the data will be automatically removed (ecbt + the Data Set Template's Time to Expire value).timestamp
Your data valuesAny KVPs you submitted in the data_values object.string