Skip to content

Get Comments

Retrieve comments associated with an artist or a specific post, with support for pagination.

Endpoint

GET https://api.recoupable.com/api/comments

Parameters

NameTypeRequiredDescription
artist_account_idstringYesThe unique identifier of the artist account
post_idstringNoFilter comments by specific post
pagenumberNoPage number for pagination (default: 1)
limitnumberNoNumber of comments per page (default: 10)

Request Examples

cURL
curl -X GET "https://api.recoupable.com/api/comments?artist_account_id=YOUR_ARTIST_ID&page=1&limit=10" \
  -H "Content-Type: application/json"
  # -H "Authorization: Bearer YOUR_API_KEY" # Coming soon

Response Format

The API returns JSON responses. Here's an example success response:

{
  "status": "success",
  "comments": [
    {
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "post_id": "123e4567-e89b-12d3-a456-426614174001",
      "social_id": "123e4567-e89b-12d3-a456-426614174002",
      "comment": "Great post!",
      "commented_at": "2024-03-27T12:00:00Z"
    }
  ],
  "pagination": {
    "total_count": 48,
    "page": 1,
    "limit": 10,
    "total_pages": 5
  }
}

Response Properties

Response Object

PropertyTypeDescription
statusstringStatus of the request ("success" or "error")
commentsarrayList of comment objects
comments[].idstringUUID of the comment
comments[].post_idstringUUID of the associated post
comments[].social_idstringUUID of the social profile
comments[].commentstringComment text content
comments[].commented_atstringTimestamp with timezone of when the comment was made
paginationobjectPagination information
pagination.total_countnumberTotal number of comments available
pagination.pagenumberCurrent page number
pagination.limitnumberNumber of comments per page
pagination.total_pagesnumberTotal number of pages available