listPartnerships

List every partnership your organization has with another organization (ACTIVE, PENDING and TERMINATED) always viewed from your side: partnerOrg is the OTHER organization, and its id is the partnerOrgId every partnership mutation takes (terminatePartnership, updatePartnershipPermittedUsers, cancelPartnershipInvite). direction says whose leads flow to whom (SEND_ONLY: yours to theirs; RECEIVE_ONLY: theirs to yours; BIDIRECTIONAL). awaitingCurrentOrgResponse is true when the partner invited you and you have not answered: those are the rows listPendingPartnershipInvites returns. permittedUserIds are YOUR users the partner may see when sending leads (empty = all). This is the answer to "who are we partnered with?".

curl https://server.goliathdata.com/api/v1/call \
  -H "Authorization: Bearer $GOLIATH_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "operationId": "listPartnerships",
    "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.listPartnerships()

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: 'listPartnerships',
    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": {
      "partnershipsForCurrentOrg": [
        {
          "id": "<ID>",
          "status": "PENDING",
          "direction": "SEND_ONLY",
          "awaitingCurrentOrgResponse": true,
          "partnerOrg": {
            "id": "<ID>",
            "name": "…"
          },
          "permittedUserIds": [
            "<ID>"
          ],
          "createdAt": "2026-01-01T00:00:00.000Z",
          "updatedAt": "2026-01-01T00:00:00.000Z"
        }
      ]
    }
  }
}

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.

curl https://server.goliathdata.com/api/v1/call \ -H "Authorization: Bearer $GOLIATH_API_KEY" \ -H "Content-Type: application/json" \ -d '{ "operationId": "listPartnerships", "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.listPartnerships()

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: 'listPartnerships', variables: {} }), }) const { data, errors } = await res.json()

Variables

Response

Errors

Behaviour

Related