Get comments

GET

/comments

Get comments

Headers

Auth

AuthorizationstringRequired

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

x-monite-versionstringRequired

x-monite-entity-idstringRequired

The ID of the entity that owns the requested resource.

Query parameters

object_type"payable"Required

object_idstringRequired

order"asc" or "desc"Optional

Order by

Allowed values: ascdesc

limitintegerOptional

Max is 100

pagination_tokenstringOptional

A token, obtained from previous page. Prior over other filters

sort"id"OptionalDefaults to id

Allowed sort fields

created_at__gtdatetimeOptional

created_at__ltdatetimeOptional

created_at__gtedatetimeOptional

created_at__ltedatetimeOptional

Response

Successful Response

datalist of objects

next_pagination_tokenstringOptional

A token that can be sent in the pagination_token query parameter to get the next page of results, or null if there is no next page (i.e. you’ve reached the last page).

prev_pagination_tokenstringOptional

A token that can be sent in the pagination_token query parameter to get the previous page of results, or null if there is no previous page (i.e. you’ve reached the first page).

Errors

Create a comment

Up Next

1	curl -G https://api.sandbox.monite.com/v1/comments \
2	-H "x-monite-version: 2024-01-31" \
3	-H "x-monite-entity-id: x-monite-entity-id" \
4	-H "Authorization: Bearer <token>" \
5	-d object_type=payable \
6	-d object_id=object_id

1	{
2	"data": [
3	{
4	"id": "id",
5	"created_by_entity_user_id": "created_by_entity_user_id",
6	"entity_id": "entity_id",
7	"object_id": "object_id",
8	"object_type": "object_type",
9	"status": "active",
10	"text": "text",
11	"created_at": "2024-01-15T09:30:00Z",
12	"updated_at": "2024-01-15T09:30:00Z",
13	"reply_to_entity_user_id": "reply_to_entity_user_id"
14	}
15	],
16	"next_pagination_token": "next_pagination_token",
17	"prev_pagination_token": "prev_pagination_token"
18	}