v1

latestOpenAPI 3.0.02026-07-2494288373.8 KB
Cases

Retrieve case's notes

Returns case's notes with comments


See also

Learn more about Cases
Learn more about Filtering, Sorting and Pagination
Learn more about Create a note

get/v1/cases/{id}/notes

Path parameters

idstring uuid required

Id of the case

Query parameters

created_atstring

Date (yyyy-MM-dd eg 2023-01-31) or date time (yyyy-MM-ddTHH:mm:ss.S+X eg 2023-01-31T13:30:00.000Z) in format ISO 8601

Filter items by the created_at.{operator} field.
You can use the eq, not_eq, gt, gte, lt and lte operators, the eq operator being the default.

updated_atstring

Date (yyyy-MM-dd eg 2023-01-31) or date time (yyyy-MM-ddTHH:mm:ss.S+X eg 2023-01-31T13:30:00.000Z) in format ISO 8601

Filter items by the updated_at.{operator} field.
You can use the eq, not_eq, gt, gte, lt and lte operators, the eq operator being the default.

sortstring

Use this parameter to sort query results.
If not specified, sorted in ascending order with values of field created_at.
Available fields are created_at and updated_at.

pagenumber

Query response is paginated.
Use this parameter to choose which page you want to display.
Page index starts at 1 (the default).

limitnumber

Query response is paginated.
Use this parameter to choose the number of items per page.
Limit defaults to 20, maximum value is 100.

Response

List of notes on the case

ℹ️ Click to see full payload

Example response

{
  "pagination": {
    "count": 42
  }
}