API Reference

Get Comments

Retrieve paginated list of comments. Permission: Read Comments

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Query Params
string
Defaults to page=1

The page number for paginated results. Defaults to 1. Used to traverse the paginated response

string

The field to sort results by. Prefix with '-' for descending order (e.g., '-createdAt'). Sortable fields are indicated in each field's description. Used to sort the response in ascending or descending order of an attribute

string

Filter expression in the format: filter[field][operator]=value. See individual field descriptions for available operators. Example: filter[status][eq]=Funded. Used to filter the response on an attribute value

string

The text content of the comment. Sortable: Yes. Filter Operators: eq, ne, nn, null

string

When the comment was created. ISO 8601 datetime format. Sortable: Yes. Filter Operators: eq, gt, gte, lt, lte, ne, neq, nn, null

string

The UUID of the customer this comment belongs to. Sortable: Yes. Filter Operators: eq, neq, in, nin

string

The name of the template that generated this comment. Sortable: Yes. Filter Operators: eq, ne, neq, nn, null, se, sw

string

When the comment was last updated. ISO 8601 datetime format. Sortable: Yes. Filter Operators: eq, gt, gte, lt, lte, ne, neq, nn, null

Headers
string
required
Defaults to application/vnd.totality.v1+json

Defaults to application/vnd.totality.v1+json

string
required
Defaults to application/json

Defaults to application/json

Responses

Language
Credentials
URL
LoadingLoading…
Response
Choose an example:
application/json