Search Record
Overview
The Search Record endpoint is used to request details of a specified record, or records, in your database. You can also indicate with properties, or fields, you want to see in the response message.
Note: You can't modify the details of a record using this endpoint. To modify a record, you'll need to use the Record Lookup screen within the application.
Endpoint (North America): https://api.eccmp.com/services2/api/SearchRecords
Endpoint (Europe): https://api.ccmp.eu/services2/api/SearchRecords
Endpoint (Japan): https://api.marketingsuite.jp/services2/api/SearchRecords
For more details on the Search Record API, please see the Search Records API Technical Guide.
GET Method
The Search Record endpoint supports the following GET operations. These operations are intended to retrieve information about a record, or records, by providing different search parameters.
Retrieve a Record via Primary Key ID (i.e., "Record ID")
This endpoint allows you to search a single table for a single record by providing its Primary Key ID. You can specify the desired table either by the table's Object Reference ID or by its Table Name. You must also specify the field, or fields, you want returned in the response message. For the field names, be sure to use the system Column Name, and not the user-friendly display name.
Click hereClick here to see a sample response message in JSON format.
{
"id": 2191297,
"properties": [
{
"propName": "email",
"value": "mary_smith@cheetahdigital.com"
},
{
"propName": "name_first",
"value": "Mary"
},
{
"propName": "name_last",
"value": "Smith"
}
]
}
Search for Records
This endpoint allows you to search for and retrieve one or more records in a single table by providing the following:
The Object Reference ID or the Table Name for the table you want to search.
A field that you want to search. Be sure to use the system Column Name, and not the user-friendly display name.
A mathematical operator.
For equals, use "=" or "eq"
For less than, use "lt"
For less than or equal to, use "lte"
For greater than, use "gt"
For greater than or equal to, use "gte"
For contains, use "like"
For starts with, use "starts"
For ends with, use "ends"
For between, use "between"
The text string for which you want to search (if using the "between" operator, you must provide two values in this parameter).
The field, or fields, you want returned in the response message. For the field names, be sure to use the system Column Name, and not the user-friendly display name
Click hereClick here to see a sample response message in JSON format.
In this example, the user has defined the search parameters as "'email' field contains 'cheetah.'"
[
{
"id": 134343,
"properties": [
{
"propName": "email",
"value": "mary.smith@cheetahdigital.com"
},
{
"propName": "name_first",
"value": "Mary"
},
{
"propName": "name_last",
"value": "Smith"
}
]
},
{
"id": 345646,
"properties": [
{
"propName": "email",
"value": "john.doe@cheetahdigital.com"
},
{
"propName": "name_first",
"value": "John"
},
{
"propName": "name_last",
"value": "Doe"
}
]
},
{
"id": 657688,
"properties": [
{
"propName": "email",
"value": "admin@cheetahdigital.com"
},
{
"propName": "name_first",
"value": "Admin"
},
{
"propName": "name_last",
"value": "Account"
}
]
}
]
Back to API Category - Data Management