chat

Get chat details

Returns full chat metadata including participants and roles for a single chat.

GET/api/chat/projects/{projectId}/chats/{chatId}

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.
`chatId`	string	Yes	Chat 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.chat.get({
  projectId: "proj_5HElkFTBatzP",
  chatId: "YpHRLLlYvQFw4huR"
});
const result = await client.chat.get({
  projectId: "proj_5HElkFTBatzP",
  chatId: "YpHRLLlYvQFw4huR"
});

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

chatId

No Request Yet

Send a request to see the full inspector

Responses

200Chat details

json

{
  "success": true,
  "data": {
    "_id": "65a1b2c3d4e5f6789012345f",
    "name": "Team Chat",
    "type": "group",
    "participants": [
      {
        "userId": "685acbe0e129932fbb7a0fc2",
        "role": "admin"
      }
    ],
    "createdAt": "2024-01-15T10:00:00.000Z"
  }
}
{
  "success": true,
  "data": {
    "_id": "65a1b2c3d4e5f6789012345f",
    "name": "Team Chat",
    "type": "group",
    "participants": [
      {
        "userId": "685acbe0e129932fbb7a0fc2",
        "role": "admin"
      }
    ],
    "createdAt": "2024-01-15T10:00:00.000Z"
  }
}

401Authentication required or invalid token.

404Project or chat not found (exact backend message).

Errors

Code	Meaning
`401`	Authentication required or invalid token.
`404`	Project or chat not found (exact backend message).

Run in Postman Download OpenAPI

Next steps

Edit this page on GitHub