Skip to API content
TalkLabs API Docs v3
Recipes
GET Comments

Batch Get Conversation Details

The purpose of this method is to support a use case where you start with a list of conversations and you want metadata about only those conversations so you can display things l…

GET /api/v3/{appid}/comment/conversations/details/batch

The purpose of this method is to support a use case where you start with a list of conversations and you want metadata about only those conversations so you can display things like like count or comment count making minimal requests.

You can choose to either retrieve articles using the SportsTalk Conversation ID or by using your custom IDs you associated with the conversation using our create/update conversation API.

The API will return a JSON document containing a list of child objects each containing the requested metadata (see entities property).

URL PARAMETERS

  • ids: (optional): Include one or more comma delimited Sportstalk conversation IDs.

  • cid: (optional): Include one or more cid arguments. Each is a URL ENCODED string containing the customid. You can specify up to 200 at a time.

  • entities (optional): By default only the conversation object data is returned. For more data (and deeper queries) provide any of these entities:

    • reactions: Includes user reactions and microprofiles in the response

    • likecount: Includes number of likes on the conversation in the response, otherwise returns -1 for like count.

    • commentcount: Includes the number of comments in the response, otherwise returns -1 for comment count.

Request

Parameters

Values in the path and query string.

appid path
string TalkLabs ID required

The TalkLabs application ID assigned to your account.

Example: your-app-id
propertyid query
string
ids query
string
cid query
string[]
Entities query
string
Response

Status codes

Every JSON response uses the API result envelope.

200 OK ApiResult
400 Bad Request ApiResult
403 Forbidden ApiResult
404 Not Found ApiResult
500 Internal Server Error ApiResult
Example response · 200
{
  "message": "Success",
  "errors": {},
  "data": {
    "kind": "list.commentconversations",
    "conversations": [
      {
        "kind": "comment.conversation",
        "appid": "67ce162f5b142e45a0ea5ff7",
        "owneruserid": "",
        "conversationid": "api-conversation-demo1",
        "property": "sportstalk247.com/demo",
        "moderation": "post",
        "maxreports": 0,
        "enableprofanityfilter": true,
        "title": "Sample Conversation",
        "maxcommentlen": 512,
        "commentcount": 5,
        "replycount": -1,
        "reactions": [],
        "reactioncount": 0,
        "likecount": 0,
        "open": true,
        "added": "2025-03-09T23:38:02.724963Z",
        "whenmodified": "2025-03-09T23:38:02.7250116Z",
        "customtype": "",
        "customid": "/articles/2020-03-01/article1/something-very-important-happened",
        "customtags": [
          "taga",
          "tagb"
        ],
        "custompayload": "{ num : 0 }",
        "customfield1": "/sample/userdefined1/emojis/😂🤣❤😍😒",
        "customfield2": "/sample/userdefined2/intl/characters/äöüÄÖÜß"
      }
    ]
  }
}
Search all 118 endpoints Try “join room”, “moderate”, or “POST”.
Request environment

Connect your application

These values fill request examples and the API console. They stay in this browser tab and are never sent to TalkLabs until you run a request.

Credentials are stored in sessionStorage, not in cookies or analytics.