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

# List orders

> List certificate orders for the organization. All requests are paginated.



## OpenAPI

````yaml get /v1/orders
openapi: 3.1.0
info:
  title: Voight Orders API docs
  version: 1.0.0
servers:
  - url: https://api.human.prod.artistree.io
security:
  - oauth:
      - enterprise-api-access/read
      - enterprise-api-access/write
paths:
  /v1/orders:
    get:
      summary: List orders
      description: >-
        List certificate orders for the organization. All requests are
        paginated.
      operationId: get_orders_v1_orders_get
      parameters:
        - description: >-
            Filter by project ID. This parameter is required, pass 'All
            Projects' to retrieve all organization orders.
          required: true
          schema:
            type: string
            title: Project Id
            description: >-
              Filter by project ID. This parameter is required, pass 'All
              Projects' to retrieve all organization orders.
          name: project_id
          in: query
        - description: >-
            If true, returns lightweight order previews instead of full order
            details.
          required: false
          schema:
            type: boolean
            title: Preview
            description: >-
              If true, returns lightweight order previews instead of full order
              details.
            default: false
          name: preview
          in: query
        - description: Pagination token for the next page of results.
          required: false
          schema:
            anyOf:
              - type: string
              - type: 'null'
            title: Page Token
            description: Pagination token for the next page of results.
          name: page_token
          in: query
        - description: Maximum number of orders per page. Defaults to 200, max 1000.
          required: false
          schema:
            type: integer
            title: Limit
            description: Maximum number of orders per page. Defaults to 200, max 1000.
            default: 200
          name: limit
          in: query
        - description: Language preference for the response
          required: false
          schema:
            anyOf:
              - type: string
              - type: 'null'
            title: Lang
            description: Language preference for the response
          name: lang
          in: header
      responses:
        '200':
          description: The list orders response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetOrdersResponse'
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
components:
  schemas:
    GetOrdersResponse:
      properties:
        order_stats:
          $ref: '#/components/schemas/OrderStats'
          description: Aggregated order counts broken down by state for the queried scope.
        project_names:
          items:
            type: string
          type: array
          title: Project Names
          description: >-
            Project names available in the organization for filtering. When
            querying ALL_PROJECTS, this includes 'Personal Certificates' as the
            first entry followed by project names sorted alphabetically. Empty
            when filtering by a specific project or personal certificates.
        next_page_token:
          anyOf:
            - type: string
            - type: 'null'
          title: Next Page Token
          description: >-
            Opaque token to retrieve the next page of results. Pass this as the
            page_token query parameter on the next request. Null when there are
            no more results.
        orders:
          anyOf:
            - items:
                $ref: '#/components/schemas/Order'
              type: array
            - type: 'null'
          title: Orders
          description: Full order details. Present when preview=false.
        order_previews:
          anyOf:
            - items:
                $ref: '#/components/schemas/OrderPreview'
              type: array
            - type: 'null'
          title: Order Previews
          description: Lightweight order summaries. Present when preview=true.
      type: object
      required:
        - order_stats
        - project_names
      title: GetOrdersResponse
    HTTPValidationError:
      properties:
        detail:
          items:
            $ref: '#/components/schemas/ValidationError'
          type: array
          title: Detail
      type: object
      title: HTTPValidationError
    OrderStats:
      properties:
        total_in_progress:
          type: integer
          title: Total In Progress
          default: 0
        total_certified:
          type: integer
          title: Total Certified
          default: 0
        total_action_required:
          type: integer
          title: Total Action Required
          default: 0
        total_reviewed:
          type: integer
          title: Total Reviewed
          default: 0
        total_failed:
          type: integer
          title: Total Failed
          default: 0
        total_unsupported:
          type: integer
          title: Total Unsupported
          default: 0
        total_orders:
          type: integer
          title: Total Orders
          default: 0
      type: object
      title: OrderStats
    Order:
      properties:
        order_id:
          type: string
          title: Order Id
          description: The unique identifier for the order.
        username:
          type: string
          title: Username
          description: The username of the user who created the order.
        email:
          type: string
          title: Email
          description: The email of the user who created the order.
        order_state:
          $ref: '#/components/schemas/HumanOrderState'
          description: >-
            The current state of the order. One of: 'In Progress', 'Human
            Certified', 'Action Required', 'Reviewed', 'Failed', 'Unsupported
            File'.
        order_title:
          type: string
          title: Order Title
          description: The display title of the order.
        asset_id:
          type: string
          title: Asset Id
          description: The unique identifier for the uploaded asset.
        asset_name:
          type: string
          title: Asset Name
          description: The filename of the uploaded asset.
        asset_last_modified_timestamp:
          type: string
          title: Asset Last Modified Timestamp
          description: >-
            Unix timestamp of the last modification time of the asset,
            serialized as a string, as provided at order creation.
        ordered_by:
          anyOf:
            - type: string
            - type: 'null'
          title: Ordered By
          description: >-
            The entity that placed the order, e.g. an artist name. May differ
            from username.
        creation_time:
          type: string
          title: Creation Time
          description: ISO 8601 timestamp of when the order was created.
        asset_preview_url:
          anyOf:
            - type: string
            - type: 'null'
          title: Asset Preview Url
          description: >-
            A presigned URL for a preview image of the asset. Null if no preview
            is available.
        analysis_list:
          items:
            $ref: '#/components/schemas/OrderAnalysisLine'
          type: array
          title: Analysis List
          description: >-
            The list of analysis checks performed on the asset and whether each
            passed.
        analysis_failed_items:
          items:
            $ref: '#/components/schemas/FailedAnalysisItem'
          type: array
          title: Analysis Failed Items
          description: >-
            Objects or layers that failed analysis, each with type, name,
            thumbnail URL, AI score, and annotation IDs.
        tags:
          items:
            type: string
          type: array
          title: Tags
          description: User-defined tags attached to the order.
        confidence:
          type: number
          title: Confidence
          description: >-
            Confidence score between 0.0 and 1.0 indicating how confident the
            system is in its certification result.
          default: 0
        remediation:
          type: number
          title: Remediation
          description: >-
            Remediation recommendation. 0.0 = not set, 0.5 = not recommended,
            1.0 = recommended.
          default: 0
        annotations:
          items:
            $ref: '#/components/schemas/Annotation'
          type: array
          title: Annotations
          description: System-generated annotations on the asset.
        project:
          anyOf:
            - $ref: '#/components/schemas/Project'
            - type: 'null'
          description: >-
            The project this order belongs to, including the requesting user's
            role. Null for personal certificate orders.
        reviewed_by:
          anyOf:
            - type: string
            - type: 'null'
          title: Reviewed By
          description: >-
            Email of the reviewer who marked this order as reviewed. Null if not
            yet reviewed.
        review_timestamp:
          anyOf:
            - type: string
            - type: 'null'
          title: Review Timestamp
          description: >-
            ISO 8601 timestamp of when the order was reviewed. Null if not yet
            reviewed.
        layers_info:
          items:
            $ref: '#/components/schemas/LayerInfo'
          type: array
          title: Layers Info
          description: >-
            Presigned download URLs for individual asset layers, if the asset
            contains multiple layers.
      type: object
      required:
        - order_id
        - username
        - email
        - order_state
        - order_title
        - asset_id
        - asset_name
        - asset_last_modified_timestamp
        - ordered_by
        - creation_time
      title: Order
    OrderPreview:
      properties:
        order_id:
          type: string
          title: Order Id
        order_title:
          type: string
          title: Order Title
        creation_time:
          type: string
          title: Creation Time
        order_state:
          $ref: '#/components/schemas/HumanOrderState'
        asset_preview_url:
          anyOf:
            - type: string
            - type: 'null'
          title: Asset Preview Url
        project_name:
          anyOf:
            - type: string
            - type: 'null'
          title: Project Name
        analysis_list:
          items:
            $ref: '#/components/schemas/OrderAnalysisLine'
          type: array
          title: Analysis List
        tags:
          items:
            type: string
          type: array
          title: Tags
      type: object
      required:
        - order_id
        - order_title
        - creation_time
        - order_state
      title: OrderPreview
    ValidationError:
      properties:
        loc:
          items:
            anyOf:
              - type: string
              - type: integer
          type: array
          title: Location
        type:
          type: string
          title: Error Type
      type: object
      required:
        - loc
        - msg
        - type
      title: ValidationError
    HumanOrderState:
      type: string
      enum:
        - In Progress
        - Human Certified
        - Action Required
        - Reviewed
        - Failed
        - Unsupported File
      title: HumanOrderState
    OrderAnalysisLine:
      properties:
        analysis_type:
          type: string
          title: Analysis Type
        analysis_passed:
          type: boolean
          title: Analysis Passed
      type: object
      required:
        - analysis_type
        - analysis_passed
      title: OrderAnalysisLine
    FailedAnalysisItem:
      properties:
        type:
          type: string
          title: Type
        name:
          type: string
          title: Name
        s3_path:
          type: string
          title: S3 Path
        ai_likelihood:
          type: number
          title: Ai Likelihood
          default: 0
        annotation_ids:
          items:
            type: string
          type: array
          title: Annotation Ids
        annotation_id:
          anyOf:
            - type: string
            - type: 'null'
          title: Annotation Id
      type: object
      required:
        - type
        - name
        - s3_path
      title: FailedAnalysisItem
    Annotation:
      properties:
        id:
          anyOf:
            - type: string
            - type: 'null'
          title: Id
        bodies:
          items:
            $ref: '#/components/schemas/AnnotationBody'
          type: array
          title: Bodies
        properties:
          $ref: '#/components/schemas/HumanAnnotationProperties'
        target:
          anyOf:
            - $ref: '#/components/schemas/AnnotationTarget'
            - type: 'null'
      type: object
      title: Annotation
    Project:
      properties:
        id:
          type: string
          title: Id
        name:
          type: string
          title: Name
        userRole:
          type: string
          title: Userrole
      type: object
      required:
        - id
        - name
        - userRole
      title: Project
    LayerInfo:
      properties:
        layer_name:
          type: string
          title: Layer Name
        layer_url:
          type: string
          title: Layer Url
      type: object
      required:
        - layer_name
        - layer_url
      title: LayerInfo
    AnnotationBody:
      properties:
        value:
          type: string
          title: Value
        id:
          type: string
          title: Id
        annotation:
          type: string
          title: Annotation
      type: object
      required:
        - value
        - id
        - annotation
      title: AnnotationBody
    HumanAnnotationProperties:
      properties:
        needs_remediation:
          anyOf:
            - type: boolean
            - type: 'null'
          title: Needs Remediation
        ai_likelihood:
          anyOf:
            - type: number
            - type: 'null'
          title: Ai Likelihood
      type: object
      title: HumanAnnotationProperties
    AnnotationTarget:
      properties:
        annotation:
          type: string
          title: Annotation
        selector:
          $ref: '#/components/schemas/HumanAnnotationSelector'
      type: object
      required:
        - annotation
        - selector
      title: AnnotationTarget
    HumanAnnotationSelector:
      properties:
        type:
          $ref: '#/components/schemas/HumanAnnotationSelectorType'
        geometry:
          $ref: '#/components/schemas/HumanAnnotationGeometry'
      type: object
      required:
        - type
        - geometry
      title: HumanAnnotationSelector
    HumanAnnotationSelectorType:
      type: string
      enum:
        - RECTANGLE
        - POLYGON
      title: HumanAnnotationSelectorType
    HumanAnnotationGeometry:
      properties:
        bounds:
          $ref: '#/components/schemas/HumanAnnotationGeometryBounds'
        x:
          anyOf:
            - type: number
            - type: 'null'
          title: X
        'y':
          anyOf:
            - type: number
            - type: 'null'
          title: 'Y'
        w:
          anyOf:
            - type: number
            - type: 'null'
          title: W
        h:
          anyOf:
            - type: number
            - type: 'null'
          title: H
        points:
          anyOf:
            - items:
                items:
                  type: number
                type: array
              type: array
            - type: 'null'
          title: Points
      type: object
      required:
        - bounds
      title: HumanAnnotationGeometry
    HumanAnnotationGeometryBounds:
      properties:
        minX:
          type: number
          title: Minx
        minY:
          type: number
          title: Miny
        maxX:
          type: number
          title: Maxx
        maxY:
          type: number
          title: Maxy
      type: object
      required:
        - minX
        - minY
        - maxX
        - maxY
      title: HumanAnnotationGeometryBounds
  securitySchemes:
    oauth:
      type: oauth2
      flows:
        clientCredentials:
          scopes: {}
          tokenUrl: >-
            https://human-artistree-prod.auth.us-east-1.amazoncognito.com/oauth2/token

````