USuseboom
Initiatives

Get extraction schema

Changed on

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.

get/api/v1/initiatives/{id}/extraction-schema

Request

  • Base URL
    https://www.useboom.ai
  • Auth
    HTTP bearer

Path parameters

idstring required

The initiative id.

Response

Success

initiativeIdstring required
hasSchemaboolean required

False when the initiative has no extraction schema yet.

versioninteger nullable required

The current schema version, or null when none is set.

notesstring nullable required

Note on the current version.

createdAtstring nullable required

ISO 8601 timestamp of the current version, or null.

Changes