Jitterbit API

openapi: 3.1.0
info:
  title: Jitterbit API
  version: '2026-10-20'
  description: 'GENERATED FROM DOCUMENTATION by API Evangelist on 2026-10-20: 19 operation(s) read from 7 public documentation page(s) (each operation
    names its page in x-source). This is not the provider''s published contract; Jitterbit has published no machine-readable contract that the
    pipeline could find. Engine: local.'
  x-evidence-tiers:
    code-example: 4
    documentation: 15
    pages-with-code: 4
    pages-read: 7
  x-generated-from: documentation
  x-provenance: generated
  x-authored-by: API Evangelist
  x-generated: '2026-10-20'
  x-generator: generate-contract-from-docs.py
  x-engine: local
  x-sources:
  - https://docs.jitterbit.com/app-builder/deploy/endpoint
  - https://docs.jitterbit.com/api-manager/api-manager-reference/api-manager-log-service-api
  - https://docs.jitterbit.com/api-manager/endpoint-communication
  - https://docs.jitterbit.com/app-builder/connect/rest
  - https://docs.jitterbit.com/app-builder/security/providers/api-key
  - https://docs.jitterbit.com/app-builder/connect/rest/rest-api-examples
  - https://docs.jitterbit.com/design-studio/design-studio-reference/jitterbit-connect-wizards/salesforce-wizards
servers:
- url: https://na-east.jitterbit.com
paths:
  /:
    get:
      operationId: get
      tags:
      - Api
      summary: GET /
      x-source: https://docs.jitterbit.com/api-manager/endpoint-communication
      responses:
        '200':
          description: Success (status as documented)
      x-evidence:
        kind: code-example
        language: curl
        snippet: "curl --proxy http://proxy.company.com:8080 https://ca.example.com\n For OpenSSL, consider configuring proxy at the system level\
          \ or tunnel through a tool like cntlm . \n Request a policy exception (if needed) \n If access to a particular CA or endpoint is blocked,\
          \ you can request an exception: \n Submit a request to your network security team or Zscaler administrator for a temporary or permanent\
          \ except"
  /Vinyl/rest/v1/sales/customers:
    get:
      operationId: get_Vinyl_rest_v1_sales_customers
      tags:
      - Vinyl
      summary: GET /Vinyl/rest/v1/sales/customers
      x-source: https://docs.jitterbit.com/app-builder/security/providers/api-key
      responses:
        '200':
          description: Success (status as documented)
      x-evidence:
        kind: code-example
        language: http
        snippet: " GET /Vinyl/rest/v1/sales/customers HTTP/1.1\nHost: example.com:443\nAccept: application/json\nX-API-Key: ABCd0eFG1hiJKLMnOPQr2s\n\
          \ This is the default behavior, which App Builder selects automatically. You can also use the HttpHeaderName parameter when configuring\
          \ your API key to change the name of the HTTP header that will pass the API key from the default X-API-Key . \n The following examples\
          \ are som"
  /collection:
    get:
      operationId: get_collection
      tags:
      - Collection
      summary: 'GET /collection : Retrieves the items within a collection. This maps to the Filter event.'
      x-source: https://docs.jitterbit.com/app-builder/connect/rest
      responses:
        '200':
          description: Success (status as documented)
      x-evidence:
        kind: documentation
  /collection/item:
    delete:
      operationId: delete_collection_item
      tags:
      - Collection
      summary: 'DELETE /collection/item : Deletes an item from the collection. This maps to the Delete event.'
      x-source: https://docs.jitterbit.com/app-builder/connect/rest
      responses:
        '200':
          description: Success (status as documented)
      x-evidence:
        kind: documentation
    get:
      operationId: get_collection_item
      tags:
      - Collection
      summary: 'GET /collection/item : Retrieves a single item from the collection. This maps to the Filter event.'
      x-source: https://docs.jitterbit.com/app-builder/connect/rest
      responses:
        '200':
          description: Success (status as documented)
      x-evidence:
        kind: documentation
    post:
      operationId: post_collection_item
      tags:
      - Collection
      summary: 'POST /collection/item : Updates an item in the collection. This maps to the Update event.'
      x-source: https://docs.jitterbit.com/app-builder/connect/rest
      responses:
        '201':
          description: Success (status as documented)
      x-evidence:
        kind: documentation
  /jitterbit-cloud-restful-service/api/analytics/log-async/{orgid}/{key}:
    get:
      operationId: get_jitterbit_cloud_restful_service_api_analytics_log_async_orgid_key
      tags:
      - Jitterbit Cloud Restful Service
      summary: Retrieve API logs asynchronously (Beta)
      x-source: https://docs.jitterbit.com/api-manager/api-manager-reference/api-manager-log-service-api
      parameters:
      - name: orgid
        in: path
        required: true
        schema:
          type: string
      - name: key
        in: path
        required: true
        schema:
          type: string
      - name: Content-Type
        in: header
        required: true
        schema:
          type: string
        description: Indicates the format that will be sent in the request.
      - name: Accept
        in: header
        required: true
        schema:
          type: string
        description: Indicates the format that will be accepted in the response.
      - name: authToken
        in: header
        required: true
        schema:
          type: string
        description: Passes the authorization token (authenticationToken) returned by the User Service Controller API.
      responses:
        '200':
          description: Success (status as documented)
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetJitterbitCloudRestfulServiceApiAnalyticsLogAsyncOrgidKeyR'
      x-evidence:
        kind: documentation
  /jitterbit-cloud-restful-service/user/login:
    put:
      operationId: put_jitterbit_cloud_restful_service_user_login
      tags:
      - Jitterbit Cloud Restful Service
      summary: PUT /jitterbit-cloud-restful-service/user/login
      x-source: https://docs.jitterbit.com/api-manager/api-manager-reference/api-manager-log-service-api
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PutJitterbitCloudRestfulServiceUserLoginRequest'
      responses:
        '200':
          description: Success (shape read from the example response on the page)
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PutJitterbitCloudRestfulServiceUserLoginResponse'
      x-evidence:
        kind: code-example
        language: curl
        snippet: "curl or applications such as Postman. \n To use the API Manager Log Service API (Beta), after enabling API logs for the API\
          \ Manager API, follow these steps: \n Retrieve an authentication token using the User Service Controller API. This token is required\
          \ in order to use the API Manager Log Service API (Beta). \n If your Harmony organization does not have two-factor authentication (TFA)\
          \ enabled, retri"
  /rest/v1/sales/customers:
    get:
      operationId: get_rest_v1_sales_customers
      tags:
      - Rest
      summary: GET /rest/v1/sales/customers
      x-source: https://docs.jitterbit.com/app-builder/connect/rest/rest-api-examples
      responses:
        '200':
          description: Success (status as documented)
      x-evidence:
        kind: code-example
        language: http
        snippet: " GET /rest/v1/sales/customers HTTP/1.1\nHost: example.com:443\nAccept: application/json\nX-API-Key: DLOo9sPS5slJEMHpXBFt3g\n\
          \ Response \n HTTP/ 1.1 200 OK \n Co ntent - Type : applica t io n /jso n ; charse t =u tf -8 \n Co ntent - Le n g t h : 534 \n { \n\
          \ \"count\" : null , \n \"items\" : [ \n { \n \"customerId\" : \"0243783f-7405-4ede-98fb-98b6ce7d71f8\" , \n \"companyName\" : \"Microsoft\"\
          \ , \n \"contactName\" : \"Satya Nad"
    post:
      operationId: post_rest_v1_sales_customers
      tags:
      - Rest
      summary: Create a new customer
      x-source: https://docs.jitterbit.com/app-builder/connect/rest/rest-api-examples
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PostRestV1SalesCustomersRequest'
      responses:
        '201':
          description: Success (status as documented)
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PostRestV1SalesCustomersResponse'
      x-evidence:
        kind: documentation
  /rest/v1/sales/customers/9ce33474-8690-4a75-ab90-65caa6c3c24e:
    delete:
      operationId: delete_rest_v1_sales_customers_9ce33474_8690_4a75_ab90_65caa6c3c24e
      tags:
      - Rest
      summary: Delete an existing customer
      x-source: https://docs.jitterbit.com/app-builder/connect/rest/rest-api-examples
      responses:
        '200':
          description: Success (status as documented)
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DeleteRestV1SalesCustomers9Ce3347486904A75Ab9065Caa6C3C24ERe'
      x-evidence:
        kind: documentation
    get:
      operationId: get_rest_v1_sales_customers_9ce33474_8690_4a75_ab90_65caa6c3c24e
      tags:
      - Rest
      summary: Retrieve an existing customer
      x-source: https://docs.jitterbit.com/app-builder/connect/rest/rest-api-examples
      responses:
        '200':
          description: Success (status as documented)
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetRestV1SalesCustomers9Ce3347486904A75Ab9065Caa6C3C24ERespo'
      x-evidence:
        kind: documentation
  /rest/v1/vinyl-deploy/metadata:
    get:
      operationId: get_rest_v1_vinyl_deploy_metadata
      tags:
      - Rest
      summary: Retrieve the environment configuration.
      x-source: https://docs.jitterbit.com/app-builder/deploy/endpoint
      responses:
        '200':
          description: Success (status as documented)
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetRestV1VinylDeployMetadataResponse'
      x-evidence:
        kind: documentation
  /rest/v1/vinyl-deploy/release:
    get:
      operationId: get_rest_v1_vinyl_deploy_release
      tags:
      - Rest
      summary: Retrieve release information.
      x-source: https://docs.jitterbit.com/app-builder/deploy/endpoint
      parameters:
      - name: solutionId
        in: query
        required: true
        schema:
          type: string
        description: Solution identifier.
      responses:
        '200':
          description: Success (status as documented)
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetRestV1VinylDeployReleaseResponse'
      x-evidence:
        kind: documentation
    post:
      operationId: post_rest_v1_vinyl_deploy_release
      tags:
      - Rest
      summary: Build a release.
      x-source: https://docs.jitterbit.com/app-builder/deploy/endpoint
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PostRestV1VinylDeployReleaseRequest'
      responses:
        '201':
          description: Success (status as documented)
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PostRestV1VinylDeployReleaseResponse'
      x-evidence:
        kind: documentation
  /rest/v1/vinyl-deploy/release-queue:
    post:
      operationId: post_rest_v1_vinyl_deploy_release_queue
      tags:
      - Rest
      summary: Queue a release build.
      x-source: https://docs.jitterbit.com/app-builder/deploy/endpoint
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PostRestV1VinylDeployReleaseQueueRequest'
      responses:
        '201':
          description: Success (status as documented)
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PostRestV1VinylDeployReleaseQueueResponse'
      x-evidence:
        kind: documentation
  /rest/v1/vinyl-deploy/release-queue/{releaseid}:
    get:
      operationId: get_rest_v1_vinyl_deploy_release_queue_releaseid
      tags:
      - Rest
      summary: Retrieve the current status of a queued release.
      x-source: https://docs.jitterbit.com/app-builder/deploy/endpoint
      parameters:
      - name: releaseid
        in: path
        required: true
        schema:
          type: string
      - name: solutionId
        in: query
        required: false
        schema:
          type: string
        description: Solution identifier.
      responses:
        '200':
          description: Success (status as documented)
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetRestV1VinylDeployReleaseQueueReleaseidResponse'
      x-evidence:
        kind: documentation
  /rest/v1/vinyl-deploy/release/{releaseid}:
    get:
      operationId: get_rest_v1_vinyl_deploy_release_releaseid
      tags:
      - Rest
      summary: GET /rest/v1/vinyl-deploy/release/{releaseid}
      x-source: https://docs.jitterbit.com/app-builder/deploy/endpoint
      parameters:
      - name: releaseid
        in: path
        required: true
        schema:
          type: string
      - name: solutionId
        in: query
        required: false
        schema:
          type: string
        description: Solution identifier.
      responses:
        '200':
          description: Success (status as documented)
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetRestV1VinylDeployReleaseReleaseidResponse'
      x-evidence:
        kind: documentation
  /{resource}:
    post:
      operationId: post_resource
      tags:
      - Api
      summary: 'To invoke a custom event, send a POST request using the following syntax: POST /{Resource}({EventName})/{RecordID}'
      x-source: https://docs.jitterbit.com/app-builder/connect/rest
      parameters:
      - name: resource
        in: path
        required: true
        schema:
          type: string
      responses:
        '201':
          description: Success (status as documented)
      x-evidence:
        kind: documentation
components:
  schemas:
    GetJitterbitCloudRestfulServiceApiAnalyticsLogAsyncOrgidKeyR:
      type: object
      properties:
        key:
          type: string
          description: Reference key for tracking and downloading the API log file.
        status:
          type: string
          description: Status of the log file generation (e.g., COMPLETE, PROCESSING, etc.).
    PutJitterbitCloudRestfulServiceUserLoginRequest:
      type: object
      properties:
        email:
          type: string
        password:
          type: string
    PutJitterbitCloudRestfulServiceUserLoginResponse:
      type: object
      properties:
        status:
          type: boolean
        operation:
          type: string
        authenticationToken:
          type: string
        serverUrl:
          type: string
        cloudAppsUrl:
          type: string
        orgAttrs:
          type: array
          items:
            type: object
            properties:
              orgId:
                type: string
              orgName:
                type: string
              orgZoneUrl:
                type: string
        defaultOrgId:
          type: string
        sessionTimeoutInSeconds:
          type: integer
    PostRestV1SalesCustomersRequest:
      type: object
      properties:
        companyName:
          type: string
        city:
          type: string
        region:
          type: string
        postalCode:
          type: string
        country:
          type: string
      required:
      - companyName
    PostRestV1SalesCustomersResponse:
      type: object
      properties:
        item:
          type: object
          description: Created customer record
        message:
          type: string
          description: Optional message
        validations:
          type: array
          description: Validation messages
        status:
          type: integer
          description: HTTP status code
    DeleteRestV1SalesCustomers9Ce3347486904A75Ab9065Caa6C3C24ERe:
      type: object
      properties:
        item:
          type: object
          description: Deleted customer record
        message:
          type: string
          description: Optional message
        validations:
          type: array
          description: Validation messages
        status:
          type: integer
          description: HTTP status code
    GetRestV1SalesCustomers9Ce3347486904A75Ab9065Caa6C3C24ERespo:
      type: object
      properties:
        item:
          type: object
          description: Customer record
        message:
          type: string
          description: Optional message
        validations:
          type: array
          description: Validation messages
        status:
          type: integer
          description: HTTP status code
    GetRestV1VinylDeployMetadataResponse:
      type: object
      properties:
        environmentId:
          type: string
          description: Environment identifier.
        name:
          type: string
          description: Environment name, e.g. QA or Production.
        url:
          type: string
          description: Canonical environment root URL.
        supportsDeployment:
          type: boolean
          description: Indicates whether the environment supports deployments.
        supportsInstallOnDeploy:
          type: boolean
          description: Indicates whether the environment allows packages to be installed during the deployment process.
        authenticationType:
          type: string
          description: Denotes the required authentication type.
    GetRestV1VinylDeployReleaseResponse:
      type: object
      properties:
        count:
          type: string
        items:
          type: array
          description: Array of release objects.
        message:
          type: string
        validations:
          type: array
        status:
          type: integer
    PostRestV1VinylDeployReleaseRequest:
      type: object
      properties:
        solutionId:
          type: string
          description: Solution identifier.
        releaseNotes:
          type: string
          description: Developer‑supplied release notes.
        snapshot:
          type: boolean
          description: Flag to indicate if a snapshot should be taken before the release is built.
      required:
      - solutionId
    PostRestV1VinylDeployReleaseResponse:
      type: object
      properties:
        item:
          type: object
          description: Built release details.
        message:
          type: string
        validations:
          type: array
        status:
          type: integer
    PostRestV1VinylDeployReleaseQueueRequest:
      type: object
      properties:
        solutionId:
          type: string
          description: Solution identifier.
        releaseNotes:
          type: string
          description: Developer‑supplied release notes.
        snapshot:
          type: boolean
          description: Flag to indicate if a snapshot should be taken before the release is built.
      required:
      - solutionId
    PostRestV1VinylDeployReleaseQueueResponse:
      type: object
      properties:
        item:
          type: object
          description: Queued release details.
        message:
          type: string
        validations:
          type: array
        status:
          type: integer
    GetRestV1VinylDeployReleaseQueueReleaseidResponse:
      type: object
      properties:
        item:
          type: object
          description: Release status details.
        message:
          type: string
        validations:
          type: array
        status:
          type: integer
    GetRestV1VinylDeployReleaseReleaseidResponse:
      type: object
      properties:
        item:
          type: object
          description: Release details.
        message:
          type: string
        validations:
          type: array
        status:
          type: integer
  securitySchemes:
    apiKey:
      type: apiKey
      in: header
      name: X-API-Key
security:
- apiKey: []
tags:
- name: Api
- name: Collection
- name: Jitterbit Cloud Restful Service
- name: Rest
- name: Vinyl