Search an external database table

Returns the rows of one table of a database, with a count.

POST /external_databases/{db_name}/search

cURL

cURL

curl -X POST "$EXSITED_BASE_URL/api/v4/external_databases/acmedb/search" \
  -H "Authorization: Bearer $ACCESS_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "table_name": "contacts"
  }'

200

{
  "external_database": {
    "success": true,
    "count": 123,
    "limit": 123,
    "offset": 123,
    "list": {}
  }
}

Send the table_name at the top level of the body. The response, under external_database, holds count, limit, offset and a list object keyed by table name, where each row maps column names to values. No filter fields are documented yet; with only table_name, the call returns the table’s rows.

The SDK samples get their client from credentials your app registers once when it starts, as shown in Authentication. To try the call here, click Try it, set host to your Exsited API host name and paste an access token from Get an access token. To send a raw JSON body instead of filling in fields, copy the cURL sample and edit its -d payload.

Authorizations

Authorization · string · header · required

An access token from POST /api/v4/oauth2/token. The SDKs get and renew it for you.

Path Parameters

db_name · string · required

The database's name, as given when it is created, such as acmedb.

Body

application/json

table_name · string

Response

200 - application/json

The matching rows, under external_database.list.

external_database · object

Show child attributes