Global.Church Developer Portal
Global.Church API

Engagement

Endpoint:https://api.global.church

List engagement claims

GET
https://api.global.church
/v0/engagement-claims

Returns paginated engagement claims with optional filters by org, people group, country, and status.

List engagement claims › query Parameters

  • orgUristring

    Filter by claiming organization URI.

  • rop3string

    Filter by people group ROP3 code.

  • countryCodestring · minLength: 2 · maxLength: 2

    Filter by ISO alpha-2 country code.

  • statusstring · enum

    Filter by claim status (default: active).

    Enum values:
    active
    paused
    completed
  • limitinteger · min: 1 · max: 200

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

  • offsetinteger · min: 0

    Pagination offset (default 0).

List engagement claims › 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 engagement claims › Responses

Paginated list of engagement claims

  • claimsobject[] · required
  • totalinteger · required

CORS preflight for list engagement claims

OPTIONS
https://api.global.church
/v0/engagement-claims

CORS preflight for list engagement claims › Responses

No content

No data returned

Submit engagement claim

POST
https://api.global.church
/v0/engagement-claims/submit

Creates a new self-reported engagement claim for an organization. The person must be a steward of the organization in the Home, which is checked at request time. Send the signed-in person's Home sign-in token in the x-home-id-token header; the gateway verifies it and refuses the request with 401 without a valid one. The acting person is the token's subject: userId is set from it and any userId sent in the body is ignored.

Submit engagement claim › 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.

  • x-home-id-tokenstring · required

    The signed-in person's sign-in token (the ES256 id_token issued by the Home). The gateway verifies its signature, issuer, audience and expiry, and takes the acting person from its subject.

Submit engagement claim › Request Body

  • orgUristring · required

    GraphDB URI of the claiming organization

  • orgNamestring · required

    Display name of the organization

  • engagementAcceleratorsstring[] · minItems: 1 · required

    Phases of Engagement Toolkit accelerator domain codes — the twelve top concepts of poe:EngagementAcceleratorScheme (PRA Prayer, SRA Scripture/Resource Access, VIS Vision Casting, MNE Multi-node Engagement, MOB Mobilization/Sending, COL Collaborative Engagement, COM Meeting Needs/Compassion, CTX Critical Contextualization, RCI Research/Cultural Insights, TRN Training/Equipping, MUL Multiplying Efforts, MKT Marketplace Involvement). Since ontology v0.51.0 these are the only accepted values; the former XXX-YYY function codes are rejected with 400. What an organization is equipped to do is classified separately on the organization (gc:hasOrganizationalCapability), never here.

    Enum values:
    PRA
    SRA
    VIS
    MNE
    MOB
    COL
    COM
    CTX
  • peopleGroupRop3string

    ROP3 code of the target people group

  • peopleGroupNamestring

    Display name of the people group

  • peopleGroupRog3string

    ROG3 country code for PGIC composite key

  • countryCodestring

    ISO alpha-2 country code

  • countryNamestring

    Display name of the country

  • descriptionstring

    Free-text description of the engagement.

  • fulfillsCommitmentIdstring · uuid

    Optional UUID of a commitment this attestation fulfills. Any organization may attest fulfillment of any commitment; the attestation records who attested, while the commitment retains its own committing organization.

Submit engagement claim › Responses

Claim created

  • claimIdstring · uuid · required
  • statusstring · enum · required
    Enum values:
    active

CORS preflight for submit engagement claim

OPTIONS
https://api.global.church
/v0/engagement-claims/submit

CORS preflight for submit engagement claim › Responses

No content

No data returned
AdminPartners