Get all field value changes

curl --request GET \
  --url https://api.affinity.co/v2/field-value-changes \
  --header 'Authorization: Bearer <token>'

{
  "data": [
    {
      "id": 42,
      "field": {
        "id": "field-1234",
        "entityType": "company",
        "name": "Stage",
        "type": "global"
      },
      "entity": {
        "id": 1
      },
      "listEntry": {
        "id": 1,
        "listId": 1
      },
      "changer": {
        "id": 1,
        "firstName": "John",
        "lastName": "Smith",
        "emailAddress": "john.smith@contoso.com"
      },
      "changedAt": "2024-06-01T12:00:00Z",
      "actionType": "update",
      "type": "<string>",
      "value": {
        "referenceType": "<string>",
        "id": 1,
        "name": "Horizon Technologies",
        "domain": "horizontech.com"
      }
    }
  ],
  "pagination": {
    "prevUrl": "https://api.affinity.co/v2/foo?cursor=ICAgICAgYmVmb3JlOjo6Nw",
    "nextUrl": "https://api.affinity.co/v2/foo?cursor=ICAgICAgIGFmdGVyOjo6NA"
  }
}

Field Value Changes

Get all field value changes

⚠️ This endpoint is currently in BETA

Retrieve field value changes across all entities and fields in your Affinity workspace.

For an overview of field value changes, including which fields support change tracking and how the action types behave, see Field Value Changes.

This endpoint is built for delta-sync. Within a single sync, follow pagination.nextUrl to page through results until it becomes null, which means you have reached the most recent change. To run the next incremental sync, record the changedAt of the last change you processed and, on your next sync, filter for changes newer than that timestamp (for example, filter=changedAt>2024-06-01T12:00:00Z). Do not persist nextUrl between syncs, since it is null once you are caught up. Changes are returned in ascending order of changedAt, then by internal change ID. Only fields with change tracking enabled are included.

You can filter results using the filter query parameter.

Property Name	Type	Description	Allowed Operators	Examples
`field.id`	`text`		`=`	`field.id=field-1234`
`listEntry.id`	`int64`		`=`	`listEntry.id=5678`
`changer.id`	`int64`	The person who made the change.	`=`	`changer.id=9012`
`changedAt`	`datetime`	When the change was made.	`>`, `<`, `>=`, `<=`	`changedAt>=2025-01-01T00:00:00Z`
`actionType`	`text`	The type of change (`add`, `update`, `delete`)	`=`	`actionType=add`

Filters can be combined:

| (OR) to match any of multiple values: field.id=field-1 | field.id=field-2
& (AND) to require all conditions: changedAt>=2025-01-01T00:00:00Z & changedAt<=2025-12-31T23:59:59Z

GET

field-value-changes

Get all field value changes

curl --request GET \
  --url https://api.affinity.co/v2/field-value-changes \
  --header 'Authorization: Bearer <token>'

{
  "data": [
    {
      "id": 42,
      "field": {
        "id": "field-1234",
        "entityType": "company",
        "name": "Stage",
        "type": "global"
      },
      "entity": {
        "id": 1
      },
      "listEntry": {
        "id": 1,
        "listId": 1
      },
      "changer": {
        "id": 1,
        "firstName": "John",
        "lastName": "Smith",
        "emailAddress": "john.smith@contoso.com"
      },
      "changedAt": "2024-06-01T12:00:00Z",
      "actionType": "update",
      "type": "<string>",
      "value": {
        "referenceType": "<string>",
        "id": 1,
        "name": "Horizon Technologies",
        "domain": "horizontech.com"
      }
    }
  ],
  "pagination": {
    "prevUrl": "https://api.affinity.co/v2/foo?cursor=ICAgICAgYmVmb3JlOjo6Nw",
    "nextUrl": "https://api.affinity.co/v2/foo?cursor=ICAgICAgIGFmdGVyOjo6NA"
  }
}

Authorizations

Authorization

string

header

required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Query Parameters

filter

string

Filter options

orderBy

enum<string>[]

Properties to sort by. Defaults to changedAt. Prefix with - for descending order.

Available options:

changedAt,

-changedAt

cursor

string

Cursor for the next or previous page

Example:

"ICAgICAgYmVmb3JlOjo6Nw"

limit

integer<int32>

default:100

Number of items to include in the page

Required range: 1 <= x <= 100

Example:

100

Response

data

(fieldValueChanges.CompanyValueChange · object | fieldValueChanges.CompanyMultiValueChange · object | fieldValueChanges.DatetimeValueChange · object | fieldValueChanges.DropdownValueChange · object | fieldValueChanges.DropdownMultiValueChange · object | fieldValueChanges.FilterableTextValueChange · object | fieldValueChanges.FilterableTextMultiValueChange · object | fieldValueChanges.LocationValueChange · object | fieldValueChanges.LocationMultiValueChange · object | fieldValueChanges.NumberValueChange · object | fieldValueChanges.NumberMultiValueChange · object | fieldValueChanges.PersonValueChange · object | fieldValueChanges.PersonMultiValueChange · object | fieldValueChanges.RankedDropdownValueChange · object | fieldValueChanges.TextValueChange · object)[]

required

The field value changes for this page

Maximum array length: 100

fieldValueChanges.CompanyValueChange
fieldValueChanges.CompanyMultiValueChange
fieldValueChanges.DatetimeValueChange
fieldValueChanges.DropdownValueChange
fieldValueChanges.DropdownMultiValueChange
fieldValueChanges.FilterableTextValueChange
fieldValueChanges.FilterableTextMultiValueChange
fieldValueChanges.LocationValueChange
fieldValueChanges.LocationMultiValueChange
fieldValueChanges.NumberValueChange
fieldValueChanges.NumberMultiValueChange
fieldValueChanges.PersonValueChange
fieldValueChanges.PersonMultiValueChange
fieldValueChanges.RankedDropdownValueChange
fieldValueChanges.TextValueChange

Show child attributes

pagination

Pagination · object

required

Show child attributes

Send Feedback Search Files by Keyword

⌘I