Salesforce AppMenu API

openapi: 3.1.0
info:
  title: Salesforce Bulk API 2.0 Abort AppMenu API
  description: 'Salesforce Bulk API 2.0 is a simplified, REST-based interface for bulk data operations that improves on the original Bulk API. It uses a straightforward job model and supports CSV format for ingest and query jobs, enabling processing of millions of records asynchronously.

    '
  version: v63.0
  contact:
    name: Salesforce Developers
    url: https://developer.salesforce.com/
  license:
    name: Salesforce Developer Terms
    url: https://www.salesforce.com/company/legal/agreements/
servers:
- url: https://{instance}.salesforce.com/services/data/v{version}/jobs
  description: Salesforce Bulk API 2.0 jobs endpoint
  variables:
    instance:
      default: yourInstance
      description: 'The Salesforce instance identifier (e.g., na1, eu3, or a My Domain subdomain like mycompany).

        '
    version:
      default: '63.0'
      description: 'The Salesforce API version number (e.g., 63.0). Use the latest supported version for new integrations.

        '
security:
- BearerAuth: []
tags:
- name: AppMenu
  description: Retrieve Salesforce application menu items.
paths:
  /appMenu/AppSwitcher:
    get:
      operationId: getAppSwitcherMenu
      summary: Salesforce Get the App Switcher Menu
      description: 'Returns the list of applications available in the Salesforce App Switcher menu for the currently authenticated user. Each entry includes the app label, icon URL, and navigation URL. Use this to build custom navigation or app launchers in connected applications.

        '
      tags:
      - AppMenu
      responses:
        '200':
          description: App switcher menu entries available to the current user.
          content:
            application/json:
              schema:
                type: object
                properties:
                  appMenuItems:
                    type: array
                    description: List of app switcher menu items.
                    items:
                      type: object
                      properties:
                        name:
                          type: string
                          description: API name of the application.
                        label:
                          type: string
                          description: Display label of the application.
                        iconUrl:
                          type: string
                          format: uri
                          description: URL of the application icon.
                        url:
                          type: string
                          format: uri
                          description: Navigation URL for the application.
                        type:
                          type: string
                          description: Type of menu item (e.g., App, Tab).
              examples:
                Getappswitchermenu200Example:
                  summary: Default getAppSwitcherMenu 200 response
                  x-microcks-default: true
                  value:
                    appMenuItems:
                    - name: Example Title
                      label: Example Title
                      iconUrl: https://www.example.com
                      url: https://www.example.com
                      type: example_value
        '401':
          description: Unauthorized. Invalid or expired OAuth token.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
              examples:
                Getappswitchermenu401Example:
                  summary: Default getAppSwitcherMenu 401 response
                  x-microcks-default: true
                  value:
                    message: example_value
                    errorCode: example_value
                    fields:
                    - example_value
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
components:
  schemas:
    Error:
      type: object
      description: 'An error response from the Salesforce REST API, describing the problem with the request.

        '
      properties:
        message:
          type: string
          description: Human-readable description of the error.
          example: example_value
        errorCode:
          type: string
          description: 'Salesforce error code (e.g., MALFORMED_QUERY, INVALID_FIELD, REQUIRED_FIELD_MISSING).

            '
          example: example_value
        fields:
          type: array
          description: 'List of field names related to the error, if applicable (e.g., for field validation errors).

            '
          items:
            type: string
          example: []
  securitySchemes:
    BearerAuth:
      type: http
      scheme: bearer
      description: 'OAuth 2.0 Bearer token obtained from the Salesforce OAuth 2.0 token endpoint. Include this token in the Authorization header as "Bearer {access_token}".

        '