API REFERENCE

Get Comments

On this page

GET/api/comments

Retrieve comments associated with an artist or a specific post, with support for pagination. This endpoint returns raw comment data including the comment text, associated post, and commenter's social profile reference.

Authentication

See the authentication guide for API key and account access requirements.

Request

cURL

curl --request GET \
  --url 'https://api.recoupable.dev/api/comments?artist_account_id=YOUR_ARTIST_ACCOUNT_ID' \
  --header 'x-api-key: YOUR_API_KEY'

Replace the YOUR_ placeholders with your values. Required query parameters are included; optional parameters are listed below.

Parameters

Query parameters

artist_account_idstringrequired

The unique identifier of the artist account to fetch comments for

post_idstring

Filter comments by specific post

pageinteger

Page number for pagination (default: 1)

Default: 1

limitinteger

Number of comments per page (default: 10)

Default: 10

Responses

200Comments retrieved successfully

application/json

statusstring · enumrequired

Status of the request

Values: "success"

commentsarray<Comment>required

List of comments for the specified artist or post

Item properties

idstring

UUID of the comment

format: uuid

post_idstring

UUID of the associated post

format: uuid

social_idstring

UUID of the social profile who made the comment

format: uuid

commentstring

Comment text content

commented_atstring

Timestamp with timezone of when the comment was made

format: date-time

paginationobjectrequired

Pagination metadata for the response

Properties

total_countinteger

Total number of comments available

pageinteger

Current page number

limitinteger

Number of comments per page

total_pagesinteger

Total number of pages available

400Bad request - missing required parameters

application/json

statusstring · enumrequired

Status of the request

Values: "error"

errorstringrequired

Error message describing what went wrong

Full specification

Download the OpenAPI file for complete schemas, constraints, and examples.

Download social.json

View operation source

json

{
  "description": "Retrieve comments associated with an artist or a specific post, with support for pagination. This endpoint returns raw comment data including the comment text, associated post, and commenter's social profile reference.",
  "parameters": [
    {
      "name": "artist_account_id",
      "in": "query",
      "description": "The unique identifier of the artist account to fetch comments for",
      "required": true,
      "schema": {
        "type": "string",
        "format": "uuid"
      }
    },
    {
      "name": "post_id",
      "in": "query",
      "description": "Filter comments by specific post",
      "required": false,
      "schema": {
        "type": "string",
        "format": "uuid"
      }
    },
    {
      "name": "page",
      "in": "query",
      "description": "Page number for pagination (default: 1)",
      "required": false,
      "schema": {
        "type": "integer",
        "default": 1
      }
    },
    {
      "name": "limit",
      "in": "query",
      "description": "Number of comments per page (default: 10)",
      "required": false,
      "schema": {
        "type": "integer",
        "default": 10
      }
    }
  ],
  "responses": {
    "200": {
      "description": "Comments retrieved successfully",
      "content": {
        "application/json": {
          "schema": {
            "$ref": "#/components/schemas/CommentsResponse"
          }
        }
      }
    },
    "400": {
      "description": "Bad request - missing required parameters",
      "content": {
        "application/json": {
          "schema": {
            "$ref": "#/components/schemas/CommentsErrorResponse"
          }
        }
      }
    }
  }
}