Fields

Fields are the labels, budgets, departments, and other tags a business uses to categorize spend. This endpoint requires the fields:read scope.

GET /api/v1/fields returns the field catalog for the business linked to your API Access Token, ordered by id.

curl "https://rhoapi.rho.co/api/v1/fields?page_size=20" \
  -H "Authorization: Bearer $RHO_API_TOKEN"

include_retired defaults to false, which returns only active fields and options. Pass include_retired=true to also see archived ones. page_size can be from 1 to 100 and defaults to 20 - follow the cursor as described in Pagination until next_page_token is null. Options are not paginated: every option of a returned field is included.

{
  "fields": [
    {
      "id": "70000000-0000-4000-8000-000000000001",
      "name": "Department",
      "type": "choice",
      "cardinality": "one_to_one",
      "status": "active",
      "is_system_managed": true,
      "options": [
        {
          "id": "70000000-0000-4000-8000-000000000011",
          "name": "Engineering",
          "status": "active",
          "color_hex": "#1A2B3C"
        },
        {
          "id": "70000000-0000-4000-8000-000000000012",
          "name": "Sales",
          "status": "active"
        }
      ]
    },
    {
      "id": "70000000-0000-4000-8000-000000000002",
      "name": "Project code",
      "type": "freetext",
      "cardinality": "one_to_many",
      "status": "active",
      "is_system_managed": false,
      "options": []
    }
  ],
  "page": {"next_page_token": null}
}

type is choice for a field with a fixed set of options, or freetext for an open text value - a freetext field always has an empty options list. cardinality is one_to_one when a single value may apply at once, or one_to_many when several may. is_system_managed is true for fields Rho manages, such as the system Department field, and false for fields the business defined itself. color_hex is omitted on a field or option that has no display color set.

status is active, or 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.

See the Rho API v1 reference for all fields and parameters.