Read editable nonprofit settings

GET

/org-admin/{slug}/nonprofit

Requires org.update_settings. Returns the scoped nonprofit's editable page fields, private contact and mailing address, receipt preferences, and general fund preferences.

Authorizations

BearerAuth

In the browser, authentication rides on the httpOnly session cookies set by /cognito/signin or the Google / Apple sign-in at /cognito/oauth/{provider}. For scripts and for Swagger UI testing, paste an API key (fh_live_…, created with POST /api-keys); a Cognito JWT is accepted too. Sign-in does not return a token in its body.

Type

HTTP (bearer)

Parameters

Path Parameters

slug*

The organization's slug (requireOrgPermission resolves it).

Type

string

Required

Responses

OK

Content-Type

application/json

"string"

GET

/org-admin/{slug}/nonprofit

Playground

Server

Authorization

BearerAuth

Variables

Key

Value

slug*

Samples

Powered by VitePress OpenAPI