API reference / Docs
List the properties of docs
The properties that the docs of one collection can have, in order, with the choices of each select. A doc keeps its values by the id of each property.
get
/api/v1/doc-fieldsOther ways to call it
CLI
troopy docs fieldsMCP tool
troopy_list_doc_fieldsRate limit120 calls in 60 seconds, for each key
Query parameters
collectionenum<string>A set of properties: docs (the library), interviews, or research (the reports). A record has none
docsinterviewsresearch
Default "docs"
Response
200 · application/jsondata*array<object>6 properties
id*stringA 24-character id
collection*enum<string>A set of properties: docs (the library), interviews, or research (the reports). A record has none
docsinterviewsresearch
name*stringtype*enum<string>textnumberdateselectmulti_selecturlcheckbox
options*array<object>The choices of a select or multi_select
3 properties
id*stringA 24-character id
name*stringcolor*enum<string>stoneskymintsandrosepeachcyanorange
position*integerIts place among the properties of its collection, from 0
Errors
400 invalid_inputFix the field named in detail. Each operation's schema is in /api/v1/openapi.json.
401 unauthorizedSend an API key as `Authorization: Bearer tr_live_...`. Create one in Troopy under Settings.
403 forbiddenThe key lacks a scope this operation needs, or its owner lacks the role. detail says which; create a key with the scope, or ask an organization owner or admin.
429 rate_limitedWait the number of seconds in Retry-After, then retry.