GoliathDevelopersGet an API key
Reference/Partnershipsgenerated from the gateway manifest

lookupPartnerOrg

Resolve a prospective partner organization by exactly one of an admin's phone number or email.

POST/api/v1/callADMINreadruns as the key's owner
View as Markdown

Resolve a prospective partner organization by exactly one of an admin's phone number or email. Returns the matched admin and their organization: use the organization id as partnerOrgId when sending a partnership invitation. For an organization you are ALREADY partnered with, listPartnerships has the id without a lookup.

curl https://server.goliathdata.com/api/v1/call \
  -H "Authorization: Bearer $GOLIATH_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "operationId": "lookupPartnerOrg",
    "variables": {}
  }'
import { GoliathClient } from '@goliath-data/sdk'

const goliath = new GoliathClient({
  apiKey: process.env.GOLIATH_API_KEY!,
  baseUrl: 'https://server.goliathdata.com',
})

const result = await goliath.partnerships.lookupPartnerOrg({})
const res = await fetch('https://server.goliathdata.com/api/v1/call', {
  method: 'POST',
  headers: {
    Authorization: `Bearer ${process.env.GOLIATH_API_KEY}`,
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({
    operationId: 'lookupPartnerOrg',
    variables: {}
  }),
})
const { data, errors } = await res.json()

Variables

The example sends only what the schema requires. Some operations also need one of several optional variables (one filter or another, say); the description above says which.

phoneNumberString
emailString

Response

What comes back under data: a list shows as one entry, and a value as its type.

response shape
{
  "data": {
    "orgPartnershipQuery": {
      "lookupInvitee": {
        "user": {
          "id": "<ID>",
          "firstName": "…",
          "lastName": "…",
          "email": "…"
        },
        "organization": {
          "id": "<ID>",
          "name": "…"
        }
      }
    }
  }
}

Errors

400unknown_variable

A variable the operation does not declare. A typo is refused rather than silently dropped.

401unauthorized

No bearer header, or the key is invalid or revoked.

403insufficient_scope

The key lacks the scope the operation requires.

403forbidden

A referenced record does not exist, was deleted, or is outside your organization. The gateway cannot tell those apart.

Behaviour

A read. It rejects an Idempotency-Key header with 400 bad_request.

READlistPartnershipsREADlistPendingPartnershipInvitesREADcanShareWithPartnersADMINcreatePartnershipInviteADMINacceptPartnershipInviteADMINrejectPartnershipInvite