SCscalar
schemas

Changed on

Get a list of all schemas for the namespace

get/schemas/{namespace}

Request

  • Base URL
    https://api.scalar.com/core
  • URL
    https://api.scalar.com/core/schemas/{namespace}
  • Auth
    HTTP bearer

Path parameters

namespacestring required

Response

Default Response

uidstring required
titlestring required
descriptionstring required
slugstring required
namespacestring required
isPrivateboolean required

Example response

[
  {
    "uid": "UakgbKJ5m9gl0JDMbcJqL",
    "title": "Acme API",
    "description": "API for managing Acme products and orders.",
    "slug": "acme-api",
    "namespace": "acme",
    "versions": [
      {
        "uid": "UakgbKJ5m9gl0JDMbcJqL",
        "createdAt": 1735689600,
        "updatedAt": 1735689600,
        "version": "1.2.0",
        "yamlSha": "abcdef0123456789abcdef0123456789abcdef0123456789abcdef0123456789",
        "jsonSha": "0123456789abcdef0123456789abcdef0123456789abcdef0123456789abcdef"
      }
    ]
  }
]

Changes

  • 5e4c47d6805bRevision changes
    • info

      the response's property default value unixTimestamp() was removed for the status

    • info

      the response's property default value randomManagedDocSlug() was removed for the status

    • info

      the response's property default value nanoid() was removed for the status

    • info

      the response's property default value nanoid() was removed for the status

    • info

      the response's property default value unixTimestamp() was removed for the status

  • f6130fc9c357Revision changes
    • breaking

      the / response property's minLength was decreased from 3 to 2 for the response status