Get comments

get

https://tenants-gateway-api-sbx.sidedrawersbx.com/api/v1/tenants/comments/tenant/tenant-id/{tenantId}/comments

Retrieves Comments.

Path Params

tenantId

string

required

Tenant identifier.

Query Params

limit

string

Limit. Default value is 20.

startingAfter

string

Starting after is an object ID that defines your place in the list.

endingBefore

string

Object identifier that defines your place in the list.

entityId

string

Identifier of the resource to comment on.

entity

string

enum

Type of resource to comment on.

parentEntityId

string

Parent entity identifier. Required to comment on Info Request items.

sort

string

enum

Sort.

Allowed:

isUrgent

boolean

Is urgent.

replyToCommentId

string

Identifier of the comment to which to reply.

displayInactive

boolean

Display inactive comments.

Response

200

The given comments.

Language

Credentials

Bearer

JWT

Loading…

Response

Click Try It! to start a request and see the response here!