integrations

List a case's collections

Add MCP server to your AI tool

Allow AI tools and LLMs to interact with the API documentation portal through MCP.

MCP server URL

https://docs.usehearsay.com/mcp

Standard setup for AI tools providing an mcp.json file

mcp.json 
{
  "integrations MCP server": {
    "url": "https://docs.usehearsay.com/mcp"
  }
}
Close
GET /case/collections/{caseId}
Access token

Lists the case's message collections (curated sets of messages), optionally filtered by name or archived state.

Headers

  • organization string Required

    id of the selected (active) organization

Path parameters

  • caseId string Required

    Id of the case

Query parameters

  • page number

    Default value is 1.

  • perPage number

    Default value is 10.

  • skip number

    If skip/limit not provided, page/perPage will take precedence

  • limit number

    If skip/limit not provided, page/perPage will take precedence

  • sortOrder string

    Values are asc or desc. Default value is asc.

  • name string
  • sortBy string

    Values are createdAt, updatedAt, or name. Default value is updatedAt.

  • isArchived number

    0 false, 1 true

Responses

  • 200 application/json
    Hide response attributes Show response attributes object
    • data object Required
      Hide data attributes Show data attributes object
      • total number Required
      • page number
      • perPage number
      • skip number
      • limit number
      • totalPages number Required
      • nextPage number | null Required
      • previousPage number | null Required
      • data array[object]
        Hide data attributes Show data attributes object
        • createdAt string(date-time) Required
        • updatedAt string(date-time) Required
        • id string Required
        • name string Required
        • slug string Required
        • case string | null Required
        • user string Required

          Id of the user who created the collection

        • lastUpdatedBy string | null Required
        • archivedAt string(date-time) | null Required
        • archivedBy string | null Required
    • statusCode number Required
    • timestamp string(date-time) Required
GET /case/collections/{caseId} 
curl \
 --request GET 'http://api.example.com/case/collections/{caseId}' \
 --header "Authorization: Bearer $ACCESS_TOKEN" \
 --header "organization: string"
Response examples (200) 
{
  "data": {
    "total": 42,
    "page": 1,
    "perPage": 20,
    "skip": 0,
    "limit": 20,
    "totalPages": 3,
    "nextPage": 2,
    "previousPage": 42.0,
    "data": [
      {
        "createdAt": "2026-01-15T14:30:00.000Z",
        "updatedAt": "2026-01-15T14:30:00.000Z",
        "id": "507f1f77bcf86cd799439011",
        "name": "Key messages",
        "slug": "key-messages",
        "case": "507f1f77bcf86cd799439011",
        "user": "507f1f77bcf86cd799439011",
        "lastUpdatedBy": "507f1f77bcf86cd799439011",
        "archivedAt": "2026-05-04T09:42:00Z",
        "archivedBy": "string"
      }
    ]
  },
  "statusCode": 200,
  "timestamp": "2026-01-15T10:15:00.000Z"
}