Retrieve the columns of an external database table

Returns the columns of one table of a database, as a list under data.

GET /external_databases/{db_name}/tables/{table_name}

cURL

cURL

curl -X GET "$EXSITED_BASE_URL/api/v4/external_databases/acmedb/tables/contacts" \
  -H "Authorization: Bearer $ACCESS_TOKEN"

200

{
  "object": "<string>",
  "url": "<string>",
  "data": [
    {}
  ],
  "pagination": {
    "has_next": true,
    "has_prev": true,
    "per_page": 123,
    "next_cursor": "<string>",
    "prev_cursor": "<string>",
    "links": {
      "next": "<string>",
      "prev": "<string>"
    }
  }
}

Pass the database name as db_name and the table’s table_name. The response has the same shape as the database listing, with the table’s columns under data.

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.

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.

table_name · string · required

The table's table_name, such as contacts.

Response

200 - application/json

The table's columns, under data.

object · string

url · string

data · object[]

The entries on this page. In the database listing, each has a name.

pagination · object

Show child attributes