View a case
curl --request POST \
--url https://api.platform.arb.inc/cases/view \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"caseID": "2025-08-00139"
}
'{
"overview": {
"id": "2025-08-00139",
"created": "2025-08-23T02:47:42Z",
"updated": "2025-08-23T02:47:42Z",
"createdByUserID": "00c573fd-18d9-4fbe-921e-6926d2c4869e",
"createdByOrgID": null,
"phaseID": "caseInitiation",
"title": "Case 2025-08-00139",
"claimantName": "Acme Inc",
"respondentName": "Mike Smith",
"canSubmitEvidence": true
},
"participants": [
{
"created": "2025-08-23T02:47:42Z",
"userID": "00c573fd-18d9-4fbe-921e-6926d2c4869e",
"organizationID": null,
"firstName": "Owen",
"lastName": "Smith",
"partyID": "claimant",
"isPrimary": true,
"isObserver": false
},
{
"created": "2025-08-23T02:48:01Z",
"userID": "df25d20f-8042-44e2-97af-3609659c56a3",
"firstName": "Kyle",
"lastName": "Taskman",
"organizationID": null,
"partyID": "caseManager",
"isPrimary": true,
"isObserver": false
}
],
"partyID": "claimant",
"timetable": {
"phases": [
{
"id": "caseInitiation",
"scheduledStart": "2025-08-23T02:47:42.123816Z",
"scheduledEnd": null,
"filingDeadline": "2025-09-23T02:47:42.123816Z",
"documents": [
{
"id": "statementOfClaim",
"filedBy": "claimant",
"approvedBy": "caseManager",
"maxAllowed": 1,
"required": true
},
{
"id": "noticeOfArbitration",
"filedBy": "caseManager",
"approvedBy": null,
"maxAllowed": 1,
"required": true
}
]
}
]
},
"settlement": {
"type": "object",
"description": "(Optional) Settlement details, including contact and financial terms.",
"properties": {
"phone": {
"type": "string",
"description": "(Optional) Contact phone number for settlement-related communication.",
"example": "+15555555555"
},
"email": {
"type": "string",
"format": "email",
"description": "(Optional) Contact email address for settlement-related communication.",
"example": "settle@example.com"
},
"website": {
"type": "string",
"format": "uri",
"description": "(Optional) Website or portal link for settlement information.",
"example": "https://example.com?ref=12345"
},
"amount": {
"type": "string",
"description": "(Optional) Total amount the claimant believes the respondent owes.",
"example": "$1000.00"
},
"offer": {
"type": "string",
"description": "(Optional) Settlement amount the claimant is willing to accept right now.",
"example": "$750"
},
"validForDays": {
"type": "integer",
"description": "(Optional) Number of days the settlement offer will remain valid.",
"example": 7
}
}
}
}cases
View a case
Returns a simple snapshot of a case the user can access.
POST
/
cases
/
view
View a case
curl --request POST \
--url https://api.platform.arb.inc/cases/view \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"caseID": "2025-08-00139"
}
'{
"overview": {
"id": "2025-08-00139",
"created": "2025-08-23T02:47:42Z",
"updated": "2025-08-23T02:47:42Z",
"createdByUserID": "00c573fd-18d9-4fbe-921e-6926d2c4869e",
"createdByOrgID": null,
"phaseID": "caseInitiation",
"title": "Case 2025-08-00139",
"claimantName": "Acme Inc",
"respondentName": "Mike Smith",
"canSubmitEvidence": true
},
"participants": [
{
"created": "2025-08-23T02:47:42Z",
"userID": "00c573fd-18d9-4fbe-921e-6926d2c4869e",
"organizationID": null,
"firstName": "Owen",
"lastName": "Smith",
"partyID": "claimant",
"isPrimary": true,
"isObserver": false
},
{
"created": "2025-08-23T02:48:01Z",
"userID": "df25d20f-8042-44e2-97af-3609659c56a3",
"firstName": "Kyle",
"lastName": "Taskman",
"organizationID": null,
"partyID": "caseManager",
"isPrimary": true,
"isObserver": false
}
],
"partyID": "claimant",
"timetable": {
"phases": [
{
"id": "caseInitiation",
"scheduledStart": "2025-08-23T02:47:42.123816Z",
"scheduledEnd": null,
"filingDeadline": "2025-09-23T02:47:42.123816Z",
"documents": [
{
"id": "statementOfClaim",
"filedBy": "claimant",
"approvedBy": "caseManager",
"maxAllowed": 1,
"required": true
},
{
"id": "noticeOfArbitration",
"filedBy": "caseManager",
"approvedBy": null,
"maxAllowed": 1,
"required": true
}
]
}
]
},
"settlement": {
"type": "object",
"description": "(Optional) Settlement details, including contact and financial terms.",
"properties": {
"phone": {
"type": "string",
"description": "(Optional) Contact phone number for settlement-related communication.",
"example": "+15555555555"
},
"email": {
"type": "string",
"format": "email",
"description": "(Optional) Contact email address for settlement-related communication.",
"example": "settle@example.com"
},
"website": {
"type": "string",
"format": "uri",
"description": "(Optional) Website or portal link for settlement information.",
"example": "https://example.com?ref=12345"
},
"amount": {
"type": "string",
"description": "(Optional) Total amount the claimant believes the respondent owes.",
"example": "$1000.00"
},
"offer": {
"type": "string",
"description": "(Optional) Settlement amount the claimant is willing to accept right now.",
"example": "$750"
},
"validForDays": {
"type": "integer",
"description": "(Optional) Number of days the settlement offer will remain valid.",
"example": 7
}
}
}
}Authorizations
access token
Body
application/json
The identifier of the case to view.
Example:
"2025-08-00139"
Response
Case overview, participants, and timetable.
Show child attributes
Show child attributes
List of case participants.
Show child attributes
Show child attributes
Users party in the case.
Example:
"claimant"
Case timetable details.
Show child attributes
Show child attributes
(Optional) Contact details for settlement-related communication.
Show child attributes
Show child attributes
⌘I