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

# Returns completed transactions with specified parameters

> Returns transactions that have finished processing (processed, cancelled, or failed), filtered by status, skill, creation time, or registration parameters. Use this to find transactions whose result files are ready to download. For a walkthrough, see [Getting a list of transactions](/vantage/developer/transactions).



## OpenAPI

````yaml /openapi.json get /api/publicapi/v1/transactions/completed
openapi: 3.0.1
info:
  title: Vantage processing REST API
  description: >-
    The Vantage Processing REST API lets you process documents programmatically:
    create transactions, upload files, launch skills, monitor progress, and
    download results. For authentication and a first end-to-end request, see the
    [Getting started guide](/vantage/developer/getting-started).
  version: '1.0'
  x-application-version: 1.0.0-20251028.13+6e102d0c2a7a440df9ee9615e09b3c8c333587ac
servers:
  - url: https://vantage-us.abbyy.com
    description: Production United States
  - url: https://vantage-eu.abbyy.com
    description: Production Europe
  - url: https://vantage-au.abbyy.com
    description: Production Australia
security:
  - OAuth2Security:
      - global.wildcard
      - openid
      - permissions
paths:
  /api/publicapi/v1/transactions/completed:
    get:
      tags:
        - Transactions
      summary: Returns completed transactions with specified parameters
      description: >-
        Returns transactions that have finished processing (processed,
        cancelled, or failed), filtered by status, skill, creation time, or
        registration parameters. Use this to find transactions whose result
        files are ready to download. For a walkthrough, see [Getting a list of
        transactions](/vantage/developer/transactions).
      operationId: GetCompletedTransactions
      parameters:
        - name: TransactionStatus
          in: query
          description: Active Transactions status
          schema:
            $ref: >-
              #/components/schemas/Abbyy.Vantage.PublicApi.Contract.Transactions.Requests.CompletedTransactionStatus
        - name: SkillId
          in: query
          description: "Available skill's ID (according to permissions). If this field is empty,\r\nthen all the available skills will be used as filter."
          schema:
            type: string
            description: "Available skill's ID (according to permissions). If this field is empty,\r\nthen all the available skills will be used as filter."
        - name: SkillVersion
          in: query
          description: Only available skills can be filtered by their versions
          schema:
            type: integer
            description: Only available skills can be filtered by their versions
            format: int32
        - name: StartDate
          in: query
          description: "Minimum creation time of the transactions.\r\nTime must be defined in UTC format."
          schema:
            type: string
            description: "Minimum creation time of the transactions.\r\nTime must be defined in UTC format."
            format: date-time
        - name: EndDate
          in: query
          description: "Maximum creation time of the transactions.\r\nTime must be defined in UTC format.\r\nIf not given, the current UTC time will be used."
          schema:
            type: string
            description: "Maximum creation time of the transactions.\r\nTime must be defined in UTC format.\r\nIf not given, the current UTC time will be used."
            format: date-time
        - name: TransactionParameters
          in: query
          description: "List of transaction parameters.\r\nRetrieved transactions should contain all the parameters"
          schema:
            type: array
            items:
              $ref: >-
                #/components/schemas/Abbyy.Vantage.PublicApi.Contract.Transactions.Requests.Parameter
            description: "List of transaction parameters.\r\nRetrieved transactions should contain all the parameters"
        - name: DocumentParameters
          in: query
          description: "List of document parameters.\r\nRetrieved transactions should contain all the parameters"
          schema:
            type: array
            items:
              $ref: >-
                #/components/schemas/Abbyy.Vantage.PublicApi.Contract.Transactions.Requests.Parameter
            description: "List of document parameters.\r\nRetrieved transactions should contain all the parameters"
        - name: Offset
          in: query
          description: 'Pagination offset (default: 0)'
          schema:
            type: integer
            description: 'Pagination offset (default: 0)'
            format: int32
        - name: Limit
          in: query
          description: The pagination limit. Required; accepted values are 1 to 1000.
          schema:
            type: integer
            description: Pagination limit
            format: int32
          required: true
      responses:
        '200':
          description: >-
            Returns the matching completed transactions and their processed page
            counts as JSON. The upstream API specification does not declare a
            response schema for this endpoint; the example below shows the
            observed response shape. For field-level details, see [Working with
            transactions](/vantage/developer/transactions).
          content:
            application/json:
              example:
                items:
                  - status: Processed
                    pageCount: 1
                    transactionId: fc9920fe-f788-47f8-9972-b767493faed9
                    createTimeUtc: '2023-09-11T13:47:50.273Z'
                    transactionParameters:
                      - isReadOnly: true
                        key: App
                        value: PublicAPI
                    fileParameters:
                      - isReadOnly: true
                        key: Index
                        value: '0'
                      - isReadOnly: true
                        key: SourceFileName
                        value: BillofLading_1.pdf
                      - isReadOnly: true
                        key: SourceType
                        value: PublicAPI
                    skillId: 3f6b1c2a-8d4e-4f5a-9b0c-7e1d2a3b4c5d
                    skillVersion: 1
                    documentCount: 1
                totalItemCount: 7
        '400':
          description: EndDate must be greater than start date
          content:
            text/plain:
              schema:
                $ref: '#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails'
            application/json:
              schema:
                $ref: '#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails'
            text/json:
              schema:
                $ref: '#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails'
components:
  schemas:
    Abbyy.Vantage.PublicApi.Contract.Transactions.Requests.CompletedTransactionStatus:
      enum:
        - Processed
        - Cancelled
        - Failed
      type: string
    Abbyy.Vantage.PublicApi.Contract.Transactions.Requests.Parameter:
      type: object
      properties:
        key:
          type: string
          nullable: true
          description: >-
            Key (name) of the registration parameter to filter by, for example
            `SourceFileName`.
        value:
          type: string
          nullable: true
          description: >-
            Value of the registration parameter to filter by. Returned
            transactions must contain the parameter with this exact value.
      additionalProperties: false
    Microsoft.AspNetCore.Mvc.ProblemDetails:
      type: object
      properties:
        type:
          type: string
          nullable: true
          description: URI reference that identifies the problem type.
        title:
          type: string
          nullable: true
          description: Short, human-readable summary of the problem type.
        status:
          type: integer
          format: int32
          nullable: true
          description: HTTP status code for this occurrence of the problem.
        detail:
          type: string
          nullable: true
          description: >-
            Human-readable explanation specific to this occurrence of the
            problem.
        instance:
          type: string
          nullable: true
          description: >-
            URI reference that identifies this specific occurrence of the
            problem.
      additionalProperties: {}
  securitySchemes:
    OAuth2Security:
      type: oauth2
      flows:
        authorizationCode:
          authorizationUrl: https://vantage-us.abbyy.com/auth2/connect/authorize
          tokenUrl: https://vantage-us.abbyy.com/auth2/connect/token
          scopes:
            global.wildcard: Global wildcard
            openid: User Id
            permissions: User permissions

````