Skip to main content
GET
/
v1
/
schemas
List schemas
curl --request GET \
  --url https://api.dynamosql.com/v1/schemas \
  --header 'Authorization: Bearer <token>'
{
  "success": true,
  "data": {
    "items": [
      {
        "tenantId": "tenant-abc123",
        "schemaName": "myschema",
        "region": "us-east-1",
        "accountId": "123456789012",
        "roleArn": "arn:aws:iam::123456789012:role/DynamoSQLReadRole",
        "externalId": "dsql-ext-7f3a9c2b",
        "tableAllowlist": [
          "Users",
          "Orders"
        ],
        "status": "active",
        "createdAt": "2026-01-15T10:30:00.000Z"
      }
    ]
  }
}
Required scope: schemas:read

Authorizations

Authorization
string
header
required

Bearer token obtained from POST /v1/auth/token. Pass in the Authorization header as Bearer <token>.

Query Parameters

limit
integer

Maximum schemas to return per page. Defaults to the service maximum when omitted. Must be a positive integer.

Required range: x >= 1
nextToken
string

Pagination cursor from a previous response's data.nextToken. Omit to start from the beginning.

Response

List of schemas.

success
boolean
required

true when the request was processed without errors, false otherwise. Always present.

data
object
error
object

Present in the response body when success is false.