Global.Church Developer Portal
Global.Church API

Needs

Endpoint:https://api.global.church

List needs

GET
https://api.global.church
/v0/needs

Returns gc:Need instances from GraphDB (https://data.global.church/needs/). Optional filters: orgUri, status, limit.

List needs › query Parameters

  • orgUristring

    Filter by declaring organization URI.

  • statusstring · enum

    Filter by need status.

    Enum values:
    open
    partially_met
    met
    withdrawn
  • limitinteger · min: 1 · max: 200

    Max rows to return (default 50, max 200).

List needs › Headers

  • Authorizationstring · required

    The Authorization header is used to authenticate with the API using your API key. Value is of the format Bearer YOUR_KEY_HERE.

List needs › Responses

List of needs

  • needsobject[] · required
  • totalinteger · required

Submit need

POST
https://api.global.church
/v0/needs

Creates a new gc:Need declaration for an organization. Caller must have an active org membership.

Submit need › Headers

  • Authorizationstring · required

    The Authorization header is used to authenticate with the API using your API key. Value is of the format Bearer YOUR_KEY_HERE.

Submit need › Request Body

  • orgUristring · required

    GraphDB URI of the declaring organization

  • orgNamestring · required

    Display name of the organization

  • declaredByEmailstring · email · required

    Email of the submitting user

  • needDescriptionstring · required

    Free-text description of the need

  • acceleratorsstring[] · minItems: 1 · required

    Engagement accelerator or function notation codes from gc:EngagementAcceleratorScheme (e.g. PRA-INT, MUL-PIO, SRA).

  • concernsPeopleGroupRop3string[]

    Optional — ROP3 codes of people groups the need concerns.

  • concernsCountryCodestring[]

    Optional — ISO alpha-2 country codes where the need exists.

Submit need › Responses

Need created

  • needIdstring · uuid · required
  • statusstring · enum · required
    Enum values:
    open

CORS preflight for needs

OPTIONS
https://api.global.church
/v0/needs

CORS preflight for needs › Responses

No content

No data returned

Update need status

POST
https://api.global.church
/v0/needs/status

Transitions a gc:Need between open / partially_met / met / withdrawn. Caller must have an active membership (or approved org_claim) for the need's owning org. No state-machine enforcement — any status is reachable from any status.

Update need status › Headers

  • Authorizationstring · required

    The Authorization header is used to authenticate with the API using your API key. Value is of the format Bearer YOUR_KEY_HERE.

Update need status › Request Body

  • needIdstring · uuid · required
  • statusstring · enum · required
    Enum values:
    open
    partially_met
    met
    withdrawn
  • actorEmailstring · email · required

    Email of the user making the status change.

Update need status › Responses

Status updated

  • needIdstring · uuid · required
  • statusstring · required

CORS preflight for need status

OPTIONS
https://api.global.church
/v0/needs/status

CORS preflight for need status › Responses

No content

No data returned
EngagementCommitments