A reaction object contains information about a reaction on a post created by a user. It contains relationships to a post and board. Each reaction belongs to the user who created it, though user information is not included in the response object.
An example of a reaction object is displayed below.
{
"id": "123",
"type": "reaction",
"attributes": {
"value": 1,
"reactionType": "like",
"createdAt": "2025-07-01T10:30:00.000Z",
"updatedAt": "2025-07-01T10:30:00.000Z"
},
"relationships": {
"post": {
"data": {
"id": "post_lkROZPOe62X2QjMg",
"type": "post"
}
},
"board": {
"data": {
"id": "3pbz27udysdf57mg",
"type": "board"
}
}
}
}
Reaction object properties
| Properties | Type | Description |
|---|---|---|
id | string | Reaction ID |
type | string | Always reaction |
attributes.value | int | The reaction value. Valid values depend on the reaction type. |
attributes.reactionType | string | The type of reaction. Can be "like", "star", "grade", or "vote". |
attributes.createdAt | string | Date and time when this reaction was created. Formatted as an ISO 8601 date time string. |
attributes.updatedAt | string | Date and time when this reaction was updated. Formatted as an ISO 8601 date time string. |
relationships.post | object | Post object that the reaction belongs to. Only contains type and id as per JSON:API specification. |
relationships.board | object | Board object that the reaction belongs to. Only contains type and id as per JSON:API specification. |
Reaction types and valid values
Different reaction types have different validation rules for the value field:
| Reaction Type | Valid Values | Description |
|---|---|---|
like | 1 | A simple like reaction. Value must be exactly 1. |
star | 0 to 5 | A star rating reaction. Value must be between 0 and 5 (inclusive). |
grade | 0 to 100 | A grade reaction. Value must be between 0 and the board's maximum grade value (default 100). |
vote | 1 or -1 | An upvote/downvote reaction. Value must be 1 (upvote) or -1 (downvote). |