View a case using an invite code

curl --request POST \
  --url https://cases.platform.arb.inc/invites/case/view \
  --header 'Content-Type: application/json' \
  --data '
{
  "code": "ab12cd34ef"
}
'

{
  "overview": {
    "id": "2025-09-00123",
    "created": "2025-08-21T14:07:12Z",
    "title": "Smith v. Acme Corp.",
    "claimantName": "Jordan Smith",
    "respondentName": "Acme Corporation"
  },
  "settlement": {
    "phone": "+1-555-0102",
    "email": "[email protected]",
    "website": "https://settle.example.com/case/c17c3433",
    "amount": "2500.00",
    "offer": "1800.00",
    "validForDays": 14
  },
  "docketEntries": [
    {
      "entryID": "1",
      "enteredAt": "2025-08-22T09:15:00Z",
      "documentID": "statementOfClaim",
      "partyID": "claimant",
      "title": "Statement of Claim"
    }
  ],
  "evidence": [
    {
      "exhibitID": "5",
      "created": "2025-08-23T11:22:33Z",
      "categoryID": "image",
      "partyID": "claimant",
      "description": "Screenshot of invoice #INV-4452",
      "contentType": "image/png"
    }
  ]
}

POST

invites

case

view

View a case using an invite code

curl --request POST \
  --url https://cases.platform.arb.inc/invites/case/view \
  --header 'Content-Type: application/json' \
  --data '
{
  "code": "ab12cd34ef"
}
'

{
  "overview": {
    "id": "2025-09-00123",
    "created": "2025-08-21T14:07:12Z",
    "title": "Smith v. Acme Corp.",
    "claimantName": "Jordan Smith",
    "respondentName": "Acme Corporation"
  },
  "settlement": {
    "phone": "+1-555-0102",
    "email": "[email protected]",
    "website": "https://settle.example.com/case/c17c3433",
    "amount": "2500.00",
    "offer": "1800.00",
    "validForDays": 14
  },
  "docketEntries": [
    {
      "entryID": "1",
      "enteredAt": "2025-08-22T09:15:00Z",
      "documentID": "statementOfClaim",
      "partyID": "claimant",
      "title": "Statement of Claim"
    }
  ],
  "evidence": [
    {
      "exhibitID": "5",
      "created": "2025-08-23T11:22:33Z",
      "categoryID": "image",
      "partyID": "claimant",
      "description": "Screenshot of invoice #INV-4452",
      "contentType": "image/png"
    }
  ]
}

Body

application/json

code

string

required

The invite code from the link or message.

Example:

"ab12cd34ef"

Response

Case found and returned.

overview

object

Show child attributes

overview.id

string

Unique identifier for the case.

Example:

"2025-09-00123"

overview.created

string<date-time>

When the case was created.

Example:

"2025-08-21T14:07:12Z"

overview.title

string

Simple title for the case.

Example:

"Smith v. Acme Corp."

overview.claimantName

string | null

Name of the claimant if known.

Example:

"Jordan Smith"

overview.respondentName

string | null

Name of the respondent if known.

Example:

"Acme Corporation"

settlement

object

Show child attributes

settlement.phone

string

Contact phone for settlement.

Example:

"+1-555-0102"

settlement.email

string<email>

Contact email for settlement.

Example:

"[email protected]"

settlement.website

string<uri>

Website or portal for settlement info.

Example:

"https://settle.example.com/case/c17c3433"

settlement.amount

string

Amount the claimant says is owed.

Example:

"2500.00"

settlement.offer

string

Current settlement offer.

Example:

"1800.00"

settlement.validForDays

integer

Days the offer stays valid.

Example:

14

docketEntries

object[]

Show child attributes

docketEntries.entryID

string

ID for this docket entry.

Example:

"5"

docketEntries.enteredAt

string<date-time>

When the entry was filed.

Example:

"2025-08-22T09:15:00Z"

docketEntries.documentID

string

Type of document.

Example:

"statementOfClaim"

docketEntries.partyID

string

Party role tied to the entry.

Example:

"claimant"

docketEntries.title

string

Short title for the entry.

Example:

"Statement of Claim"

evidence

object[]

Show child attributes

evidence.created

string<date-time>

When the evidence was submitted.

Example:

"2025-08-23T11:22:33Z"

evidence.exhibitID

string

Exhibit identifier in the docket.

Example:

"4"

evidence.categoryID

string

Evidence category.

Example:

"image"

evidence.partyID

string

Party linked to the evidence.

Example:

"claimant"

evidence.description

string

Text description of the evidence.

Example:

"Screenshot of invoice #INV-4452"

evidence.contentType

string

MIME type of the file.

Example:

"image/png"

Accept an invite to a case Get a temporary PDF download link

⌘I

Documentation

Authentication

Cases

AI

Arbitrators

Alerts

Dev Tools

Emails

PDFs

Postal

Profiles

Roster

Rules

Webhooks

Zip

View a case using an invite code

Body

Response