Sign in
Relationship Intelligence

Check public research

The companies page checks public research before it shows Allow public research. When research is configured, the required plan is intelligence, and consent is still off, the response is available true, allowed false, and reason consent_required.

get/v1/research/status

Request

  • Base URL: / (relative, and the document was published on a file host, not at the API’s origin)
  • URL: /v1/research/status
  • Auth: HTTP bearer

Response

Public research status.

allowedboolean required

Whether this workspace may run public research now.

availableboolean required

Whether a research vendor is configured.

reason'consent_required' | 'plan_required' | 'capability_disabled' | 'provider_unconfigured' | 'unavailable'

Why public research is not running. Absent when it is allowed.

requiredPlanstring required

Plan that includes public research.

Example response

{
  "available": true,
  "reason": "consent_required",
  "requiredPlan": "intelligence"
}

Changes

No operation changes recorded.