Skip to content
ShipSquares

/db-connections/{id}/tables/{schema}/{table}/rows

GET
/db-connections/{id}/tables/{schema}/{table}/rows
 
curl --request GET \
  --url 'https://example.com/api/v1/db-connections/example/tables/example/example/rows?limit=100&offset=0'

Parameters

Section titled “ Parameters ”

Path Parameters

Section titled “Path Parameters ”
id
required
string
schema
required
string
table
required
string

Query Parameters

Section titled “Query Parameters ”
limit
integer
default: 100 >= 1 <= 1000
offset
integer
0
sort
string
<= 200 characters
filters
string
<= 2000 characters

Responses

Section titled “ Responses ”

200

Section titled “200 ”

Default Response

Media type application/json
object
fields
required
Array<object>
object
name
required
string
dataType
required
string
rows
required
Array<object>
object
key
additional properties
primaryKey
required
Array<string>
page
required
object
limit
required
integer
offset
required
integer
hasMore
required
boolean
Example generated
{
  "fields": [
    {
      "name": "example",
      "dataType": "example"
    }
  ],
  "rows": [
    {
      "additionalProperty": "example"
    }
  ],
  "primaryKey": [
    "example"
  ],
  "page": {
    "limit": 1,
    "offset": 1,
    "hasMore": true
  }
}

400

Section titled “400 ”

Default Response

Media type application/json
object
type
required
string
title
required
string
status
required
integer
code
required
string
detail
string
instance
string
errors
Array<object>
object
path
required
string
message
required
string
Example generated
{
  "type": "example",
  "title": "example",
  "status": 1,
  "code": "example",
  "detail": "example",
  "instance": "example",
  "errors": [
    {
      "path": "example",
      "message": "example"
    }
  ]
}

404

Section titled “404 ”

Default Response

Media type application/json
object
type
required
string
title
required
string
status
required
integer
code
required
string
detail
string
instance
string
errors
Array<object>
object
path
required
string
message
required
string
Example generated
{
  "type": "example",
  "title": "example",
  "status": 1,
  "code": "example",
  "detail": "example",
  "instance": "example",
  "errors": [
    {
      "path": "example",
      "message": "example"
    }
  ]
}