Skip to main content
GET
Export a project's configuration

Authorizations

hookie_session
string
cookie
required

The console's sealed session cookie, set by WorkOS AuthKit. Mutating requests also require the X-Requested-With CSRF header.

Path Parameters

pid
string
required

Project id (UUID) belonging to the caller workspace.

Query Parameters

format
enum<string>
default:json
Available options:
json,
yaml

Response

The document.

A project's configuration (DX-10, #201) — the hookie.yml shape, so hookie apply reads an export as it is. NOTHING SECRET IS IN IT: no endpoint URL (its slug is the credential), endpoint verification secret, destination signing secret or ingest key. Sources, WebSocket triggers and portals hold encrypted credentials and are listed under not_exported instead. Identity per kind: an endpoint's slug, a record view's dataset + name, everything else's name.

version
integer
project
string | null

The source project's slug; informational.

endpoints
object[]
rules
object[]
destinations
object[]
ai_agents
object[]
workflows
object[]
triggers
object[]
cron_triggers
object[]
record_views
object[]
not_exported
object[]

Informational; an import ignores it.