Query Rows

cURL

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": "[email protected]",
        "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"
    }
  }
}

POST

lists

contact

rows

query

cURL

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": "[email protected]",
        "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

smartlist_id

string

ID of the SmartList to apply custom filters

Example:

"1234"

filters

object[]

List of filter criteria to apply to the query

Show child attributes

filters.column_id

string

Example:

"fe9bafa8ae434a838a278aa7e710cded"

filters.name

string

Example:

"full_name"

filters.value

string

Example:

"John"

filters.operator

enum<string>

Available options:

equal,

not_equal,

empty,

not_empty,

contain,

not_contain,

is_any,

is_none_of

Example:

"contain"

Response

Successful response containing table, row data, and metadata

rows

object[]

Show child attributes

rows.id

string

required

ID of the row

Example:

"674535b2b39158b9aae90188fcec23eb"

rows.columns

object

required

Data values for each column in the row

Example:

{
  "674535b2b39158b9aae90188fcec23ec": "John Doe",
  "674535b2b39158b9aae90188fcec23ed": "[email protected]",
  "674535b2b39158b9aae90188fcec23ee": "9291234567"
}

rows.created_datetime

string

Date and time the Row was created

Example:

"2024-06-28T23:56:38.128604+00:00"

rows.updated_datetime

string

Date and time the Row was last updated, if any

Example:

"2024-06-28T23:56:38.128604+00:00"

table

object

Show child attributes

table.id

string

required

ID of the Table

Example:

"674535b2b39158b9aae90188fcec23eb"

table.columns

object[]

required

List of column names in the table

Show child attributes

table.columns.id

string

required

ID of the column

Example:

"674535b2b39158b9aae90188fcec23ec"

table.columns.name

string

required

Name of the column

Example:

"name"

table.columns.type

enum<string>

required

Type of the column

Available options:

TEXT,

NUMBER,

DATE,

PHONE NUMBER,

EMAIL,

URL,

SELECT,

MULTI SELECT

Example:

"TEXT"

Example:

[
  {
    "id": "674535b2b39158b9aae90188fcec23ec",
    "name": "name",
    "type": "TEXT"
  },
  {
    "id": "674535b2b39158b9aae90188fcec23ed",
    "name": "Email",
    "type": "EMAIL"
  },
  {
    "id": "674535b2b39158b9aae90188fcec23ee",
    "name": "Mobile",
    "type": "PHONE NUMBER"
  }
]

table.created_datetime

string

Date and time the table was created

Example:

"2024-06-28T23:56:38.128604+00:00"

table.updated_datetime

string

Date and time the table was last updated, if any

Example:

"2024-06-28T23:56:38.128604+00:00"

smartlist

object

Show child attributes

smartlist.id

string

required

Smartlist ID

Example:

"674535b2b39158b9aae90188fcec23eb"

smartlist.created_datetime

string

Date and time the smartlist was created

Example:

"2024-06-28T23:56:38.128604+00:00"

smartlist.updated_datetime

string

Date and time the smartlist was last updated, if any

Example:

"2024-06-28T23:56:38.128604+00:00"

Getting Started

OTP

Texts

Mails

List

Airtime

Authorizations

Query Parameters

Body

Response