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

# Get refresh status

> Returns the status of the most recent object refresh triggered by
POST /connections/{connectionId}/refresh-objects for the given connection,
including whether it is still running, when it last completed, and any error.



## OpenAPI

````yaml /developers/api-reference/openapi.json get /v1/connections/{connectionId}/refresh-status
openapi: 3.0.0
info:
  title: Engini API
  version: v1
  description: The Engini public API.
servers:
  - url: https://api.engini.io
security:
  - Bearer: []
  - ApiKey: []
tags:
  - name: Auth
    description: Identify the caller a Developer API request is authenticated as.
  - name: On-prem agents
    description: >-
      Provision and manage agents that run Engini tasks inside a customer's
      network.
  - name: Applications
    description: >-
      Discover the applications (toolkits) available in Engini and their
      connection requirements.
  - name: Tools
    description: Browse and execute the tools exposed by Engini applications.
  - name: Toolsets
    description: Manage toolsets - named groupings of connections and tools.
  - name: McpServers
    description: >-
      Inspect and maintain MCP servers - the account-wide endpoints that expose
      Engini tools and workflows over the Model Context Protocol. Distinct from
      the MCPClient connection kind, which is Engini consuming a third-party MCP
      server.
  - name: Connections
    description: >-
      Manage connections to applications, including OAuth sign-in and
      default-connection selection.
  - name: Triggers
    description: >-
      Create triggers that fire when something changes in a connected app, and
      manage the destinations their events are delivered to.
paths:
  /v1/connections/{connectionId}/refresh-status:
    get:
      tags:
        - Connections
      summary: Get refresh status
      description: >-
        Returns the status of the most recent object refresh triggered by

        POST /connections/{connectionId}/refresh-objects for the given
        connection,

        including whether it is still running, when it last completed, and any
        error.
      operationId: Connections_GetRefreshStatus
      parameters:
        - name: connectionId
          in: path
          required: true
          description: The identifier of the connection whose refresh status is requested.
          schema:
            type: integer
            format: int32
          x-position: 1
      responses:
        '200':
          description: The current refresh status for the connection.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RefreshStatusResponse'
        '400':
          description: Bad request - malformed body or invalid parameters.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '401':
          description: Unauthorized - missing or invalid bearer token or API key.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '403':
          description: Forbidden - the caller lacks access to the resource.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '404':
          description: Not found - the resource does not exist.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '429':
          description: Too many requests - rate limit exceeded.
          headers:
            Retry-After:
              description: Number of seconds to wait before retrying.
              schema:
                type: integer
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '500':
          description: Internal server error - an unexpected error occurred.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      security:
        - Bearer: []
        - ApiKey: []
      x-codeSamples:
        - lang: python
          label: Python
          source: |-
            from engini import Engini

            client = Engini()  # reads ENGINI_API_KEY

            status = client.connections.refresh_status(42)
            print(status.status)
        - lang: typescript
          label: TypeScript
          source: |-
            import { Engini } from "@engini/sdk";

            const client = new Engini(); // reads ENGINI_API_KEY

            const status = await client.connections.refreshStatus(42);
            console.log(status.status);
        - lang: bash
          label: CLI
          source: |-
            # starts a refresh and polls its status until it settles
            engini connections refresh 42 --timeout 300
components:
  schemas:
    RefreshStatusResponse:
      type: object
      description: Status of a connection's most recent metadata/object refresh.
      additionalProperties: false
      required:
        - status
      properties:
        status:
          description: Current refresh status.
          oneOf:
            - $ref: '#/components/schemas/RefreshStatus'
        statusDescription:
          type: string
          description: Human-readable description of the current status.
          nullable: true
        error:
          type: string
          description: Error message from the last failed refresh, if any.
          nullable: true
        errorDate:
          type: string
          description: When the last error occurred, if any.
          format: date-time
          nullable: true
        lastRefreshDate:
          type: string
          description: When the connection was last refreshed successfully.
          format: date-time
          nullable: true
    ErrorResponse:
      type: object
      description: >-
        Unified machine-readable error envelope returned by every non-200
        Developer API response.
      additionalProperties: false
      required:
        - errorCode
        - message
        - requestId
        - timestamp
      properties:
        errorCode:
          type: string
          description: Machine-readable error code identifying the failure.
        message:
          type: string
          description: Human-readable error message.
        requestId:
          type: string
          description: Identifier of the request, for support/correlation.
        timestamp:
          type: string
          description: Timestamp when the error occurred (ISO 8601).
        details:
          type: array
          description: Per-field validation details, when applicable.
          nullable: true
          items:
            $ref: '#/components/schemas/ErrorDetail'
    RefreshStatus:
      type: integer
      description: Possible states of a connection refresh.
      x-enumNames:
        - Ok
        - Error
        - InProgress
      enum:
        - 0
        - 1
        - 2
    ErrorDetail:
      type: object
      description: A single field-level error detail within an ErrorResponse.
      additionalProperties: false
      required:
        - field
        - issue
      properties:
        field:
          type: string
          description: Name of the field the issue relates to.
        issue:
          type: string
          description: Description of the issue with the field.
  securitySchemes:
    Bearer:
      type: http
      description: Enter your JWT token
      scheme: bearer
      bearerFormat: JWT
    ApiKey:
      type: apiKey
      description: >-
        Opaque Developer API key (prefix `eng_`). Authenticates as the key's
        owner and resolves the account automatically.
      name: x-api-key
      in: header

````

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