Building a webhook integration? Read the webhook guide for signatures, retries, event schemas, and troubleshooting.

apiProvider-backed

Search quickenrich

POST /api/agents/quickenrich-search

Search connected QuickEnrich company or contact discovery with native documented include/exclude filters. Returns one bounded page with an optional continuation cursor and raw evidence. Company search may incur provider charges; contacts contain availability flags, not emails/phones. country_code and city refer to COMPANY geography; locality is the person location. Use exact public lookup values for country, employee bands, industry, revenue and services. Read provider SOP/docs first. Does not send or enrich.

Parameters

workspaceId

string

No description.

resourcerequired

string

No description.

companies | people

filtersrequired

object

No description.

limit

integer

No description.

cursor

string

No description.

Example

REST requestbash

curl -X POST "https://app.pipeline.help/api/agents/quickenrich-search" \
  -H "Authorization: Bearer $PIPELINE_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"resource":"companies","filters":{"company_name":{"include":["Example company"]}}}'

Response

Success response schemajson schema

{
  "type": "object",
  "properties": {
    "success": {
      "type": "boolean"
    },
    "message": {
      "type": "string"
    },
    "data": {
      "type": "object",
      "properties": {
        "provider": {
          "type": "string"
        },
        "resource": {
          "type": "string"
        },
        "rows": {
          "type": "array",
          "items": {
            "type": "object"
          }
        },
        "totalMatching": {
          "type": "number"
        },
        "creditsUsed": {
          "type": "number"
        },
        "nextCursor": {
          "type": [
            "string",
            "null"
          ]
        },
        "hasMore": {
          "type": "boolean"
        },
        "raw": {
          "type": "object"
        },
        "sourceUrl": {
          "type": "string"
        },
        "filters": {
          "type": "object"
        }
      }
    }
  },
  "required": [
    "success",
    "message"
  ]
}

HTTP errors

401: Missing or invalid API key.
403: Authenticated but not permitted for the workspace or resource.
404: The requested resource was not found.