Skip to content

List a collection field's change history

GET
/collections/{id}/fields/{field_id}/history

Returns the recorded changes to one field’s value on one collection, newest first: the old and new value, when the change was made, by whom and its set_by. Any signed-in user can call this. It doesn’t check the field’s read_capability, whether you may see the collection, or whether it exists.

limit defaults to 50, but here it isn’t clamped: the 1-500 range shown isn’t enforced. 0 returns nothing, a value above 500 allows more entries when there are more, and a negative value within the 32-bit range is an error. Values beyond the 32-bit integer range wrap around when converted, so they can become 0, a negative number or a different positive one. There is no paging, and entries recorded at the same time have no fixed order. Entries come from these routes and from vocabulary merges, and they are deleted with the collection or field when either is removed for good.

id
required
string format: uuid

The collection’s id.

field_id
required
string format: uuid

The field definition’s id.

limit
integer
default: 50 >= 1 <= 500

Maximum number of entries to return. This route doesn’t clamp it: 0 returns nothing, a negative value within the 32-bit range is an error, and values beyond that range wrap around.

Recorded changes, newest first.

Array<object>
object
id
required

The history entry’s id.

string format: uuid
collection_id
required

The collection’s id.

string format: uuid
field_id
required

The field definition’s id.

string format: uuid
old_value

The value before the change, as an object holding the field’s type and the value. Left out for a first write.

object
key
additional properties
any
new_value

The value after the change, in the same form. Left out when the value was removed.

object
key
additional properties
any
changed_at
required

When the change was recorded.

string format: date-time
changed_by_user_ref

The account that made the change, if known.

integer format: int64
nullable
set_by
required

The set_by of the write that made the change; manual for a removal through this API and computed for a vocabulary merge.

string

Authentication required, missing, or invalid

object
error
required

Human-readable error summary

string
Example
the request could not be completed
Example
{
"error": "authentication required: sign in and retry with a valid session or API token"
}

Resource not found

object
error
required

Human-readable error summary

string
Example
the request could not be completed