GoliathDevelopersGet an API key
Reference/Partnershipsgenerated from the gateway manifest

canShareWithPartners

True when your organization has at least one ACTIVE partnership in a sending direction.

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

True when your organization has at least one ACTIVE partnership in a sending direction (SEND_ONLY or BIDIRECTIONAL from your side): i.e. there is a partner your organization could share leads with. False means sharing a contact with a partner is not possible until an invitation is sent and accepted; check this before promising a user that a lead can be handed to a partner.

curl https://server.goliathdata.com/api/v1/call \
  -H "Authorization: Bearer $GOLIATH_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "operationId": "canShareWithPartners",
    "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.canShareWithPartners()
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: 'canShareWithPartners',
    variables: {}
  }),
})
const { data, errors } = await res.json()

Variables

None. Send "variables": {}.

Response

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

response shape
{
  "data": {
    "orgPartnershipQuery": {
      "canShareWithPartners": true
    }
  }
}

Errors

Behaviour

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