GoliathDevelopersGet an API key
Reference/Dealsgenerated from the gateway manifest

filterDeals

Run a SAVED deal filter.

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

Run a SAVED deal filter (filterId from listDealFilters or saveFilter type DEAL) over ONE pipeline (pipelineId from listPipelineNames) and page the matching deals with limit/offset: id, title, isArchived, stage and assignees, plus pagination.total (every match, not the page) and hasMore. Saved filters only: to try criteria first, save the filter, run it here, and fix it in place with updateFilter. A deal filter does not carry its pipeline, so the same filter can run over any pipeline you pass. Use getDeal for one deal in full.

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

limit is clamped to 50.

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.

filterIdID!required
pipelineIdID!required
limitInt

Default 25.

offsetInt

Default 0.

Response

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

response shape
{
  "data": {
    "filterQuery": {
      "applyDealFilter": {
        "items": [
          {
            "id": "<ID>",
            "title": "…",
            "isArchived": true,
            "stage": {
              "id": "<ID>",
              "name": "…"
            },
            "users": [
              {
                "id": "<ID>",
                "firstName": "…",
                "lastName": "…"
              }
            ]
          }
        ],
        "pagination": {
          "total": 0,
          "hasMore": true
        }
      }
    }
  }
}

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.

READgetDealREADfindDealsREADsurveyDealsREADlistStalledDealsREADlistPipelinesREADlistDealFilters