Skip to content

The provider of a non-profit, business, community or person​

GET
/resource-providers

For a workspace's Resources tab (#2422): the provider of the entity, as GET /resource-providers/{providerId} answers it, or provider: null when it lists nothing yet, with whether the viewer may make it (can_create) and what they may do. Anyone on the entity's team whose role sees the tab reads it, and staff with review_resources or manage_resources. A role that doesn't (a cashier, a non-profit member) gets 403, someone with nothing to do with it 404. kind=person (#2436) is a person's own (My help -> Help you offer): entity_id is their profile, the caller's when left out; only they and staff read it, and person says what stands in the way of making it (a verified email, a public name).

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​

Query Parameters

kind*
Type
string
Required
Valid values
"nonprofit""business""community""person"
entity_id

Required for every kind but person.

Type
string
Format
"uuid"

Responses​

OK

application/json
JSON
{
"entity": {
"kind": "string",
"id": "string",
"slug": "string",
"name": "string"
},
"provider": {
"id": "string",
"kind": "string",
"slug": "string",
"status": "string",
"status_reason": "string",
"name": "string",
"is_church": true,
"entity": {
"kind": "string",
"id": "string",
"slug": "string"
},
"program": {
"name": "string",
"website": "string",
"phone": "string",
"place_id": "string"
},
"person": {
"profile_id": "string",
"email_verified": true,
"account_status": "string",
"listable": true
},
"city_id": "string",
"part_of_provider_id": "string",
"city_name": "string",
"city_region": "string",
"part_of": {
"id": "string",
"kind": "string",
"slug": "string",
"name": "string",
"is_church": true,
"entity_slug": "string",
"status": "string"
},
"parts": [
{
"id": "string",
"kind": "string",
"slug": "string",
"name": "string",
"is_church": true,
"entity_slug": "string",
"status": "string"
}
],
"created_at": "string"
},
"can_create": true,
"person": {
"email_verified": true,
"has_name": true,
"listable": true
},
"viewer": {
"role": "string",
"as_staff": true,
"can": {
"additionalProperties": "string"
}
}
}

Playground​

Server
Authorization
Variables
Key
Value

Samples​

Powered by VitePress OpenAPI

Built with VitePress