Skip to content

A provider in the workspace​

GET
/resource-providers/{providerId}

The provider, its counts (drafts, in review, live, paused, held, links waiting, open reports), whether its entity may publish yet, and what the viewer may do (viewer.can, per action: all, locations or false). 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
{
"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",
"counts": {
"additionalProperties": 0
},
"ready_to_publish": true,
"linked": [
{
"id": "string",
"kind": "string",
"slug": "string",
"name": "string",
"is_church": true,
"entity_slug": "string",
"status": "string",
"relation": "string",
"can_manage": true
}
],
"viewer": {
"role": "string",
"as_staff": true,
"can": {
"additionalProperties": "string"
}
}
}

Playground​

Server
Authorization
Variables
Key
Value

Samples​

Powered by VitePress OpenAPI

Built with VitePress