Skip to content
API referenceConsumerConsumer.bootstrap

Public project bootstrap for the consumer app

GET
/consumer/v1/bootstrap

Unauthenticated, host-resolved. Returns the project's branding, enabled consumer SSO providers (public PKCE fields only), and enabled payment vendors so the consumer app can initialize and render a branded login before any user authenticates.

Response Body

application/json

application/json

application/json

curl -X GET "https://example.com/consumer/v1/bootstrap"
{  "payment_vendors": [    {      "mode": "sandbox",      "publishable_key": "string",      "vendor_type": "stripe"    }  ],  "project": {    "branding": {      "accent_color": "string",      "logo_url": "string",      "primary_color": "string"    },    "display_name": "string",    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",    "name": "string"  },  "sso_providers": [    {      "authorization_endpoint": "string",      "button_label": "string",      "button_logo_url": "string",      "client_id": "string",      "display_name": "string",      "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",      "is_preferred": true,      "issuer_url": "string",      "kind": "string",      "scopes": [        "string"      ]    }  ]}
{  "detail": "Pool slug must be unique.",  "instance": "urn:forestvpn:trace:a1b2c3d4",  "title": "Validation Error",  "type": "https://fvpn.net/errors/validation"}
{  "detail": "Pool slug must be unique.",  "instance": "urn:forestvpn:trace:a1b2c3d4",  "title": "Validation Error",  "type": "https://fvpn.net/errors/validation"}