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

# Get an import and its items

> Progress, and what happened to each file or page.



## OpenAPI

````yaml get /api/documents/imports/{import_id}
openapi: 3.1.0
info:
  title: Nx1 AI API
  description: |

    AI API for Nx1 Data Platform Management and Automated Data Tasks.

    Authentication is required via PSK in Authorization header.

    Default PSK is | [ask a friend] |
  version: 0.10.2
servers: []
security: []
paths:
  /api/documents/imports/{import_id}:
    get:
      tags:
        - Document imports
      summary: Get an import and its items
      description: Progress, and what happened to each file or page.
      operationId: get_import_api_documents_imports__import_id__get
      parameters:
        - name: import_id
          in: path
          required: true
          schema:
            type: string
            format: uuid
            description: The import.
            title: Import Id
          description: The import.
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: >-
                  #/components/schemas/api__models__document_source_models__ImportResponse
        '403':
          description: Needs a personal sign-in.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '404':
          description: Unknown source, or not found.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '409':
          description: The source isn't set up, or you need to connect (again).
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
      security:
        - OAuth2AuthorizationCodeBearer: []
        - APIKeyHeader: []
components:
  schemas:
    api__models__document_source_models__ImportResponse:
      properties:
        id:
          type: string
          format: uuid
          title: Id
        source:
          type: string
          enum:
            - notion
            - sharepoint
            - google_drive
            - onedrive
            - confluence
          title: Source
        status:
          type: string
          enum:
            - queued
            - running
            - completed
            - failed
          title: Status
        total:
          type: integer
          title: Total
          description: Files and pages found (folders expanded).
        imported:
          type: integer
          title: Imported
          description: New documents, and replaced ones.
        skipped:
          type: integer
          title: Skipped
        failed:
          type: integer
          title: Failed
        error:
          anyOf:
            - type: string
            - type: 'null'
          title: Error
          description: Why the whole import stopped.
        options:
          additionalProperties: true
          type: object
          title: Options
        created_at:
          type: string
          format: date-time
          title: Created At
        finished_at:
          anyOf:
            - type: string
              format: date-time
            - type: 'null'
          title: Finished At
        items:
          items:
            $ref: '#/components/schemas/ImportItemResponse'
          type: array
          title: Items
      type: object
      required:
        - id
        - source
        - status
        - total
        - imported
        - skipped
        - failed
        - created_at
      title: ImportResponse
      description: An import and, on its own page, its items.
    ErrorResponse:
      properties:
        error:
          type: string
          title: Error
          description: A brief description of the error that occurred.
        code:
          type: integer
          title: Code
          description: The HTTP status code associated with the error.
          default: 500
      type: object
      required:
        - error
      title: ErrorResponse
    HTTPValidationError:
      properties:
        detail:
          items:
            $ref: '#/components/schemas/ValidationError'
          type: array
          title: Detail
      type: object
      title: HTTPValidationError
    ImportItemResponse:
      properties:
        id:
          type: string
          format: uuid
          title: Id
        external_id:
          type: string
          title: External Id
        name:
          type: string
          title: Name
        path:
          type: string
          title: Path
        status:
          type: string
          enum:
            - queued
            - importing
            - imported
            - updated
            - skipped
            - failed
          title: Status
        document_id:
          anyOf:
            - type: string
              format: uuid
            - type: 'null'
          title: Document Id
        error:
          anyOf:
            - type: string
            - type: 'null'
          title: Error
          description: Why it failed or was skipped.
        web_url:
          anyOf:
            - type: string
            - type: 'null'
          title: Web Url
      type: object
      required:
        - id
        - external_id
        - name
        - path
        - status
      title: ImportItemResponse
      description: One file or page of an import.
    ValidationError:
      properties:
        loc:
          items:
            anyOf:
              - type: string
              - type: integer
          type: array
          title: Location
        msg:
          type: string
          title: Message
        type:
          type: string
          title: Error Type
        input:
          title: Input
        ctx:
          type: object
          title: Context
      type: object
      required:
        - loc
        - msg
        - type
      title: ValidationError
  securitySchemes:
    OAuth2AuthorizationCodeBearer:
      type: oauth2
      flows:
        authorizationCode:
          scopes: {}
          authorizationUrl: >-
            https://sso-rapid.rapid.nx1cloud.com/realms/rapid/protocol/openid-connect/auth
          tokenUrl: >-
            https://sso-rapid.rapid.nx1cloud.com/realms/rapid/protocol/openid-connect/token
    APIKeyHeader:
      type: apiKey
      in: header
      name: Authorization-PSK

````

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