All onboarding records for the tenant, newest activity first.

Onboarding records

GET /v1/onboarding

cURL

curl --request GET \
  --url 'https://edi.stateset.com/v1/onboarding' \
  --header "Authorization: Bearer $STATESET_EDI_API_KEY"

200

[
  {
    "blocker": "string",
    "created_at": "2026-08-31T14:22:05Z",
    "history": [
      {
        "actor": null,
        "at": null,
        "from_stage": null,
        "note": null,
        "to_stage": null
      }
    ],
    "partner_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "stage": "connected",
    "tenant_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "updated_at": "2026-08-31T14:22:05Z"
  }
]

Response

OnboardingRecord[] — each element:

blocker · string

When set, the partner is blocked at the current stage; advancing is refused until cleared.

created_at · string (date-time) · required

history · OnboardingEvent[] · required

Show OnboardingEvent

actor · string · required

Principal that made the change (admin, partner:{id}, or a system tag).

at · string (date-time) · required

from_stage · object

note · string

to_stage · OnboardingStage · required

partner_id · string · required

stage · OnboardingStage · required

tenant_id · string · required

updated_at · string (date-time) · required

Status codes

Code	Meaning
200	Onboarding records
403	Admin credential required

cURL

curl --request GET \
  --url 'https://edi.stateset.com/v1/onboarding' \
  --header "Authorization: Bearer $STATESET_EDI_API_KEY"

200

[
  {
    "blocker": "string",
    "created_at": "2026-08-31T14:22:05Z",
    "history": [
      {
        "actor": null,
        "at": null,
        "from_stage": null,
        "note": null,
        "to_stage": null
      }
    ],
    "partner_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "stage": "connected",
    "tenant_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "updated_at": "2026-08-31T14:22:05Z"
  }
]