Web API

Press shift + S to search API reference.

Compliance

Change events

gethttps://api.airtable.com/v0/meta/enterpriseAccounts/{enterpriseAccountId}/changeEvents

Retrieve change events for enterprise bases. These change events are available for 14 days from the date of the event.

This endpoint requires change events to be enabled for your enterprise account and toggled on in your enterprise admin panel. Please contact your account team or support to start this process. Events are generated only after you turn change events on in your admin panel.

Requirements

AuthenticationPersonal access token, OAuth integration
Scopeenterprise.changeEvents:read
User role

Enterprise admin

Billing plansEnterprise Scale

Path parameters

enterpriseAccountId
string

Query parameters

startTime
optional<string>

Earliest change event to retrieve (inclusive), in ISO 8601 date time format. Optional.

endTime
optional<string>

Latest change event to retrieve (exclusive), in ISO 8601 date time format. Optional.

pageSize
optional<number>

The number of records per page. Maximum value of 100; defaults to 10.

offset
optional<string>

If there may be more to retrieve, an offset is returned. Pass the offset to the next call to retrieve the next page. Do not pass offset when retrieving the first page.

Response format

offset
optional<string>

Pagination token. Pass this value as the offset query parameter to retrieve the next page.

events
array of the below object

Events are returned newest to oldest.

id
string
type
string

The type of event. base_modified is currently the only value.

actor
Change events actor

The actor that caused the change event. Note that this could be a user or an internal system.

eventTimestamp
string

A date timestamp in the ISO format, eg:"2018-01-01T00:00:00.000Z"

objectId
string

ID of the affected object.

objectType
"base"

Type of the affected object. Currently only 'base'.

timestamp
string

A date timestamp in the ISO format, eg:"2018-01-01T00:00:00.000Z"

context
object

Additional context about the change event.

baseId
string

Base ID, a unique identifier for a base.

applicationId
optional<string>

Deprecated. Use baseId instead.

actionId
optional<string>
origin
object

Contains additional information about the request origin, including IP address.

ipAddress
string
payload
object

Payload of base changes. This captures changes to base's schema, cell values, attachment URLs, and record comments.

Each created*, destroyed*, changed* field is optional.

Refer to field types for more information about cell value payloads.

data
Change events data
version
"v0"

Error responses

Invalid offset (422)
Invalid **offset**. See error message for exact reason.
{
"error": {
"message": "Offset token is invalid for this query",
"type": "INVALID_OFFSET_VALUE"
}
}
Invalid pageSize (422)
Invalid **pageSize**. See error message for exact reason.
{
"error": {
"message": "Maximum pageSize is 100",
"type": "INVALID_PAGE_SIZE_ARGUMENT"
}
}
Invalid time (422)
Invalid **startTime** or **endTime**. See error message for exact reason.
{
"error": {
"message": "startTime cannot be same or after endTime",
"type": "INVALID_TIME_RANGE"
}
}
Request (example)
Copy
$
curl "https://api.airtable.com/v0/meta/enterpriseAccounts/{enterpriseAccountId}/changeEvents" \
-H "Authorization: Bearer YOUR_TOKEN"
200 – Response (example)
{
"events": [
{
"actor": {
"type": "user",
"user": {
"email": "foo@bar.com",
"id": "usrL2PNC5o3H4lBEi",
"name": "Jane Doe"
}
},
"context": {
"baseId": "appLkNDICXNqxSDhG"
},
"eventTimestamp": "2022-02-01T21:25:05.663Z",
"id": "01FYFFDE39BDDBC0HWK51R6GPF",
"objectId": "appLkNDICXNqxSDhG",
"objectType": "base",
"origin": {
"ipAddress": "1.2.3.4"
},
"payload": {
"data": {
"changedTablesById": {
"tbltp8DGLhqbUmjK1": {
"changedFieldsById": {
"fldoi0c3GaRQJ3xnI": {
"current": {
"name": "new name"
},
"previous": {
"name": "previous name"
}
}
},
"changedMetadata": {
"current": {
"description": "table description",
"name": "table name"
},
"previous": {
"description": "previous name",
"name": "previous name"
}
},
"changedRecordsById": {
"rec560UJdUtocSouk": {
"current": {
"cellValuesByFieldId": {
"fldgdCnvrkNsrWnDn": [
{
"id": "rec560UJdUtocSouk",
"name": "Record primary column value"
}
],
"fldoi0c3GaRQJ3xnI": "Updated hello world"
}
},
"previous": {
"cellValuesByFieldId": {
"fldgdCnvrkNsrWnDn": null,
"fldoi0c3GaRQJ3xnI": "Hello world"
}
}
}
},
"changedRecordsMetadataById": {
"rec560UJdUtocSouk": {
"changedCommentsById": {
"comB5z37Mg9zaEPw6": {
"current": {
"text": "updated comment text"
},
"previous": {
"text": "previous comment text"
}
}
},
"createdCommentsById": {
"comB5z37Mg9zaEPw6": {
"text": "comment text"
}
},
"destroyedCommentIds": [
"comB5z37Mg9zaEPw6"
]
}
},
"createdFieldsById": {
"fldoi0c3GaRQJ3xnI": {
"name": "new name",
"type": "number"
}
},
"createdRecordsById": {
"rec560UJdUtocSouk": {
"cellValuesByFieldId": {
"fldoi0c3GaRQJ3xnI": "Hello world"
},
"createdTime": "2022-02-01T21:25:05.663Z"
}
},
"destroyedFieldIds": [
"fldoi0c3GaRQJ3xnI"
]
}
},
"createdTablesById": {
"tbltp8DGLhqbUmjK1": {
"fieldsById": {
"fldoi0c3GaRQJ3xnI": {
"name": "Name",
"type": "singleLineText"
}
},
"metadata": {
"description": "new table description",
"name": "new table"
},
"recordsById": {
"rec560UJdUtocSouk": {
"cellValuesByFieldId": {
"fldoi0c3GaRQJ3xnI": "Hello world"
},
"createdTime": "2022-02-01T21:25:05.663Z"
}
},
"recordsMetadataById": {
"rec560UJdUtocSouk": {
"commentsById": {
"comB5z37Mg9zaEPw6": {
"text": "comment text"
}
}
}
}
}
},
"destroyedTableIds": [
"tbltp8DGLhqbUmjK1"
]
},
"version": "v0"
},
"timestamp": "2022-02-01T21:25:05.663Z",
"type": "base_modified"
}
],
"offset": "01FYET2W5BGQ24DXT5C4AG36PR"
}