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. Caller must have an approved org claim.

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.

Submit engagement claim › Request Body

  • orgUristring · required

    GraphDB URI of the claiming organization

  • orgNamestring · required

    Display name of the organization

  • claimedByEmailstring · email · required

    Email of the submitting user

  • engagementAcceleratorsstring[] · minItems: 1 · required

    Engagement accelerator or function notation codes from gc:EngagementAcceleratorScheme (e.g. PRA-INT, COM-DIS, SRA). See ontology.global.church for the full list of 49 function codes and 12 accelerator codes.

  • 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
AdminNeeds