---
title: "Onboarding background-research readiness"
method: GET
path: "/v1/onboarding-readiness"
tags: ["onboarding"]
---

# Onboarding background-research readiness

`GET /v1/onboarding-readiness`

## Request

- Base URL: `https://api.patricia.app` (the document declares no server; this is the origin it was published from)
- URL: `https://api.patricia.app/v1/onboarding-readiness`
- Auth: HTTP bearer

Tenant-scoped answer to whether the caller's own person-signals read (calendar or Gmail) is still running. Requires `tenant:read`.

## Headers

- `X-Tenant-Id` string, nullable

## Response `200`

Successful Response

- OnboardingReadinessResponse: Whether the person research kicked off during setup is still running. Read by the wizard's finish screen, which says so instead of silently claiming the research is done.
  - `still_reading` boolean, required: True while the caller's own person-signals read (calendar or Gmail) has started and not yet finished.

## Other responses

- `400`: Bad request
- `401`: Unauthorized
- `403`: Forbidden. Inspect response body `code` for the specific reason (for example: PERMISSION_DENIED, EMAIL_NOT_VERIFIED, TENANT_ACCESS_REQUIRED, ROLE_UNRESOLVED)
- `404`: Not found
- `422`: Validation error

---

[API](https://skmtc.dev/patricia/apis/patricia-api.md) · [All operations](https://skmtc.dev/patricia/apis/patricia-api/llms.txt) · [OpenAPI document](https://skmtc.dev/patricia/apis/patricia-api/revisions/0dfb44495ea1?raw)