List API Documents in a namespace

List API documents in a namespace.

OAuth scopes

platform:read

Path Parameters

namespace
Type: string
required

Responses

application/json
application/json
application/json
application/json
application/json
application/json
application/json

get/v1/apis/{namespace}

import Scalar from '@scalar/sdk';

const client = new Scalar({
  bearerAuth: process.env['BEARER_AUTH'], // defaults to the BEARER_AUTH env var
});

const registry = await client.registry.listAPIDocuments('acme');

console.log(registry);

Show Schema

[
  {
    "uid": "UakgbKJ5m9gl0JDMbcJqL",
    "version": "1.2.0",
    "title": "Acme API",
    "slug": "acme-api",
    "description": "API for managing Acme products and orders.",
    "namespace": "acme",
    "isPrivate": false,
    "tags": [
      "products",
      "orders"
    ],
    "versions": [
      {
        "uid": "UakgbKJ5m9gl0JDMbcJqL",
        "createdAt": 1735689600000,
        "version": "1.2.0",
        "upgraded": false,
        "endpointCount": 12,
        "embedStatus": "complete",
        "tags": [
          "products",
          "orders"
        ],
        "tools": [
          {
            "path": "/products",
            "method": "string",
            "enabledTools": [
              "execute-request"
            ]
          }
        ],
        "yamlSha": "abcdef0123456789abcdef0123456789abcdef0123456789abcdef0123456789",
        "jsonSha": "0123456789abcdef0123456789abcdef0123456789abcdef0123456789abcdef"
      }
    ]
  }
]

Default Response

List all API Documents

Create API Document

The API company.