collections

List collections in project

List all collections in a project. Accepts BearerToken (JWT) or ApiKeyAuth (X-API-Key).

GET/api/schemas/projects/{projectId}/collections

Authentication

Requires JWT

Note

Include your JWT in the Authorization: Bearer YOUR_TOKEN header (user-facing apps, RBAC). View authentication guide →

Path Parameters

Name	Type	Required	Description
`projectId`	string	Yes	Project ID.

SDK setup

Create a client and set credentials (JWT and/or API key) before calling the API. Match the authentication type shown above.

import { MudbaseClient } from "mudbase";

const client = new MudbaseClient();
client.setJWT("eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiJ1c3JfbW9yZ2FuX2RlIiwiZW1haWwiOiJtb3JnYW4uY2hlbkBub3J0aHdpbmQuZGV2IiwiZXhwIjoxODI1MTI5NjAwfQ.doc_preview_sig");
import { MudbaseClient } from "mudbase";

const client = new MudbaseClient();
client.setJWT("eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiJ1c3JfbW9yZ2FuX2RlIiwiZW1haWwiOiJtb3JnYW4uY2hlbkBub3J0aHdpbmQuZGV2IiwiZXhwIjoxODI1MTI5NjAwfQ.doc_preview_sig");

Example request

Call this endpoint using the client from SDK setup. Use View HTTP for a raw cURL example.

const result = await client.collections.list({
  projectId: "proj_WfEVomh3qBHR"
});
const result = await client.collections.list({
  projectId: "proj_WfEVomh3qBHR"
});

Try It Live

Test this endpoint with your own credentials. Your requests will be sent to the live API.

JWT Bearer Token Use the auth endpoints to obtain a JWT.

Path Parameters

projectId

No Request Yet

Send a request to see the full inspector

Responses

200Collections list

json

{
  "collections": [
    {
      "_id": "685ada8fd9416ac02f171abf",
      "name": "users",
      "slug": "users",
      "project": "685ad30be129932fbb7a1047",
      "fields": [
        {
          "name": "email",
          "type": "email",
          "required": true,
          "unique": true
        },
        {
          "name": "firstName",
          "type": "string",
          "required": true
        },
        {
          "name": "lastName",
          "type": "string",
          "required": true
        }
      ],
      "createdAt": "2024-01-15T10:00:00.000Z"
    },
    {
      "_id": "685ada8fd9416ac02f171ac0",
      "name": "products",
      "slug": "products",
      "project": "685ad30be129932fbb7a1047",
      "fields": [
        {
          "name": "name",
          "type": "string",
          "required": true
        },
        {
          "name": "price",
          "type": "number",
          "required": true
        }
      ],
      "createdAt": "2024-01-15T11:00:00.000Z"
    }
  ],
  "total": 2
}
{
  "collections": [
    {
      "_id": "685ada8fd9416ac02f171abf",
      "name": "users",
      "slug": "users",
      "project": "685ad30be129932fbb7a1047",
      "fields": [
        {
          "name": "email",
          "type": "email",
          "required": true,
          "unique": true
        },
        {
          "name": "firstName",
          "type": "string",
          "required": true
        },
        {
          "name": "lastName",
          "type": "string",
          "required": true
        }
      ],
      "createdAt": "2024-01-15T10:00:00.000Z"
    },
    {
      "_id": "685ada8fd9416ac02f171ac0",
      "name": "products",
      "slug": "products",
      "project": "685ad30be129932fbb7a1047",
      "fields": [
        {
          "name": "name",
          "type": "string",
          "required": true
        },
        {
          "name": "price",
          "type": "number",
          "required": true
        }
      ],
      "createdAt": "2024-01-15T11:00:00.000Z"
    }
  ],
  "total": 2
}

401Authentication required or invalid token.

403Access denied or insufficient permissions.

Errors

Code	Meaning
`401`	Authentication required or invalid token.
`403`	Access denied or insufficient permissions.

Run in Postman Download OpenAPI

Next steps

Edit this page on GitHub