Skip to main content
GET
/
api
/
v1
/
ops
/
support-cases
/
{supportCaseId}
/
messages
List Support Case Messages
curl --request GET \
  --url https://api.example.com/api/v1/ops/support-cases/{supportCaseId}/messages \
  --header 'Authorization: Bearer <token>'
{
  "data": [
    {
      "supportCaseMessageId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "supportCaseId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "senderUserId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "body": "<string>",
      "readAt": "2023-11-07T05:31:56Z",
      "createdAt": "2023-11-07T05:31:56Z",
      "updatedAt": "2023-11-07T05:31:56Z",
      "deletedAt": "2023-11-07T05:31:56Z"
    }
  ],
  "meta": {
    "page": 1,
    "limit": 20,
    "total": 125,
    "totalPages": 7
  }
}

Authorizations

Authorization
string
header
required

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

Path Parameters

supportCaseId
string<uuid>
required

Support case identifier

Example:

"0195e7a1-8b5c-7d3e-9f4a-2c6b8d0e1f3a"

Query Parameters

limit
number
default:10

Items per page

Required range: 1 <= x <= 100
Example:

10

page
number
default:1

Page number

Required range: x >= 1
Example:

1

sortBy
enum<string>
default:createdAt

Field to sort by

Available options:
createdAt
Example:

"createdAt"

sortOrder
enum<string>
default:desc

Sort order

Available options:
asc,
desc
Example:

"desc"

fields
string

Comma-separated list of fields to include in the response. Supports dot notation for nested projection (e.g. id,name,user.email,trips.route.id). Unknown fields are silently dropped.

Response

OK

data
object[]
required
meta
object
required

Pagination metadata