Rating

Rating attributes are a numeric value from 0 to 5. In the UI, they are presented as a proportion of 5 stars.

There are no default rating attributes in Attio, but they can be created by users and in the API.

Only single-select rating attributes are permitted.

Reading values

Rating attribute values have a value property:

{
  "active_from": "2023-04-03T15:21:06.447000000Z",
  "active_until": null,
  "created_by_actor": {...},
  "attribute_type": "rating",
  "value": 3
}

Writing values

To write rating values, you can either pass an integer directly, or an object with a single key, value.

As all rating attributes are single-select, you may pass the value directly or as an array containing a single element.

{
  "performance": 4
}

{
  "performance": [
    {
      "value": 4
    }
  ]
}

Filtering

Ratings can be filtered by the operators $eq, $gte, $gt,$lte,$lt. The implicit syntax does an exact equality check:

{
  "filter": {
    "performance": 4
  }
}

{
  "filter": {
    "performance": {
      "value": {
        "$gte": 3
      }
    }
  }
}