Bootstrap an offline-sync device session (device bearer token)

GET/api/v1/sync/bootstrap

Authorization

AuthorizationBearer token · headerrequired

Scoped API token (bnx_…). Required scopes are noted per operation.

Responses

200

Device, actor, visible matters, and selected contract version

contractVersionstringrequired

Allowed:v1

deviceobjectrequired

Show properties

idstringrequired

namestringrequired

platformstring | nullrequired

userobjectrequired

Show properties

idstringrequired

mattersobject[]required

Show properties

Array of object

idstringrequired

numberstringrequired

namestringrequired

statusstringrequired

subscribedbooleanrequired

enabledbooleanrequired

401

Unauthenticated

errorstringrequired

codestringrequired

rulestring

403

Forbidden (missing scope or permission)

errorstringrequired

codestringrequired

rulestring

429

Rate limited

errorstringrequired

codestringrequired

rulestring

Request

curl -X GET '/api/v1/sync/bootstrap' \
  -H 'Authorization: Bearer YOUR_TOKEN'

const response = await fetch("/api/v1/sync/bootstrap", {
  method: "GET",
  headers: {
    "Authorization": "Bearer YOUR_TOKEN"
  }
});

import requests

response = requests.get(
    "/api/v1/sync/bootstrap",
    headers={
        "Authorization": "Bearer YOUR_TOKEN"
    },
)

Response

{
  "contractVersion": "v1",
  "device": {
    "id": "string",
    "name": "string",
    "platform": "string"
  },
  "user": {
    "id": "string"
  },
  "matters": [
    {
      "id": "string",
      "number": "string",
      "name": "string",
      "status": "string",
      "subscribed": true,
      "enabled": true
    }
  ]
}

{
  "error": "string",
  "code": "string",
  "rule": "string"
}

{
  "error": "string",
  "code": "string",
  "rule": "string"
}

{
  "error": "string",
  "code": "string",
  "rule": "string"
}