Skip to main content
GET
/
v4
/
schemas
/
{schemaId}
Get schema by ID
curl --request GET \
  --url https://api.kadoa.com/v4/schemas/{schemaId} \
  --header 'x-api-key: <api-key>'
{
  "error": false,
  "data": {
    "id": "<string>",
    "name": "<string>",
    "isPublic": true,
    "schema": [
      {
        "name": "<string>",
        "description": "<string>",
        "dataType": "STRING",
        "fieldType": "SCHEMA",
        "example": "<string>",
        "isKey": true
      }
    ],
    "entity": "<string>",
    "description": {
      "hintText": "<string>"
    }
  }
}

Authorizations

​
x-api-key
string
header
required

API key for authentication

Path Parameters

​
schemaId
string
required

Schema ID

Response

200

Response wrapper for a single schema

​
error
enum<boolean>
required

Error flag (always false on success)

Available options:
true,
false
​
data
object
required

Schema data