> ## Documentation Index
> Fetch the complete documentation index at: https://docs.serval.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Get Entity Type Field Formula Status

> Get the progress of the background recompute that the field's last formula or auto-number save started: revision, entities processed and failed, and completed_at once it finishes. open_failure_count is the number of entities whose formula evaluation currently fails.

## 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.

| Credential | Access requirements |
| - | - |
| Organization-scoped API key | `entities:read` |
| Team-scoped API key | `entities:read` |
| User-based token (OAuth) | Supported, subject to permissions |

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.


## OpenAPI

````yaml /sections/api-reference/openapi-spec-v2.yaml get /v2/entity-type-fields/{id}/formula/status
openapi: 3.1.0
info:
  title: Serval Public API
  description: Serval Public API
  contact:
    name: Serval
    url: https://serval.com
    email: support@serval.com
  license:
    name: Serval License
    url: https://serval.com/license
  version: 2.0.0
servers:
  - url: https://public.api.serval.com
security:
  - BearerAuth: []
tags:
  - name: Access Membership API
  - name: Access Policy API
  - name: Access Policy Approval Procedure API
  - name: Access Profile API
  - name: Access Relationship API
  - name: Access Request API
  - name: Agent API
  - name: Analytics API
  - name: App Instance API
  - name: App Resource API
  - name: App Resource Role API
  - name: Approval Delegation API
  - name: Approval Procedure API
  - name: Approval Request API
  - name: Assignment Rules API
  - name: Audit Log API
  - name: Billing API
  - name: Browser API
  - name: Campaign API
  - name: Change Blackout API
  - name: Change Model API
  - name: Connected Channels API
  - name: Custom Field API
  - name: Custom Role API
  - name: Custom Service API
  - name: Dashboards API
  - name: Email Intake API
  - name: Entity API
  - name: Entity Field Mapping API
  - name: Entity Ingestion Config API
  - name: Entity Type API
  - name: Folder API
  - name: Forms API
  - name: Group API
  - name: Guidance API
  - name: Help Agent API
  - name: Improvement Request API
  - name: Journey API
  - name: Knowledge API
  - name: Knowledge Base API
  - name: One-Time Window API
  - name: Package API
  - name: Report API
  - name: Review API
  - name: Roles API
  - name: SLA API
  - name: Schedule API
  - name: Tag API
  - name: Team API
  - name: Team Group API
  - name: Team SDLC Settings API
  - name: Team User API
  - name: Ticket API
  - name: Ticket Import API
  - name: Topic API
  - name: User API
  - name: User Relationship API
  - name: Widgets API
  - name: Worker API
  - name: Workflow API
  - name: Workflow Approval Procedure API
  - name: Workflow Run API
paths:
  /v2/entity-type-fields/{id}/formula/status:
    get:
      tags:
        - Entity Type API
      summary: Get Entity Type Field Formula Status
      description: >-
        Get the progress of the background recompute that the field's last
        formula or auto-number save started: revision, entities processed and
        failed, and completed_at once it finishes. open_failure_count is the
        number of entities whose formula evaluation currently fails.
      operationId: svrelay.publicv2.PublicAPIServiceV2.GetEntityTypeFieldFormulaStatus
      parameters:
        - name: id
          in: path
          required: true
          schema:
            type: string
            title: id
            description: The ID of the entity type field.
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: >-
                  #/components/schemas/svstore.publicapi.GetEntityTypeFieldFormulaStatusResponse
      security:
        - BearerAuth: []
components:
  schemas:
    svstore.publicapi.GetEntityTypeFieldFormulaStatusResponse:
      type: object
      properties:
        revision:
          type: integer
          title: revision
          format: int32
          description: |-
            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.
          x-stainless-terraform-configurability: optional
        processedCount:
          type:
            - integer
            - string
          title: processed_count
          format: int64
          description: Records the pass has recomputed so far.
          x-stainless-terraform-configurability: optional
        failedCount:
          type:
            - integer
            - string
          title: failed_count
          format: int64
          description: Records the formula failed on during the pass.
          x-stainless-terraform-configurability: optional
        startedAt:
          $ref: '#/components/schemas/google.protobuf.Timestamp'
          title: started_at
          description: When the pass started.
          x-stainless-terraform-configurability: optional
        completedAt:
          oneOf:
            - $ref: '#/components/schemas/google.protobuf.Timestamp'
            - type: 'null'
          title: completed_at
          description: When the pass finished. Unset while it runs.
          x-stainless-terraform-configurability: optional
        openFailureCount:
          type: integer
          title: open_failure_count
          format: int32
          description: >-
            Records whose last evaluation of the formula failed and that have
            not
             been fixed since, across every type that carries the field.
          x-stainless-terraform-configurability: optional
      title: GetEntityTypeFieldFormulaStatusResponse
      additionalProperties: false
    google.protobuf.Timestamp:
      type: string
      examples:
        - '2025-01-15T01:30:15.000Z'
        - '2025-06-01T00:00:00.000Z'
      format: date-time
      description: A timestamp in RFC 3339 format (e.g., "2025-01-15T01:30:15Z").
  securitySchemes:
    BearerAuth:
      type: http
      scheme: bearer
      bearerFormat: JWT

````

This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.