Skip to main content
GET
/
v1
/
schemas
/
{schemaName}
Get schema
curl --request GET \
  --url https://api.dynamosql.com/v1/schemas/{schemaName} \
  --header 'Authorization: Bearer <token>'
{
  "success": true,
  "data": {
    "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>.

Path Parameters

​
schemaName
string
required

The schema name to retrieve.

Response

Schema record.

​
success
boolean
required

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

​
data
object

A DynamoSQL schema record. A schema connects a logical name to the IAM role and AWS region DynamoSQL uses to access DynamoDB on your behalf via cross-account role assumption.

​
error
object

Present in the response body when success is false.