Skip to content

The places help can happen at​

GET
/resource-providers/{providerId}/locations

The open locations of the provider's entity, the primary first, every kind in one shape (#2422, NP-04, SP-05, CM-04): a non-profit's (organization_locations.org_id), a business's (the storefront's own), a community's or a public program's. mine marks a business manager's own. can_add: here (POST below, a community or a public program), entity (a non-profit or a business adds them in its own workspace, so one address change updates every listing) or false. A person (#2436) has none and adds none (items empty, can_add false): their help happens where they serve, or online, and their home is never a location. Checks: requireProviderAccess('view_resources').

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

providerId*

The provider (resource_providers.id).

Type
string
Required
Format
"uuid"

Responses​

OK

application/json
JSON
{
"items": [
],
"can_add": "string"
}

Playground​

Server
Authorization
Variables
Key
Value

Samples​

Powered by VitePress OpenAPI

Built with VitePress