Skip to main content
GET
/
api
/
v1
/
comments
List
curl --request GET \
  --url https://api.main.apexscore.ai/api/v1/comments/ \
  --header 'Authorization: Bearer <token>'
{
  "count": 123,
  "results": [
    {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "content_type": "<string>",
      "commenter": {
        "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "full_name": "<string>",
        "email": "[email protected]",
        "first_name": "<string>",
        "last_name": "<string>"
      },
      "created_at": "2023-11-07T05:31:56Z",
      "updated_at": "2023-11-07T05:31:56Z",
      "object_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "tag": "<string>",
      "text": "<string>",
      "parent": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
    }
  ],
  "next": "http://api.example.org/accounts/?page=4",
  "previous": "http://api.example.org/accounts/?page=2"
}

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Query Parameters

​
content_type
enum<string>
required

The object type to retrieve comments for.

Available options:
datasetconfiguration,
report,
report_attitude
​
object_id
string<uuid>
required

The id of the object of content_type to retrieve comments for.

​
ordering
enum<string>

Which field to use when ordering the results.

Available options:
-created_at,
created_at
​
page
integer

A page number within the paginated result set.

​
page_size
integer

Number of results to return per page.

​
tag
string

The tag to filter results to (if any)

Response

200 - application/json
​
count
integer
required
Example:

123

​
results
object[]
required
​
next
string<uri> | null
Example:

"http://api.example.org/accounts/?page=4"

​
previous
string<uri> | null
Example:

"http://api.example.org/accounts/?page=2"