Custom fields

List all custom fields

Changed on

To update a worksheet, match its key and custom_fieldable_type, then find the intended input row by name in worksheet_rows (equation: null). Calculated rows expose their equation as a string. Rows are discoverable even when the worksheet has no saved values.

Use the row's id, not the definition's id, as the update key. Row IDs can be reused across records using the same worksheet definition, but not independently created or copied worksheets. Existing record permissions still apply.

get/custom_field_definitions

Request

  • Base URL
    https://company.aha.io/api/v1
  • Auth
    • OAuth 2
      Authorization codehttps://{account-domain}.aha.io/oauth/authorize
      Token URLhttps://{account-domain}.aha.io/oauth/token
    • or HTTP bearer
    • or API key in cookie session
  • TypeScript
    A function with typed inputs. Its response is checked against the schema.

Response

Successful operation

Example response

{
  "options": [
    {
      "text": "P1",
      "value": "486420793",
      "meta": {
        "color": "#666666"
      }
    },
    {
      "text": "P2",
      "value": "100098181",
      "meta": {
        "color": "#666666"
      }
    },
    {
      "text": "P3",
      "value": "854609942",
      "meta": {
        "color": "#666666"
      }
    },
    {
      "text": "P4",
      "value": "747947447",
      "meta": {
        "color": "#666666"
      }
    },
    {
      "text": "P5",
      "value": "462681378",
      "meta": {
        "color": "#666666"
      }
    }
  ]
}

Changes