{"templateId":"markdown","sharedDataIds":{"sidebar":"sidebar-sidebars.yaml"},"props":{"metadata":{"markdoc":{"tagList":["admonition"]},"type":"markdown"},"seo":{"title":"Fields"},"dynamicMarkdocComponents":[],"compilationErrors":[],"ast":{"$$mdtype":"Tag","name":"article","attributes":{},"children":[{"$$mdtype":"Tag","name":"Heading","attributes":{"level":1,"id":"fields","__idx":0},"children":["Fields"]},{"$$mdtype":"Tag","name":"Admonition","attributes":{"type":"info","name":"Beta"},"children":[{"$$mdtype":"Tag","name":"p","attributes":{},"children":["The Fields API is in Beta. Additive changes are normal, and breaking changes"," ","may be made with notice while the resource incorporates customer feedback. See"," ",{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/docs/v1/versioning"},"children":["Versioning and compatibility"]},"."]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Fields are the labels, budgets, departments, and other tags a business uses to"," ","categorize spend. This endpoint requires the ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["fields:read"]}," scope."]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"list-fields","__idx":1},"children":["List fields"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["GET /api/v1/fields"]}," returns the field catalog for the business linked to your"," ","API Access Token, ordered by ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["id"]},"."]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"data-language":"bash","header":{"controls":{"copy":{}}},"source":"curl \"https://rhoapi.rho.co/api/v1/fields?page_size=20\" \\\n  -H \"Authorization: Bearer $RHO_API_TOKEN\"\n","lang":"bash"},"children":[]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["include_retired"]}," defaults to ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["false"]},", which returns only active fields and"," ","options. Pass ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["include_retired=true"]}," to also see archived ones. ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["page_size"]}," ","can be from 1 to 100 and defaults to 20 - follow the cursor as described in"," ",{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/docs/v1/pagination"},"children":["Pagination"]}," until ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["next_page_token"]}," is ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["null"]},". Options are not"," ","paginated: every option of a returned field is included."]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"data-language":"json","header":{"controls":{"copy":{}}},"source":"{\n  \"fields\": [\n    {\n      \"id\": \"70000000-0000-4000-8000-000000000001\",\n      \"name\": \"Department\",\n      \"type\": \"choice\",\n      \"cardinality\": \"one_to_one\",\n      \"status\": \"active\",\n      \"is_system_managed\": true,\n      \"options\": [\n        {\n          \"id\": \"70000000-0000-4000-8000-000000000011\",\n          \"name\": \"Engineering\",\n          \"status\": \"active\",\n          \"color_hex\": \"#1A2B3C\"\n        },\n        {\n          \"id\": \"70000000-0000-4000-8000-000000000012\",\n          \"name\": \"Sales\",\n          \"status\": \"active\"\n        }\n      ]\n    },\n    {\n      \"id\": \"70000000-0000-4000-8000-000000000002\",\n      \"name\": \"Project code\",\n      \"type\": \"freetext\",\n      \"cardinality\": \"one_to_many\",\n      \"status\": \"active\",\n      \"is_system_managed\": false,\n      \"options\": []\n    }\n  ],\n  \"page\": {\"next_page_token\": null}\n}\n","lang":"json"},"children":[]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["type"]}," is ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["choice"]}," for a field with a fixed set of options, or ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["freetext"]}," for"," ","an open text value - a ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["freetext"]}," field always has an empty ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["options"]}," list."," ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["cardinality"]}," is ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["one_to_one"]}," when a single value may apply at once, or"," ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["one_to_many"]}," when several may. ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["is_system_managed"]}," is ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["true"]}," for fields Rho"," ","manages, such as the system Department field, and ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["false"]}," for fields the"," ","business defined itself. ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["color_hex"]}," is omitted on a field or option that has"," ","no display color set."]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["status"]}," is ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["active"]},", or ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["retired"]}," when the field or option is archived and"," ","hidden from new tagging - a retired field or option stays readable so values"," ","applied before it was retired still resolve."]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"reference","__idx":2},"children":["Reference"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["See the ",{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/api/v1/openapi/fields"},"children":["Rho API v1 reference"]}," for all fields and"," ","parameters."]}]},"headings":[{"value":"Fields","id":"fields","depth":1},{"value":"List fields","id":"list-fields","depth":2},{"value":"Reference","id":"reference","depth":2}],"frontmatter":{"seo":{"title":"Fields"}},"lastModified":"2026-10-23T10:00:23.881Z","pagePropGetterError":{"message":"","name":""}},"slug":"/docs/v1/fields","userData":{"isAuthenticated":false,"teams":["anonymous"]},"isPublic":true}