getv1ApisNamespace

List all APIs

​

Get a list of all documents for the namespace

Path Parameters
  • namespace
    Type: string
    required
Responses
  • 200
    Type: array object[]

    Default Response

    • description
      Type: string
      default: 
      ""
    • isPrivate
      Type: boolean
      default: 
      false
    • namespace
      Type: string
      min length:  
      3
      max length:  
      50       Pattern: ^[a-zA-Z0-9-_]+$
      required
    • slug
      Type: string
      min length:  
      3
      max length:  
      60       Pattern: ^[a-z](?:[a-z0-9-]*[a-z0-9])?$
      default: 
      "felicitous-crystal-ctkqos6"
    • tags
      Type: array string[] …100 unique!
      default: 
      []
    • title
      Type: string
      max length:  
      100
      default: 
      ""
    • uid
      Type: string
      min length:  
      5
      default: 
      "CiyS1tx4Woh7xpHKxsUiL"
    • version
      Type: string Pattern: ^(0|[1-9]\d*)\.(0|[1-9]\d*)\.(0|[1-9]\d*)(?:-((?:0|[1-9]\d*|\d*[a-zA-Z-][0-9a-zA-Z-]*)(?:\.(?:0|[1-9]\d*|\d*[a-zA-Z-][0-9a-zA-Z-]*))*))?(?:\+([0-9a-zA-Z-]+(?:\.[0-9a-zA-Z-]+)*))?$
      required
    • versions
      Type: array object[]
      required
  • 400
    Type: object
    • code
      Type: string
      required
    • message
      Type: string
      required
  • 401
    Type: object
    • code
      Type: string
      required
    • message
      Type: string
      required
  • 403
    Type: object
    • code
      Type: string
      required
    • message
      Type: string
      required
  • 404
    Type: object
    • code
      Type: string
      required
    • message
      Type: string
      required
  • 422
    Type: object
    • code
      Type: string
      required
    • message
      Type: string
      required
  • 500
    Type: object
    • code
      Type: string
      required
    • message
      Type: string
      required
Request Example for get/v1/apis/{namespace}
import { Scalar } from "@scalar/sdk";

const scalar = new Scalar({
  bearerAuth: "<YOUR_BEARER_TOKEN_HERE>",
});

async function run() {
  const result = await scalar.apiDocs.getv1ApisNamespace({
    namespace: "<value>",
  });

  console.log(result);
}

run();

[
  {
    "uid": "CiyS1tx4Woh7xpHKxsUiL",
    "version": "string",
    "title": "",
    "slug": "felicitous-crystal-ctkqos6",
    "description": "",
    "namespace": "string",
    "isPrivate": false,
    "tags": [],
    "versions": [
      {
        "uid": "string",
        "createdAt": 1,
        "version": "string",
        "upgraded": false,
        "embedStatus": null,
        "tags": []
      }
    ]
  }
]

Default Response