vCita Import API

The Import API from vCita — 4 operation(s) for import.

GitHub OpenAPI

Operations 4

GET /v3/integrations/import_job_items Get all ImportJobItems #
GET /v3/integrations/import_job_items/{uid} Retrieve an ImportJobItem #
POST /v3/integrations/import_jobs Create a new ImportJob #
GET /v3/integrations/import_jobs/{uid} Retrieve an ImportJob #

Work with this as data

Every API here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for apis

7 MCP tools reach this
  • find_apisBrowse and filter every API in the catalog.
  • get_api_artifactsOne API's artifacts, grouped by type.
  • get_openapiThe primary OpenAPI for this API.
  • find_similar_apisAPIs that look like this one.
  • apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
  • resolveTurn a domain, URL or GitHub org into the provider it belongs to.
  • find_cohortsEvery scored population of providers in the catalog.
All 92 tools →

Call it yourself

curl for this page
This API
curl "https://apis.io/api/v1/apis/vcita:vcita-import-api"
All apis
curl "https://apis.io/api/v1/apis?limit=25"

Calls without X-API-Key need no key. Calls with it need a paid plan — get a key.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. By signing up you are subscribing to the APIs.io and API Evangelist newsletters — you can unsubscribe from any issue. See our Privacy Policy and Terms.

A second provider on the same verified email joins the account you already have.

OpenAPI Specification

vcita-import-api-openapi.yml Raw ↑
openapi: 3.2.0
info:
  title: Integrations Import API
  description: Unified OpenAPI specification for integrations domain
  version: '3.0'
  x-generated:
    sourceFiles:
    - import.json
    - authbridge.json
    pathNormalizations:
    - file: authbridge.json
      basePath: /v3
      transformations:
      - original: /integrations/idp_actor_mappings
        normalized: /v3/integrations/idp_actor_mappings
        basePath: /v3
      - original: /integrations/idp_actor_mappings/{uid}
        normalized: /v3/integrations/idp_actor_mappings/{uid}
        basePath: /v3
      - original: /integrations/directory_idps
        normalized: /v3/integrations/directory_idps
        basePath: /v3
      - original: /integrations/directory_idps/{uid}
        normalized: /v3/integrations/directory_idps/{uid}
        basePath: /v3
    pathConflicts: []
    componentConflicts: []
    totalPaths: 8
    totalComponents: 11
servers:
- url: https://api.vcita.biz
  description: Unified API Gateway server
tags:
- name: Import
paths:
  /v3/integrations/import_job_items:
    get:
      tags:
      - Import
      summary: Get all ImportJobItems
      description: '## Overview

        Get all import job items for a specific import job.


        Available for **Staff, Directory, and Client tokens**'
      operationId: ImportJobItemsController_findAll
      parameters:
      - name: page
        required: false
        in: query
        description: Page number of results.
        schema:
          minimum: 1
          maximum: 10000
          default: 1
          type: number
      - name: per_page
        required: false
        in: query
        description: 'How many items to return per page. Max: 100'
        schema:
          minimum: 1
          maximum: 100
          default: 25
          type: number
      - name: import_job_uid
        required: true
        in: query
        description: Import job UID
        schema:
          type: string
      - name: status
        required: false
        in: query
        description: Status of the import job item
        schema:
          type: string
      responses:
        '200':
          description: List of import job items
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/Response'
                - properties:
                    data:
                      $ref: '#/components/schemas/MultiImportJobItemsResponseDto'
      security:
      - Bearer: []
  /v3/integrations/import_job_items/{uid}:
    get:
      tags:
      - Import
      summary: Retrieve an ImportJobItem
      description: '## Overview

        Retrieve an import job item by its UID.


        Available for **Staff, Directory, and Client tokens**'
      operationId: ImportJobItemsController_findOne
      parameters:
      - name: uid
        required: true
        in: path
        schema:
          type: string
      responses:
        '200':
          description: Import job item details
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/Response'
                - properties:
                    data:
                      $ref: '#/components/schemas/MultiImportJobItemsResponseDto/properties/import_job_items/items'
      security:
      - Bearer: []
  /v3/integrations/import_jobs:
    post:
      tags:
      - Import
      summary: Create a new ImportJob
      description: '## Overview

        Import products into a business account Available for **Staff Tokens**.'
      operationId: ImportJobsController_create
      requestBody:
        required: true
        content:
          multipart/form-data:
            schema:
              $ref: '#/components/schemas/UploadEntityRequestDto'
      responses:
        '201':
          description: Import job created successfully
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/Response'
                - properties:
                    data:
                      $ref: '#/paths/~1v3~1integrations~1import_jobs~1%7Buid%7D/get/responses/200/content/application~1json/schema/allOf/1/properties/data'
                      description: Import job details
      security:
      - Bearer: []
  /v3/integrations/import_jobs/{uid}:
    get:
      tags:
      - Import
      parameters:
      - name: uid
        required: true
        in: path
        schema:
          type: string
      summary: Retrieve an ImportJob
      description: '## Overview

        Retrieve an import job by its UID.


        Available for **Staff, Directory, and Client tokens**'
      operationId: ImportJobsController_findOne
      responses:
        '200':
          description: Import job details
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/Response'
                - properties:
                    data:
                      type: object
                      properties:
                        uid:
                          type: string
                          description: Unique identifier of the import job
                        provider_type:
                          type: string
                          enum:
                          - excel
                          - import_job
                          description: The type of import provider
                        provider_data:
                          description: The data used by the provider to import the records
                          oneOf:
                          - type: object
                            properties:
                              entity_type:
                                type: string
                                description: Type of entity being imported
                              original_file_name:
                                type: string
                                description: Name of the uploaded file
                            required:
                            - entity_type
                            - original_file_name
                            description: Excel provider configuration
                          - type: object
                            properties:
                              source_import_job_uid:
                                type: string
                                description: The UID of the import job that was used for validation
                            required:
                            - source_import_job_uid
                            description: Existing import job configuration
                        job_type:
                          type: string
                          enum:
                          - validate
                          - execute
                          description: 'The type of job operation. ''validate'' will go over the lines and return errors, use /v3/integrations/import_job_items to get detailed errors about each line.

                            ''execute'' will run the import job. use /v3/integrations/import_job to get the progress of the import task.'
                        status:
                          type: string
                          enum:
                          - pending
                          - processing
                          - done
                          - error
                          description: Current status of the import job
                        error_message:
                          type: string
                          description: Error message if the job failed
                        progress:
                          type: object
                          properties:
                            total:
                              type: number
                              description: Total number of records to be processed
                            done:
                              type: number
                              description: Number of records successfully processed
                            error:
                              type: number
                              description: Number of records that failed processing
                            pending:
                              type: number
                              description: Number of records pending processing
                          required:
                          - total
                          - done
                          - error
                          - pending
                        created_at:
                          type: string
                          format: date-time
                          description: Creation timestamp
                        updated_at:
                          type: string
                          format: date-time
                          description: Last update timestamp
                        metadata:
                          type: object
                          properties:
                            data_row_index:
                              type: number
                              description: Index of the data row being processed
                            locale:
                              type: string
                              description: Locale setting for the import job
                            shared_entity_data:
                              type: object
                              description: Shared entity data for the import job, this data is shared between all the import job items
                          description: Additional metadata for the import job
                      required:
                      - uid
                      - provider_type
                      - provider_data
                      - job_type
                      - status
                      - error_message
                      - progress
                      - created_at
                      - updated_at
                      example:
                        uid: job-xyz789
                        provider_type: excel
                        provider_data:
                          entity_type: products
                          original_file_name: import.xlsx
                        job_type: execute
                        status: processing
                        error_message: null
                        progress:
                          total: 100
                          done: 42
                          error: 3
                          pending: 55
                        metadata:
                          data_row_index: 5
                          locale: en
                          shared_entity_data:
                            tax_ids:
                            - 12345678yyu90
                            - heuh39759nmf
                        created_at: '2023-01-15T08:00:00.000Z'
                        updated_at: '2023-01-15T08:30:00.000Z'
                      description: Defines an import job for validating or executing bulk data imports, with progress and metadata.
      security:
      - Bearer: []
components:
  schemas:
    UploadEntityRequestDto:
      type: object
      properties:
        entity_type:
          type: string
          enum:
          - products
          description: The type of the imported entity
        provider_type:
          type: string
          enum:
          - excel
          - import_job
          description: The type of import provider
        provider_data:
          description: Provider-specific configuration data
          oneOf:
          - $ref: '#/components/schemas/ExcelProviderDataDto'
            description: Excel provider configuration
          - $ref: '#/components/schemas/ExistingImportJobDto'
            description: Existing import job configuration
        job_type:
          type: string
          enum:
          - validate
          - execute
          default: execute
          description: 'The type of job operation. ''validate'' will go over the lines and return errors, use /v3/integrations/import_job_items to get detailed errors about each line.

            ''execute'' will run the import job. use /v3/integrations/import_job to get the progress of the import task.'
        locale:
          type: string
          enum:
          - en
          - he
          - es
          - fr
          - de
          - it
          - nl
          - pt
          - zh
          description: The locale of the import job, in use for translating error messages of the import job items
        shared_entity_data:
          type: object
          description: Shared entity data for the import job, this data is shared between all import job items
      required:
      - provider_type
    MultiImportJobItemsResponseDto:
      type: object
      properties:
        import_job_items:
          type: array
          items:
            type: object
            properties:
              uid:
                type: string
                description: Unique identifier of the import job item
              import_job_uid:
                type: string
                description: Reference to the parent import job
              action:
                type: string
                enum:
                - create
                - update
                - skip
                description: The action performed for this record
              line_number:
                type: number
                description: Line number in the source file
              entity:
                type: object
                description: The entity data being imported
              status:
                type: string
                enum:
                - pending
                - processing
                - done
                - error
                description: Current status of the import detail
              error_message:
                type: string
                description: Error message if the import failed
              created_at:
                type: string
                format: date-time
                description: Creation timestamp
              updated_at:
                type: string
                format: date-time
                description: Last update timestamp
            required:
            - uid
            - import_job_uid
            - action
            - line_number
            - status
            - created_at
            - updated_at
            example:
              uid: item-123abc
              import_job_uid: job-xyz789
              action: create
              line_number: 42
              entity:
                name: John Doe
                email: john@example.com
              status: done
              error_message: null
              created_at: '2023-01-15T08:30:00.000Z'
              updated_at: '2023-01-15T08:35:00.000Z'
            description: Represents a single record processed by an import job, with action and status.
      required:
      - import_job_items
    ExcelProviderDataDto:
      type: object
      title: Excel Provider Data
      properties:
        file:
          type: string
          format: binary
          description: The file containing the records that should be imported
      required:
      - file
    ExistingImportJobDto:
      type: object
      title: Existing Import Job
      properties:
        source_import_job_uid:
          type: string
          description: The UID of the import job that was used for validation
      required:
      - source_import_job_uid
    Response:
      type: object
      properties:
        success:
          type: boolean
        data:
          type: object
      required:
      - success
      - data
  securitySchemes:
    Bearer:
      type: http
      scheme: bearer
      bearerFormat: JWT
      description: 'Provide a valid bearer token in the Authorization header. Example: ''Authorization: Bearer {app_token}'''
x-provenance:
  method: searched
  source: https://developers.intandem.tech:443/reference
  harvested: '2026-11-15'
  tool: harvest-readme-openapi.py
  note: Assembled verbatim from the OpenAPI definition ReadMe embeds in each operation page of the provider's developer portal; paths and components merged by API title, nothing authored.
  assembled_from:
  - https://developers.intandem.tech/reference/delete_v3-integrations-idp-actor-mappings-uid.md
  - https://developers.intandem.tech/reference/get_v3-integrations-idp-actor-mappings.md
  - https://developers.intandem.tech/reference/importjobitemscontroller_findall.md
  - https://developers.intandem.tech/reference/importjobitemscontroller_findone.md
  - https://developers.intandem.tech/reference/importjobscontroller_create.md
  - https://developers.intandem.tech/reference/importjobscontroller_findone.md
  - https://developers.intandem.tech/reference/post_v3-integrations-idp-actor-mappings.md
  - https://developers.intandem.tech:443/reference/delete_v3-integrations-idp-actor-mappings-uid.md
  - https://developers.intandem.tech:443/reference/get_v3-integrations-idp-actor-mappings.md
  - https://developers.intandem.tech:443/reference/importjobitemscontroller_findall.md
  - https://developers.intandem.tech:443/reference/importjobitemscontroller_findone.md
  - https://developers.intandem.tech:443/reference/importjobscontroller_create.md
  - https://developers.intandem.tech:443/reference/importjobscontroller_findone.md
  - https://developers.intandem.tech:443/reference/post_v3-integrations-idp-actor-mappings.md
  merge:
    pages: 14
    deduped: 40
    conflicts_kept_first: 0