Skip to main content

Get Case Details

Request

Retrieves detailed information for a case using its case or order number. The response includes the current status, contacts, notes, attachments, related products and other case-specific details.

Security
BearerAuth
Path
idstring, [ 8 .. 100 ] characters(CaseOrOrderNumber)required

Case or Order Number.

Example:11150929
Examples:
Case number
11150929
Order number
1-204976070710
Payload
// No request payload

Responses

OK

Bodyapplication/json
idstring, [ 8 .. 100 ] characters(CaseOrOrderNumber)

Unique identifier used to retrieve a case, provided as either the case number or the order number.

Example:"11150929"
accountNumberstring, [ 6 .. 100 ] characters(AccountNumber)

User account number.

Example:"182389736"
accountNamestring(AccountName)

User account name.

Example:"VjT Existing Reseller New BA"
customerReferenceIdstring

Additional information for customer to reference.

Example:"EESkFTupLmnF6KinbARfNgWAC2V1BZbDZKluF5TI5YVTXTfGkF"
channelstring

Channel through which the case was created.

Enum:"OFFLINE""PORTAL"
Example:"PORTAL"
orderIdstring, [ 14 .. 100 ] characters(OrderNumber)

Unique identifier assigned to an order, used to retrieve or reference the case associated with it.

Example:"1-204976070710"
locationobject

Location details of the case.

statusstring(StatusResponse)

Case status.

Enum:"SUBMITTED""IN_PROGRESS""RESOLVED""ACTION_REQUIRED""CLOSED""CANCELLED"
Example:"IN_PROGRESS"
contactsArray of objects(ContactResponse)

List of individuals associated with the case who are contacted regarding it.

notesArray of objects

Notes added to the case.

attachmentsArray of objects, [ 0 .. 5 ] items(Attachments)

File(s) attached to the case. e.g. picture of broken device, scanning of a bill or charge, etc...

emailArray of objects, >= 0 items(Emails)

Email conversation(s) attached to the case. e.g. email conversation with a technician, email conversation with a customer, etc...

createdDateTimestring, (date-time)(Datetime)

A datetime string with format YYYY-MM-DDTHH:mm:ss.sssZ.

Example:"2023-08-29T04:01:43.000Z"
otherDetailsobject

Additional details of the case, such as category, status history and product line items.

Response
{ "id": "11150929", "accountNumber": "182389736", "accountName": "VjT Existing Reseller New BA", "customerReferenceId": "CustomerReference001", "channel": "PORTAL", "orderId": "1-204976070710", "location": { "ibx": [ … ] }, "status": "IN_PROGRESS", "contacts": [ { … } ], "notes": [ { … } ], "attachments": [ { … } ], "email": [ { … } ], "createdDateTime": "2023-08-29T04:01:43.000Z", "otherDetails": { "recordType": "ECM", "subChannel": "ECP", "category": "Trouble Services", "subCategory": "Incident", "description": "Sample description.", "updatedDateTime": "2023-08-29T04:01:43.000Z", "statusHistory": [ … ], "modifiable": false, "reOpen": false, "cancellable": true, "respond": true } }
Was this page helpful?