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

# Get refresh status

> Get the status of the most recent object refresh for the given connection.



## OpenAPI

````yaml /api-reference/openapi.json get /v1/connections/{connectionId}/RefreshStatus
openapi: 3.0.0
info:
  title: Engini DeveloperAPI
  version: v1
  description: 'Merged public developer API spec: Identity + WorkflowApi.'
servers:
  - url: https://api.engini.io
security:
  - Bearer: []
  - ApiKey: []
paths:
  /v1/connections/{connectionId}/RefreshStatus:
    get:
      tags:
        - Connections
      summary: Get refresh status
      description: >-
        Get the status of the most recent object refresh for the given
        connection.
      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.
          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: []
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 error envelope for every non-200 response from
        /api/DeveloperAPI/v1/*.

        See applications-tools-spec.md §"Error envelope".
      additionalProperties: false
      required:
        - errorCode
        - message
        - requestId
        - timestamp
        - path
      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).
        path:
          type: string
          description: Request path that produced the error.
        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 — no Bearer or companytoken
        needed.
      name: x-api-key
      in: header

````