---
title: "Get Agent Discovery"
method: GET
path: "/agent/onboarding/discovery"
tags: ["Agents"]
---

# Get Agent Discovery

`GET /agent/onboarding/discovery`

## Request

- Base URL: `https://be.graph8.com/api/v1`
- URL: `https://be.graph8.com/api/v1/agent/onboarding/discovery`
- Auth: HTTP bearer

The whole discovery record, plus an honest coverage report.

EVERY field comes back, answered or not - an unanswered one carries
`status: "open"` rather than being absent, so a caller renders a stable
list instead of one that grows as the interview proceeds.

`coverage` is the part worth reading: `open_musts` names what still blocks
a launch, `amber_fields` names the working assumptions, and `can_launch` is
the single boolean. It is not a percentage, on purpose - a framework with
silent gaps is worse than no framework, because the gaps become confident
copy three weeks later.

## Headers

- `Authorization` string, nullable
- `X-Target-Org-Id` string, nullable

## Response `200`

Successful Response

- ApiResponseOnboardingPayload
  - `data` OnboardingPayload, required: An open envelope for an onboarding or discovery result. Open on purpose. Discovery state carries a per-field coverage matrix whose field set is the product's own onboarding questionnaire - it changes as the questionnaire does, and a pinned mirror would silently DROP a field the customer had answered. On a surface whose whole job is "what do we still not know about you", a dropped field reads as an answered question.
  - `pagination` PaginationMeta
    - `page` integer, required: Current page number (1-indexed)
    - `limit` integer, required: Items per page
    - `total` integer, required: Total number of items
    - `has_next` boolean, required: Whether there are more pages
    - `next_cursor` string, nullable: Opaque cursor for the next page; null when there are no more items. Pass it back as the `cursor` query param to fetch the following page without computing page numbers.
    - `total_available` integer, nullable: Search endpoints only: how many records really match, when known. Can be larger than `total`, which is capped at the 10,000 results that can be paged. For company search this is a distinct-company estimate. Null when unknown; absent outside search.
    - `total_is_lower_bound` boolean, nullable: Search endpoints only: true when more records match than `total` shows (the result set is larger than the 10,000 results that can be paged). Absent outside search.
    - `notes` string[], nullable: Search endpoints only: plain-language notes about the result, e.g. that more records match than can be paged, or that a reversed `between` range was put in order.

## Other responses

- `422`: Validation Error

---

[API](https://skmtc.dev/graph8/apis/graph8-developer-api.md) · [All operations](https://skmtc.dev/graph8/apis/graph8-developer-api/llms.txt) · [OpenAPI document](https://skmtc.dev/graph8/apis/graph8-developer-api/revisions/2e7cfa0ca921?raw)