POST
/
lists
/
contact
/
rows
/
query
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

​
Authorization
string
header
required

An API key to authenticate requests

Query Parameters

​
limit
integer
default:100

Number of rows to retrieve per page.

​
page
integer
default:1

The page number for paginated results.

​
query_id
integer
default:0

The scroll query ID for paginated results.

Body

application/json
Query contact rows object

The body is of type object.

Response

200
application/json
Successful response containing table, row data, and metadata

The response is of type object.