Appmixer

opencollection: 1.0.0
info:
  name: Appmixer API
  version: 6.1.0
request:
  auth:
    type: bearer
    token: '{{bearerToken}}'
items:
- info:
    name: System
    type: folder
  items:
  - info:
      name: Appmixer Get API information
      type: http
    http:
      method: GET
      url: https://api.{tenant}.appmixer.cloud/
    docs: Basic liveness check that returns basic API information about the Appmixer instance.
- info:
    name: Authentication
    type: folder
  items:
  - info:
      name: Appmixer Authenticate user
      type: http
    http:
      method: POST
      url: https://api.{tenant}.appmixer.cloud/user/auth
      body:
        type: json
        data: '{}'
    docs: Sign in a user with credentials and obtain an access token for authenticating subsequent API requests.
- info:
    name: Users
    type: folder
  items:
  - info:
      name: Appmixer Get current user
      type: http
    http:
      method: GET
      url: https://api.{tenant}.appmixer.cloud/user
    docs: Get information about the currently authenticated user.
  - info:
      name: Appmixer Create a new user
      type: http
    http:
      method: POST
      url: https://api.{tenant}.appmixer.cloud/user
      body:
        type: json
        data: '{}'
    docs: Create a new Appmixer user account. By default, this endpoint is open and does not require authentication.
  - info:
      name: Appmixer Update a user
      type: http
    http:
      method: PUT
      url: https://api.{tenant}.appmixer.cloud/users/:userId
      params:
      - name: userId
        value: ''
        type: path
      body:
        type: json
        data: '{}'
    docs: Update user information for the specified user.
  - info:
      name: Appmixer Delete a user
      type: http
    http:
      method: DELETE
      url: https://api.{tenant}.appmixer.cloud/users/:userId
      params:
      - name: userId
        value: ''
        type: path
    docs: Delete the specified user account.
- info:
    name: Flows
    type: folder
  items:
  - info:
      name: Appmixer List flows
      type: http
    http:
      method: GET
      url: https://api.{tenant}.appmixer.cloud/flows
      params:
      - name: limit
        value: ''
        type: query
        description: Maximum number of flows to return
      - name: offset
        value: ''
        type: query
        description: Number of flows to skip
      - name: pattern
        value: ''
        type: query
        description: Filter flows by name pattern
      - name: sort
        value: ''
        type: query
        description: Sort field and direction
      - name: projection
        value: ''
        type: query
        description: Comma-separated list of properties to exclude
      - name: filter
        value: ''
        type: query
        description: Filter expression
    docs: Get all flows of the authenticated user. Supports filtering, sorting, and pagination.
  - info:
      name: Appmixer Create a flow
      type: http
    http:
      method: POST
      url: https://api.{tenant}.appmixer.cloud/flows
      body:
        type: json
        data: '{}'
    docs: Create a new flow in Appmixer.
  - info:
      name: Appmixer Get a flow
      type: http
    http:
      method: GET
      url: https://api.{tenant}.appmixer.cloud/flows/:flowId
      params:
      - name: flowId
        value: ''
        type: path
    docs: Get details of a specific flow by its ID.
  - info:
      name: Appmixer Update a flow
      type: http
    http:
      method: PUT
      url: https://api.{tenant}.appmixer.cloud/flows/:flowId
      params:
      - name: flowId
        value: ''
        type: path
      - name: forceUpdate
        value: ''
        type: query
        description: Force update a running flow
      body:
        type: json
        data: '{}'
    docs: Update an existing flow. A running flow cannot be updated without the forceUpdate query parameter.
  - info:
      name: Appmixer Delete a flow
      type: http
    http:
      method: DELETE
      url: https://api.{tenant}.appmixer.cloud/flows/:flowId
      params:
      - name: flowId
        value: ''
        type: path
    docs: Delete an existing flow by its ID.
  - info:
      name: Appmixer Start a flow
      type: http
    http:
      method: PUT
      url: https://api.{tenant}.appmixer.cloud/flows/:flowId/start
      params:
      - name: flowId
        value: ''
        type: path
    docs: Start a stopped flow.
  - info:
      name: Appmixer Stop a flow
      type: http
    http:
      method: PUT
      url: https://api.{tenant}.appmixer.cloud/flows/:flowId/stop
      params:
      - name: flowId
        value: ''
        type: path
    docs: Stop a running flow.
- info:
    name: Apps
    type: folder
  items:
  - info:
      name: Appmixer List apps
      type: http
    http:
      method: GET
      url: https://api.{tenant}.appmixer.cloud/apps
    docs: Get all applications (services or modules) available in the Appmixer tenant.
  - info:
      name: Appmixer List components
      type: http
    http:
      method: GET
      url: https://api.{tenant}.appmixer.cloud/components
    docs: Get all available components (connectors) in the tenant.
  - info:
      name: Appmixer Publish a component
      type: http
    http:
      method: POST
      url: https://api.{tenant}.appmixer.cloud/components
      body:
        type: json
        data: '{}'
    docs: Publish a new component, module, or service to the Appmixer tenant.
  - info:
      name: Appmixer Delete a component
      type: http
    http:
      method: DELETE
      url: https://api.{tenant}.appmixer.cloud/components/:componentId
      params:
      - name: componentId
        value: ''
        type: path
        description: Component identifier (e.g. appmixer.myservice)
    docs: Delete (uninstall) a component, module, or service.
- info:
    name: Accounts
    type: folder
  items:
  - info:
      name: Appmixer List accounts
      type: http
    http:
      method: GET
      url: https://api.{tenant}.appmixer.cloud/accounts
    docs: Get list of all accounts the user has authenticated with to any component (e.g. OAuth connections to third-party
      services).
  - info:
      name: Appmixer Get an account
      type: http
    http:
      method: GET
      url: https://api.{tenant}.appmixer.cloud/accounts/:accountId
      params:
      - name: accountId
        value: ''
        type: path
    docs: Get details for a specific account and check if its credentials (tokens) are still valid.
  - info:
      name: Appmixer Delete an account
      type: http
    http:
      method: DELETE
      url: https://api.{tenant}.appmixer.cloud/accounts/:accountId
      params:
      - name: accountId
        value: ''
        type: path
    docs: Delete (disconnect) an authenticated account.
- info:
    name: Files
    type: folder
  items:
  - info:
      name: Appmixer List files
      type: http
    http:
      method: GET
      url: https://api.{tenant}.appmixer.cloud/files
    docs: Get all files belonging to the authenticated user.
  - info:
      name: Appmixer Upload a file
      type: http
    http:
      method: POST
      url: https://api.{tenant}.appmixer.cloud/files
      body:
        type: multipart-form
        data:
        - name: file
          type: text
          value: ''
    docs: Upload a new file to the Appmixer file management system.
  - info:
      name: Appmixer Get a file
      type: http
    http:
      method: GET
      url: https://api.{tenant}.appmixer.cloud/files/:fileId
      params:
      - name: fileId
        value: ''
        type: path
    docs: Download or get details of a specific file.
  - info:
      name: Appmixer Delete a file
      type: http
    http:
      method: DELETE
      url: https://api.{tenant}.appmixer.cloud/files/:fileId
      params:
      - name: fileId
        value: ''
        type: path
    docs: Delete a specific file.
- info:
    name: Data Stores
    type: folder
  items:
  - info:
      name: Appmixer List data stores
      type: http
    http:
      method: GET
      url: https://api.{tenant}.appmixer.cloud/data-stores
    docs: Get all data stores belonging to the authenticated user.
  - info:
      name: Appmixer Get a data store
      type: http
    http:
      method: GET
      url: https://api.{tenant}.appmixer.cloud/data-stores/:storeId
      params:
      - name: storeId
        value: ''
        type: path
    docs: Get details of a specific data store.
  - info:
      name: Appmixer Delete a data store
      type: http
    http:
      method: DELETE
      url: https://api.{tenant}.appmixer.cloud/data-stores/:storeId
      params:
      - name: storeId
        value: ''
        type: path
    docs: Delete a specific data store.
- info:
    name: Insights
    type: folder
  items:
  - info:
      name: Appmixer List insights
      type: http
    http:
      method: GET
      url: https://api.{tenant}.appmixer.cloud/insights
    docs: Get all Insights charts of the authenticated user.
- info:
    name: People Tasks
    type: folder
  items:
  - info:
      name: Appmixer List people tasks
      type: http
    http:
      method: GET
      url: https://api.{tenant}.appmixer.cloud/people-task/tasks
      params:
      - name: role
        value: ''
        type: query
        description: Filter tasks by role
    docs: Get all tasks of the authenticated user. Can filter by role (approver or requester).
- info:
    name: Logs
    type: folder
  items:
  - info:
      name: Appmixer Get logs
      type: http
    http:
      method: GET
      url: https://api.{tenant}.appmixer.cloud/logs
      params:
      - name: flowId
        value: ''
        type: query
        description: Filter logs by flow ID
      - name: limit
        value: ''
        type: query
        description: Maximum number of log entries to return
      - name: offset
        value: ''
        type: query
        description: Number of entries to skip
    docs: Retrieve logs for the authenticated user's flows.
- info:
    name: Messages
    type: folder
  items:
  - info:
      name: Appmixer List unprocessed messages
      type: http
    http:
      method: GET
      url: https://api.{tenant}.appmixer.cloud/unprocessed-messages
    docs: Get the list of unprocessed messages.
  - info:
      name: Appmixer Reprocess a message
      type: http
    http:
      method: POST
      url: https://api.{tenant}.appmixer.cloud/unprocessed-messages/:messageId
      params:
      - name: messageId
        value: ''
        type: path
    docs: Put an unprocessed message back into the Appmixer engine.
  - info:
      name: Appmixer Delete an unprocessed message
      type: http
    http:
      method: DELETE
      url: https://api.{tenant}.appmixer.cloud/unprocessed-messages/:messageId
      params:
      - name: messageId
        value: ''
        type: path
    docs: Delete a specific unprocessed message.
bundled: true