---
title: "Get extraction schema"
method: GET
path: "/api/v1/initiatives/{id}/extraction-schema"
tags: ["Initiatives"]
---

# Get extraction schema

`GET /api/v1/initiatives/{id}/extraction-schema`

## Request

- Base URL: `https://www.useboom.ai`
- URL: `https://www.useboom.ai/api/v1/initiatives/{id}/extraction-schema`
- Auth: HTTP bearer

Read an initiative's current extraction schema — the typed fields pulled from each conversation. Returns the schema in the exact shape extraction_schema_set accepts, so you can read it, edit it, and set it back. `hasSchema` is false when none is configured yet.

## Path parameters

- `id` string, required: The initiative id.

## Response `200`

Success

- object
  - `initiativeId` string, required
  - `hasSchema` boolean, required: False when the initiative has no extraction schema yet.
  - `version` integer, nullable, required: The current schema version, or null when none is set.
  - `schema` object, nullable, required: The current extraction schema, ready to edit and pass back to extraction_schema_set. Null when none is set.
    - `fields` object, required
  - `notes` string, nullable, required: Note on the current version.
  - `createdAt` string, nullable, required: ISO 8601 timestamp of the current version, or null.

## Other responses

- `400`: Validation failed or the request cannot proceed.
- `401`: Missing, malformed, or revoked API key.
- `404`: The resource does not exist in this organization.
- `409`: Conflicts with the current state (duplicates, wrong lifecycle state).
- `422`: The request is well-formed but semantically invalid.
- `429`: Rate limit exceeded — retry after `Retry-After`.
- `500`: Internal server error.
- `503`: Transient error — retry with a narrower request.

## Changes

- **2026-11-03** `7c7a773b12ce`: 1 info
  - endpoint added

[Operation history](https://skmtc.dev/useboom/apis/boom-api/changes/api/v1/initiatives/:id/extraction-schema/get.md)

---

[API](https://skmtc.dev/useboom/apis/boom-api.md) - [All operations](https://skmtc.dev/useboom/apis/boom-api/llms.txt) - [OpenAPI document](https://skmtc.dev/useboom/apis/boom-api/revisions/d596d92ed092?raw)