Global.Church Developer Portal
Global.Church API

Admin

Endpoint:https://api.global.church

GET
https://api.global.church
/v0/admin/org-links

Returns organization link requests with their review evidence. Send the reviewer's Home sign-in token, issued to the platform app, in the x-home-id-token header; the gateway verifies it and the reviewer is the token's subject, who must hold an active admin or support role.

  • statusstring · enum

    Filter by link status, or all.

    Enum values:
    pending
    confirmed
    revoked
    superseded
    all
  • 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 reviewer's sign-in token (the ES256 id_token issued by the Home to the platform app). The gateway verifies its signature, issuer, audience and expiry, and takes the acting person from its subject.

Link requests

  • linksobject[] · required

OPTIONS
https://api.global.church
/v0/admin/org-links

CORS preflight for list organization links › Responses

No content

No data returned

POST
https://api.global.church
/v0/admin/org-links/review

Confirms or rejects a link request, or re-runs its domain check. confirm makes the link effective; for an organization not yet in the directory it also creates the directory record, and the reviewer may set or correct orgUri. reject marks the request revoked. recheck fetches https://<domain>/.well-known/gc-org.json again and stores the result in the link's evidence; a missing file does not block confirmation. Send the reviewer's Home sign-in token, issued to the platform app, in the x-home-id-token header; the gateway verifies it and the reviewer is the token's subject, who must hold an active admin or support role.

Review an organization link › 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 reviewer's sign-in token (the ES256 id_token issued by the Home to the platform app). The gateway verifies its signature, issuer, audience and expiry, and takes the acting person from its subject.

Review an organization link › Request Body

  • linkIdstring · uuid · required
  • actionstring · enum · required
    Enum values:
    confirm
    reject
    recheck
  • notestring

    Reviewer note, stored with the link's evidence.

  • orgUristring

    With confirm: the directory record to link, when setting or correcting it.

Review an organization link › Responses

Review result

  • linkobject

    A link between an organization's directory record and the organization that holds it in the Home. A steward requests the link; a Global.Church reviewer confirms it.


OPTIONS
https://api.global.church
/v0/admin/org-links/review

CORS preflight for review organization link › Responses

No content

No data returned