integrations

List suggestions for an extraction code

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/{caseId}/suggest/{codeId}
Access token

Lists the configuration suggestions made for an extraction code, newest first by default, optionally filtered by status.

Headers

  • organization string Required

    id of the selected (active) organization

Path parameters

  • caseId string Required

    Id of the case

  • codeId string Required

    Id of the extraction code

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.

  • status string

    Filter suggestions by status

    Values are open, approved, rejected, or closed.

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
        • status string Required

          Values are open, approved, rejected, or closed.

        • suggestion object Required
        • previousConfig object | null Required
        • extractionCode string | null Required
        • case string | null Required
        • suggestedBy string | null Required
        • suggestedAt string(date-time) Required
        • approvedBy string | null Required
        • approvedAt string(date-time) | null Required
        • rejectedBy string | null Required
        • rejectedAt string(date-time) | null Required
        • mergedAt string(date-time) | null Required
        • messages array[object] Required
          Hide messages attributes Show messages attributes object
          • text string Required
          • date string(date-time) Required
          • user string | null Required
          • statusUpdate string | null

            Values are open, approved, rejected, or closed.

    • statusCode number Required
    • timestamp string(date-time) Required
GET /case/{caseId}/suggest/{codeId} 
curl \
 --request GET 'http://api.example.com/case/{caseId}/suggest/{codeId}' \
 --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",
        "status": "open",
        "suggestion": {
          "type": "share_all"
        },
        "previousConfig": {
          "type": "allow_client"
        },
        "extractionCode": "507f1f77bcf86cd799439012",
        "case": "507f1f77bcf86cd799439011",
        "suggestedBy": "507f1f77bcf86cd799439013",
        "suggestedAt": "2026-01-15T14:30:00.000Z",
        "approvedBy": "string",
        "approvedAt": "2026-05-04T09:42:00Z",
        "rejectedBy": "string",
        "rejectedAt": "2026-05-04T09:42:00Z",
        "mergedAt": "2026-05-04T09:42:00Z",
        "messages": [
          {
            "text": "Please include WhatsApp.",
            "date": "2026-01-15T14:35:00.000Z",
            "user": "507f1f77bcf86cd799439013",
            "statusUpdate": "open"
          }
        ]
      }
    ]
  },
  "statusCode": 200,
  "timestamp": "2026-01-15T10:15:00.000Z"
}