Sign in

v1

latestOpenAPI 3.0.0Apache 2.0 License2026-07-1424171133.3 KB

Returns comments for a designated case.

post/v1/cases/{caseId}/list-comments

Path parameters

caseIdstring required

Required element for ListComments to designate the case to query.

Request body

nextTokenstring

An optional string that, if supplied, must be copied from the output of a previous call to ListComments. When provided in this manner, the API fetches the next page of results.

maxResultsinteger

Optional element for ListComments to limit the number of responses.

Response

Success

nextTokenstring

An optional string that, if supplied on subsequent calls to ListComments, allows the API to fetch the next page of results.

totalinteger

Response element for ListComments identifying the number of responses.