Query Rows
Query contact rows
curl --request POST \
--url https://api.simpu.co/lists/contact/rows/query \
--header 'Authorization: <api-key>' \
--header 'Content-Type: application/json' \
--data '{
"smartlist_id": "1234",
"filters": [
{
"column_id": "fe9bafa8ae434a838a278aa7e710cded",
"name": "full_name",
"value": "John",
"operator": "contain"
}
]
}'{
"rows": [
{
"id": "674535b2b39158b9aae90188fcec23eb",
"columns": {
"674535b2b39158b9aae90188fcec23ec": "John Doe",
"674535b2b39158b9aae90188fcec23ed": "john@acme.org",
"674535b2b39158b9aae90188fcec23ee": "9291234567"
},
"created_datetime": "2024-06-28T23:56:38.128604+00:00",
"updated_datetime": "2024-06-28T23:56:38.128604+00:00"
}
],
"table": {
"id": "674535b2b39158b9aae90188fcec23eb",
"columns": [
{
"id": "674535b2b39158b9aae90188fcec23ec",
"name": "name",
"type": "TEXT"
},
{
"id": "674535b2b39158b9aae90188fcec23ed",
"name": "Email",
"type": "EMAIL"
},
{
"id": "674535b2b39158b9aae90188fcec23ee",
"name": "Mobile",
"type": "PHONE NUMBER"
}
],
"created_datetime": "2024-06-28T23:56:38.128604+00:00",
"updated_datetime": "2024-06-28T23:56:38.128604+00:00"
},
"smartlist": {
"id": "674535b2b39158b9aae90188fcec23eb",
"created_datetime": "2024-06-28T23:56:38.128604+00:00",
"updated_datetime": "2024-06-28T23:56:38.128604+00:00"
},
"meta": {
"method": "POST",
"resource": "/lists/contact/rows/query",
"pagination": {
"next_page": "True",
"per_page": 7,
"count_total": 50,
"page_total": 100,
"page": 9,
"prev_page": "True",
"query_id": "1234"
}
}
}Authorizations
An API key to authenticate requests
Query Parameters
Number of rows to retrieve per page.
The page number for paginated results.
The scroll query ID for paginated results.
Body
ID of the SmartList to apply custom filters
"1234"
List of filter criteria to apply to the query
Response
ID of the row
"674535b2b39158b9aae90188fcec23eb"
Data values for each column in the row
{
"674535b2b39158b9aae90188fcec23ec": "John Doe",
"674535b2b39158b9aae90188fcec23ed": "john@acme.org",
"674535b2b39158b9aae90188fcec23ee": "9291234567"
}
Date and time the Row was created
"2024-06-28T23:56:38.128604+00:00"
Date and time the Row was last updated, if any
"2024-06-28T23:56:38.128604+00:00"
ID of the Table
"674535b2b39158b9aae90188fcec23eb"
List of column names in the table
ID of the column
"674535b2b39158b9aae90188fcec23ec"
Name of the column
"name"
Type of the column
TEXT, NUMBER, DATE, PHONE NUMBER, EMAIL, URL, SELECT, MULTI SELECT "TEXT"
[
{
"id": "674535b2b39158b9aae90188fcec23ec",
"name": "name",
"type": "TEXT"
},
{
"id": "674535b2b39158b9aae90188fcec23ed",
"name": "Email",
"type": "EMAIL"
},
{
"id": "674535b2b39158b9aae90188fcec23ee",
"name": "Mobile",
"type": "PHONE NUMBER"
}
]
Date and time the table was created
"2024-06-28T23:56:38.128604+00:00"
Date and time the table was last updated, if any
"2024-06-28T23:56:38.128604+00:00"
Smartlist ID
"674535b2b39158b9aae90188fcec23eb"
Date and time the smartlist was created
"2024-06-28T23:56:38.128604+00:00"
Date and time the smartlist was last updated, if any
"2024-06-28T23:56:38.128604+00:00"
The HTTP method used to make the request
"POST"
The resource requested
"/lists/contact/rows/query"
Indicates if there is a subsequent page
"True"
Specifies the number of items displayed per page in the current query
7
The total count of all items available across all pages for the current query
50
The total number of pages available based on the per_page setting and the total item count
100
The current page number for the query or response
9
Indicates if there is a previous page available; true if a prior page exists
"True"
A unique identifier for the current query, which may correspond to the last row ID
"1234"
curl --request POST \
--url https://api.simpu.co/lists/contact/rows/query \
--header 'Authorization: <api-key>' \
--header 'Content-Type: application/json' \
--data '{
"smartlist_id": "1234",
"filters": [
{
"column_id": "fe9bafa8ae434a838a278aa7e710cded",
"name": "full_name",
"value": "John",
"operator": "contain"
}
]
}'{
"rows": [
{
"id": "674535b2b39158b9aae90188fcec23eb",
"columns": {
"674535b2b39158b9aae90188fcec23ec": "John Doe",
"674535b2b39158b9aae90188fcec23ed": "john@acme.org",
"674535b2b39158b9aae90188fcec23ee": "9291234567"
},
"created_datetime": "2024-06-28T23:56:38.128604+00:00",
"updated_datetime": "2024-06-28T23:56:38.128604+00:00"
}
],
"table": {
"id": "674535b2b39158b9aae90188fcec23eb",
"columns": [
{
"id": "674535b2b39158b9aae90188fcec23ec",
"name": "name",
"type": "TEXT"
},
{
"id": "674535b2b39158b9aae90188fcec23ed",
"name": "Email",
"type": "EMAIL"
},
{
"id": "674535b2b39158b9aae90188fcec23ee",
"name": "Mobile",
"type": "PHONE NUMBER"
}
],
"created_datetime": "2024-06-28T23:56:38.128604+00:00",
"updated_datetime": "2024-06-28T23:56:38.128604+00:00"
},
"smartlist": {
"id": "674535b2b39158b9aae90188fcec23eb",
"created_datetime": "2024-06-28T23:56:38.128604+00:00",
"updated_datetime": "2024-06-28T23:56:38.128604+00:00"
},
"meta": {
"method": "POST",
"resource": "/lists/contact/rows/query",
"pagination": {
"next_page": "True",
"per_page": 7,
"count_total": 50,
"page_total": 100,
"page": 9,
"prev_page": "True",
"query_id": "1234"
}
}
}