Sign in
External Services - Query

List entities (tables, collections, etc.) in a container Example: /external-services/1/query/containers/mydb/public/entities lists tables in the public schema

get/external-services/{service_id}/query/containers/{path}/entities

Request

  • Base URL: /api (relative, and the document was published on a file host, not at the API’s origin)
  • URL: /api/external-services/{service_id}/query/containers/{path}/entities
  • Auth: HTTP bearer

Path parameters

service_idinteger required
pathstring required

Query parameters

limitinteger

Maximum number of entities to return (default: 100, max: 1000)

tokenstring

Continuation token for pagination

Response

Paginated list of entities

countinteger required

Number of entities returned

has_moreboolean required

Whether there are more entities available

limitinteger required

Limit used for this request

next_tokenstring nullable

Continuation token for next page (S3, etc.)

totalinteger nullable

Total number of entities (if available)

Example response

{
  "entities": [
    {
      "entity_type": "table",
      "name": "users",
      "row_count": 1234,
      "size_bytes": 1048576
    }
  ]
}

Changes

No recorded changes to this operation across all 50 revisions of this API.