Skip to main content
GET
/
api
/
rooms
/
{roomCode}
Read the room (public)
curl --request GET \
  --url https://signsealship.com/api/rooms/{roomCode}
const options = {method: 'GET'};

fetch('https://signsealship.com/api/rooms/{roomCode}', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));
import requests

url = "https://signsealship.com/api/rooms/{roomCode}"

response = requests.get(url)

print(response.text)
{
  "roomCode": "<string>",
  "name": "<string>",
  "reference": "<string>",
  "status": "open",
  "partnerName": "<string>",
  "branding": {
    "brandName": "<string>",
    "accentColor": "<string>",
    "logoUrl": "<string>"
  },
  "progress": {
    "total": 123,
    "signed": 123,
    "sealed": 123,
    "delivered": 123
  },
  "orders": [
    {
      "orderCode": "<string>",
      "label": "<string>",
      "status": "<string>",
      "services": {
        "sign": true,
        "notarize": true,
        "ship": true
      },
      "signers": [
        {
          "email": "<string>",
          "name": "<string>",
          "routingOrder": 123,
          "signed": true
        }
      ],
      "verifyCode": "<string>",
      "trackingNumber": "<string>",
      "carrier": "<string>",
      "attachedAt": "2023-11-07T05:31:56Z"
    }
  ],
  "activity": [
    {
      "orderCode": "<string>",
      "fromStatus": "<string>",
      "toStatus": "<string>",
      "occurredAt": "2023-11-07T05:31:56Z"
    }
  ],
  "passport": {
    "version": 123,
    "verifyCode": "<string>",
    "createdAt": "2023-11-07T05:31:56Z"
  },
  "createdAt": "2023-11-07T05:31:56Z",
  "updatedAt": "2023-11-07T05:31:56Z"
}

Path Parameters

roomCode
string
required

The room's bearer code (40 lowercase hex characters; the read endpoint accepts 24–64).

Response

The live room view.

roomCode
string
name
string
reference
string | null
status
string
Example:

"open"

partnerName
string
branding
object | null
progress
object
orders
object[]
activity
object[]
passport
object | null
createdAt
string<date-time>
updatedAt
string<date-time>