Retrieve Comments for Post by ID

get

https://{hostname}/api/talk/content/v1/posts/{postId}/comments

This operation returns a paginated list of comments for a post by ID.

Authorization and Permissions

An OpenAm token is required to retrieve comments.
The user must have access to view the post to see its comments.

Pagination

This endpoint uses offset-based pagination with index and count query parameters.

Response Headers

The response includes pagination metadata in headers:

pagination-total-results: Total number of comments for this post
pagination-count: Page size used
pagination-index: Current page index
pagination-page-results: Number of results in current page

Path Params

postId

string

required

The unique identifier of the post.

Query Params

index

integer

≥ 0

The starting index for pagination (offset-based). Use this with count parameter.

count

integer

1 to 100

Defaults to 20

The number of comments to retrieve per page. Maximum is 100, default is 20.

sort

string

enum

Sort order for comments. Prefix with '-' for descending order.

Allowed:

Headers

Authorization

string

required

An OpenAm token for the user.

x-correlation-id

string

A UUID value to track the request, used for debugging and tracing.

string

enum

Defaults to application/json

Generated from available response content types

Allowed:

Responses

Language

Credentials

Bearer

JWT

URL

Loading…

Response

Choose an example:

application/json

application/problem+json

200Successfully retrieved comments for the post.

400The HTTP status code 400 Bad Request error, thrown when required parameters are not passed.

401The HTTP status code 401 Unauthorized error, thrown when the user is not authorized to access the resource.

403The HTTP status code 403 Forbidden error, thrown when the user is not authorized to access the resource.

405The HTTP status code 405 Method Not Allowed error, thrown when you attempt to call a URI with an unsupported HTTP method.

406The HTTP status code 406 Not Acceptable Content error, thrown when you send a request with accept header other than application/json.

413The HTTP status code 413 Payload Too Large error, thrown when you attempt to pass a request payload that exceeds the limit.

429The HTTP status code 429 Too Many Requests error, thrown when the user exceeds the allowed rate limit for the API.

500The HTTP status code 500 Internal Server error, thrown when the server is not able to process the request.