Read a team invite

GET

/nonprofits/invite/{token}

Public, built for the caller. What the invite page shows: the invited address as a hint, and in full only to a caller one of whose verified emails it is; whether accepting will work and whether the caller is already on the team.

Authorizations

or

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

token*

The invite token from the email.

Type

string

Required

Responses

OK

Content-Type

application/json

{

"org": {

"slug": "string",

"display_name": "string",

"logo": "string",

"place": "string",

"status": "string"

},

"role": "string",

"title": "string",

"invited_by": {

"name": "string"

},

"email_hint": "i***@kalynafamilyaid.org",

"email": "string",

"sent_at": "string",

"expires_at": "string",

"show_on_page": true,

"state": "string",

"viewer": {

"signed_in": true,

"role": "string",

"email_matches": true

}

}

GET

/nonprofits/invite/{token}

Playground

Server

Variables

Key

Value

token*

Samples

Powered by VitePress OpenAPI