List research detail types

View as Markdown

Returns research detail type tokens and write metadata, including valueShape, allowedToken, range, and timeSeries. When timeSeries=true, each believable dated observation is historical data: add a new current row and delete only rows believed false.

Authentication

AuthorizationBearer

User bearer token: Supabase or Clerk session JWT, Clerk OAuth access token, or Clerk personal API key

OR
X-API-Keystring

Admin API key for system-to-system write operations

OR
X-Client-Secretstring

Client secret for read-only service-to-service access (no writes)

Response

OK
curatedboolean
labelstring
targetPathstring
timeSeriesboolean

Whether rows are dated history; true means add current observations and keep believable old rows.

typeValuestring
valueShapeenum

Write-time value shape token. For numericCountOrRange details, send either discreteValue for an exact count or textValue for an employee range.

valueTypeenum

Read projection category; choose write fields from valueShape.

allowedTokenlist of strings or nullOptional
Allowed valueResearchDetail tokens for enumeratedToken shapes.
rangeobject or nullOptional

Inclusive numeric bounds for numericRatio, numericScore, and numericGrowthRate. numericGrowthRate values use percentage points: 80 means 80%, not 0.8.

Errors

400
Bad Request Error
401
Unauthorized Error
403
Forbidden Error
406
Not Acceptable Error
429
Too Many Requests Error
500
Internal Server Error
503
Service Unavailable Error