Pre-release — content may change.

Comments

List comments

GET
/comments

A paginated list of comments across all records. Scope to a single record using the nested /people/{person_id}/comments or /organizations/{organization_id}/comments collections.

Authorization

bearerAuth
AuthorizationBearer <token>

In: header

Query Parameters

include?string

Comma-separated list of relationships to include. Allowed values are resource-specific; consult the operation for the allowlist.

sort?string

Comma-separated list of attributes to sort by. Prefix with - for descending order (-created_at,family_name).

page?

Offset pagination parameters.

filter?

Keys take the form filter[<attribute>_<predicate>]=<value>, repeatable per query.

Common predicates by attribute type:

  • String / text / uuid: eq, not_eq, cont, not_cont, matches, start, end, present, blank, null, not_null, in, not_in
  • Boolean: eq, not_eq, present, blank, null, not_null

Example: ?filter[pinned_eq]=true

fields[comments]?array<>

Sparse-fieldset selection.

Response Body

application/json

application/json

application/json

curl -X GET "https://example.com/comments"
{  "data": [    {      "type": "comments",      "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",      "attributes": {        "comment": "string",        "active": true,        "pinned": true,        "created_at": "2019-08-24T14:15:22Z",        "updated_at": "2019-08-24T14:15:22Z",        "deleted_at": "2019-08-24T14:15:22Z"      },      "relationships": {        "person": {          "data": {            "type": "people",            "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"          }        },        "commentable": {          "data": {            "type": "string",            "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"          }        }      },      "links": {        "self": "/comments/7247ad7d-9275-454b-9e3a-0570e403739e"      },      "meta": {}    }  ],  "meta": {    "page": {      "total_items": 0,      "total_pages": 0,      "number": 0,      "size": 0    }  }}
{  "errors": [    {      "status": 0,      "title": "string",      "source": {        "pointer": "string",        "parameter": "string"      },      "meta": {        "error": "string",        "field": "string"      }    }  ]}
{  "errors": [    {      "status": 0,      "title": "string",      "source": {        "pointer": "string",        "parameter": "string"      },      "meta": {        "error": "string",        "field": "string"      }    }  ]}