Skip to main content
GET
Get Entity Type Field Formula Status

Authentication and permissions

Token requirements: User-based token (OAuth) or Organization-scoped API key or Team-scoped API key. Send a bearer access token for one of these identities. The permissions and resource restrictions below also apply.
Permissions joined by + are all required; or separates alternatives. Full-access keys still cannot call endpoints marked unsupported. Team keys must allow every team checked by the request. OAuth access depends on the user’s roles and resource access.
  • Check a field’s formula in a team’s database: The permission is checked on the team that owns the field’s database. Previewing on an entity also requires access to that entity and to every field the formula reads on it.

Authorizations

Authorization
string
header
required

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

Path Parameters

id
string
required

The ID of the entity type field.

Response

200 - application/json

Success

revision
integer<int32>

The recompute pass of the last save that changed the formula, value source or auto-number settings. Zero, with every count zero, until the first such save.

processedCount

Records the pass has recomputed so far.

failedCount

Records the formula failed on during the pass.

startedAt
string<date-time>

When the pass started.

Examples:

"2025-01-15T01:30:15.000Z"

"2025-06-01T00:00:00.000Z"

completedAt
string<date-time> | null

A timestamp in RFC 3339 format (e.g., "2025-01-15T01:30:15Z").

Example:

"2025-01-15T01:30:15.000Z"

openFailureCount
integer<int32>

Records whose last evaluation of the formula failed and that have not been fixed since, across every type that carries the field.