Get project config

GET/v1/projects/{client_id}/config

Inspect non-secret project policy as top-level fields. For package setup, copy the complete configuration from your Dashboard integration guide. This endpoint does not return that configuration or its allowed-size list.

AUTH

Secret key or browser activation token

CONTENT TYPE

application/json

STATUS

Stable
Secret key or browser activation tokenVerification stepsOpen as Markdown ↗

Request parameters

client_id
string
Required
Project ID (client_id, WAVEBIRD_CLIENT_ID), formatted like wbproj_....

Returns

client_id
string
Project ID (client_id, WAVEBIRD_CLIENT_ID), formatted like wbproj_....
app_name
string
Saved app name.
app_domain
string
Saved app host.
app_type
string
App type, such as chat or image.
allowed_formats
string[]
Formats enabled for this project.
timing
string
Saved before, during or after timing.
consent_mode
string
Saved consent mode.
gdpr_default
boolean
Project GDPR fallback. Actual request policy still applies.
frequency_cap
object
Configured session and prompt-interval limits.
default_bidfloor
number | null
Saved floor, or null when unset.
default_bidfloor_currency
string | null
Saved floor currency, or null when unset.
blocked_categories
string[]
Saved category exclusions.

Errors

unauthorized401

Missing or inactive secret key or browser activation token.

forbidden403

Key does not belong to this project.

not_found404

Project was not found.

Related

Need help with your integration?

Share the affected endpoint, request ID, and the behavior you expected. Leave out keys and user content.

Contact the team