Get data
GET /api/v1/data_sets/search?customer_contact_number=<num>
Retrieve previously stored data before it expires.
Headers
| Header | Description |
|---|---|
| Authorization | Requires "Bearer " plus the API Token of the Data Set Template |
| content-type | Requires application/json |
Parameters
| Parameter | Description |
|---|---|
| url | The full URL of the endpoint with the customer_contact_number appended (example: https://api-ds.getmindful.com/api/v1/data_sets/search?customer_contact_number=555-555-5555) Important: The customer contact number must be entered exactly as it was submitted (with or without country code, for example). |
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 code | Description |
|---|---|
| 200 OK | The request was processed successfully. |
| 401 Unauthorized | "error": "InvalidToken" indicates an issue with the Authorization header. |
| 404 Not Found | The request contains an invalid phone number in the query string. |
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
| Property | Description | Data 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 |
| ani | The detected customer ANI, which could differ from the customer_contact_number if the customer provides a different callback number. | string |
| ecbt | The Estimated Callback Time set by Mindful after a callback is registered for the customer_contact_number. | integer (seconds) |
| time_to_expire | A timestamp indicating when the data will be automatically removed
| timestamp |
| Your data values | Any KVPs you submitted in the data_values object. | string |
