Comments

List comments on a post

Retrieves a paginated list of top-level comments for a published post on a specific profile. Each top-level comment includes a flat replies array containing all nested replies sorted by creation date.

get/api/posts/{post_id}/comments

Request

  • Base URL
    https://api.postproxy.dev
  • URL
    https://api.postproxy.dev/api/posts/{post_id}/comments
  • Auth
    HTTP bearer

Query parameters

profile_group_idstring

Profile group context for the request. Optional when the API key is scoped to a profile group (that group is used automatically); with a full-access key, defaults to the first profile group in the account.

profile_idstring required

Profile ID

pageinteger

Page number (1-based). Passing 0 returns page 1.

per_pageinteger

Number of items per page.

fromstring

ISO 8601 date/time — only comments received (created_at) at or after this point. A bare date means that date's start of day. Applies to top-level comments only; a comment in range brings its full replies array. Unparseable values return 400.

tostring

ISO 8601 date/time — only comments received (created_at) at or before this point.

Response

Paginated list of top-level comments, each with a replies array. Pagination applies to top-level comments only.

totalinteger

Total number of top-level comments

pageinteger

Current page number

per_pageinteger

Items per page

Changes

No recorded changes to this operation across all 1 revision of this API.