Adobe Suite User operations API

Sandbox operations available to all users.

Operations 22

GET /sandbox-management/ List available sandboxes #
GET /exim/packages List packages #
POST /exim/packages Create a package #
PUT /exim/packages Update a package #
PUT /exim/packages/import Submit an import #
GET /exim/packages/jobs List export/import jobs #
PUT /exim/packages/update Make package public #
GET /exim/packages/{packageID} Look up a package #
DELETE /exim/packages/{packageID} Delete a package #
GET /exim/packages/{packageID}/export Publish a package #
GET /exim/packages/{packageID}/import Import a package #
POST /exim/packages/{packageID}/children List all dependent objects #
GET /exim/packages/payload/{packageID} Copy package payload #
GET /exim/packages/preflight/{packageID}/export Check role-based permissions to import all package artifacts #
POST /exim/handshake/bulkCreate Send partnership requests #
POST /exim/handshake/action Approve partnership requests #
GET /exim/handshake/list List partnership requests #
POST /exim/transfer Create share request #
GET /exim/transfer/{transferID} Fetch share request by ID #
GET /exim/transfer/list List share requests #
POST /exim/transfer/pullRequest Import public package #
GET /exim/tools/job/{jobID} Job details #

Documentation

📖
Documentation
https://developer.adobe.com/photoshop/api/docs/
📖
Authentication
https://developer.adobe.com/developer-console/docs/guides/authentication/
📖
Documentation
https://developer.adobe.com/lightroom/api/docs/
📖
Documentation
https://developer.adobe.com/illustrator/api/docs/
📖
Documentation
https://developer.adobe.com/indesign/docs/
📖
Documentation
https://developer.adobe.com/document-services/docs/overview/pdf-services-api/
📖
Documentation
https://developer.adobe.com/document-services/docs/overview/pdf-extract-api/
📖
GettingStarted
https://developer.adobe.com/document-services/docs/overview/pdf-extract-api/gettingstarted/
📖
Documentation
https://developer.adobe.com/document-services/docs/overview/pdf-accessibility-auto-tag-api/
📖
Documentation
https://developer.adobe.com/analytics-apis/docs/
📖
APIReference
https://developer.adobe.com/analytics-apis/docs/2.0/
📖
Documentation
https://developer.adobe.com/firefly-services/docs/
📖
APIReference
https://developer.adobe.com/firefly-services/docs/api/
📖
Documentation
https://developer.adobe.com/audio-video-firefly-services/
📖
GettingStarted
https://developer.adobe.com/audio-video-firefly-services/getting-started/
📖
Documentation
https://developer.adobe.com/creative-cloud-libraries/docs/
📖
APIReference
https://developer.adobe.com/creative-cloud-libraries/docs/api/
📖
Documentation
https://developer.adobe.com/express/embed-sdk/docs/guides/
📖
APIReference
https://developer.adobe.com/express/embed-sdk/docs/v4/
📖
GettingStarted
https://developer.adobe.com/express/embed-sdk/docs/guides/quickstart/
📖
Documentation
https://developer.adobe.com/experience-platform-apis/
📖
GettingStarted
https://experienceleague.adobe.com/en/docs/experience-platform/landing/platform-apis/api-guide
📖
Documentation
https://developer.adobe.com/marketo-apis/
📖
Authentication
https://experienceleague.adobe.com/en/docs/marketo-developer/marketo/rest/authentication
📖
Documentation
https://developer.adobe.com/commerce/docs/
📖
GettingStarted
https://developer.adobe.com/commerce/webapi/get-started/
📖
Documentation
https://developer.adobe.com/experience-cloud/cloud-manager/
📖
Documentation
https://developer.adobe.com/journey-optimizer-apis/
📖
Documentation
https://developer.adobe.com/workfront-apis/
📖
Documentation
https://developer.adobe.com/firefly-services/docs/substance3d/
📖
Documentation
https://developer.adobe.com/data-collection-apis/
📖
Documentation
https://developer.adobe.com/adobe-status/
📖
Documentation
https://developer.adobe.com/vip-marketplace/

Specifications

Other Resources

🔗
Pricing
https://developer.adobe.com/document-services/pricing/
🔗
SDKs
https://developer.adobe.com/document-services/docs/overview/pdf-services-api/sdks/
🔗
ReleaseNotes
https://developer.adobe.com/document-services/docs/overview/pdf-services-api/releasenotes
🔗
Guides
https://developer.adobe.com/analytics-apis/docs/2.0/guides/
🔗
Guides
https://developer.adobe.com/firefly-services/docs/guides/
🔗
Usage Notes
https://developer.adobe.com/audio-video-firefly-services/getting_started/usage/
🔗
Overview
https://developer.adobe.com/creative-cloud-libraries/docs/overview/
🔗
Integration Guide
https://developer.adobe.com/creative-cloud-libraries/docs/integrate/
🔗
API Fundamentals
https://experienceleague.adobe.com/en/docs/experience-platform/landing/platform-apis/api-fundamentals
🔗
Developer Guide
https://experienceleague.adobe.com/en/docs/marketo-developer/marketo/home
🔗
REST API
https://experienceleague.adobe.com/en/docs/marketo-developer/marketo/rest/rest-api
🔗
REST API
https://developer.adobe.com/commerce/webapi/rest/
🔗
GraphQL API
https://developer.adobe.com/commerce/webapi/graphql-api/
🔗
REST API Reference
https://developer.adobe.com/commerce/webapi/reference/rest/paas/
🔗
GraphQL
https://raw.githubusercontent.com/api-evangelist/adobe-suite/refs/heads/main/graphql/adobe-suite-graphql.md
🔗
Webhooks
https://developer.adobe.com/experience-cloud/cloud-manager/guides/getting-started/create-event-integration/
🔗
StatusPage
https://status.adobe.com/

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/adobe-suite-user-operations-api"
All apis
curl "https://apis.io/api/v1/apis?limit=25"

Discovery needs no key. Ratings and market analysis are Pro.

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. See our Privacy Policy and Terms.

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

OpenAPI Specification

adobe-suite-user-operations-api-openapi.yml Raw ↑
openapi: 3.2.0
info:
  title: Sandbox User operations API
  description: "Adobe Experience Platform provides virtual sandbox environments which provide isolation and access control for Platform integrations. Use sandboxes for application lifecycle management, project management, and to build customized development ecosystems. Use sandbox tooling to seamlessly export and import sandbox configurations between sandboxes through the use of packages.\n- **Related documentation**:\n    - [Sandbox documentation](https://adobe.com/go/sandbox-overview-en)\n    - [Sandbox tooling documentation](http://adobe.com/go/sandbox-tooling-en)\n\n- **Visualize API calls with Postman (a free, third-party software)**:\n    - [Sandbox API Postman collection on GitHub](https://github.com/adobe/experience-platform-postman-samples/blob/master/apis/experience-platform/Sandbox%20API.postman_collection.json)\n    - [Video guide for creating the Postman environment](https://video.tv.adobe.com/v/28832)\n    - [Steps for importing environments and collections in Postman](https://learning.getpostman.com/docs/postman/collection_runs/using_environments_in_collection_runs/)\n\n- **API paths**:\n    - PLATFORM Gateway URL: https://<span>platform.adobe.io/\n    - Base path for the sandbox API: /data/foundation/sandbox-management\n    - Example of a complete path: https://<span>platform.adobe.io/data/foundation/sandbox-management/sandboxes\n    - Base path for the sandbox tooling API: /data/foundation/exim\n    - Example of a complete path: https://<span>platform.adobe.io/data/foundation/exim/packages\n\n- **Required headers**:\n    - All calls require the headers `Authorization`, `x-gw-ims-org-id`, and `x-api-key`. For more information on how to obtain these values, see the [authentication tutorial](http://www.adobe.com/go/platform-api-authentication-en).\n    - All resources in Experience Platform are isolated to specific virtual sandboxes. All requests to Platform APIs require the header `x-sandbox-name` whose value is the all-lowercase name of the sandbox the operation will take place in (for example, \"prod\"). See the [sandboxes overview](https://adobe.com/go/sandbox-overview-en) for more information.\n    - All requests with a payload in the request body (such as POST, PUT, and PATCH calls) must include the header `Content-Type` with a value of `application/json`.\n\n- **API error handling**:\n    - Refer to the Experience Platform API troubleshooting guide for [FAQs](https://experienceleague.adobe.com/docs/experience-platform/landing/troubleshooting.html#faq), [API status codes](https://experienceleague.adobe.com/docs/experience-platform/landing/troubleshooting.html#api-status-codes), and [request header errors](https://experienceleague.adobe.com/docs/experience-platform/landing/troubleshooting.html#request-header-errors).        \n\n- **Filtering responses**:\n    - When performing listing (GET) requests in the Sandbox API, you can use query parameters to filter responses. Refer to the [Sandbox API queries](https://experienceleague.adobe.com/docs/experience-platform/sandbox/api/appendix.html#query) or the [Sandbox tooling API queries](http://experienceleague.adobe.com/en/docs/experience-platform/sandbox/sandbox-tooling-api/appendix) for a list of available queries."
  version: '1.0'
servers:
- url: https://{environment}.adobe.io/data/foundation
  variables:
    environment:
      default: platform
      enum:
      - platform
      - platform-stage
tags:
- name: User operations
  description: Sandbox operations available to all users.
paths:
  /sandbox-management/:
    get:
      tags:
      - User operations
      summary: List available sandboxes
      description: Use this endpoint to retrieve a list of available sandboxes for the current user.
      operationId: listAvailableSandboxes
      parameters:
      - $ref: '#/components/parameters/authorization'
      - $ref: '#/components/parameters/x-api-key'
      - $ref: '#/components/parameters/x-gw-ims-org-id'
      - $ref: '#/components/parameters/x-user-token'
      - $ref: '#/components/parameters/accept'
      responses:
        '200':
          x-summary: Request successful.
          description: A list of active sandboxes retrieved successfully.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ListAvailableSandboxes'
        '400':
          $ref: '#/components/responses/BadRequest'
        '403':
          $ref: '#/components/responses/Forbidden'
        '500':
          $ref: '#/components/responses/InternalServerError'
  /exim/packages:
    get:
      tags:
      - User operations
      summary: List packages
      description: Use this endpoint to list all packages. Make use of the query parameters to filter the list of returned packages.
      operationId: listPackages
      parameters:
      - $ref: '#/components/parameters/authorization'
      - $ref: '#/components/parameters/x-api-key'
      - $ref: '#/components/parameters/x-gw-ims-org-id'
      - $ref: '#/components/parameters/x-sandbox-name'
      - $ref: '#/components/parameters/limit'
      - $ref: '#/components/parameters/start'
      - $ref: '#/components/parameters/orderBy'
      - $ref: '#/components/parameters/status'
      responses:
        '200':
          x-summary: Request successful.
          description: The package was retrieved successfully.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ListPackagesResponse'
        '400':
          $ref: '#/components/responses/BadRequest'
        '403':
          $ref: '#/components/responses/Forbidden'
        '500':
          $ref: '#/components/responses/InternalServerError'
    post:
      tags:
      - User operations
      summary: Create a package
      description: Use this endpoint to create a multi-artifact package while providing values for your package's name and package type.
      operationId: createPackage
      parameters:
      - $ref: '#/components/parameters/authorization'
      - $ref: '#/components/parameters/x-api-key'
      - $ref: '#/components/parameters/x-gw-ims-org-id'
      - $ref: '#/components/parameters/x-sandbox-name'
      - $ref: '#/components/parameters/content-type'
      requestBody:
        description: The JSON payload outlines the details of the package to be created.
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CreatePackagePayload'
        required: true
      responses:
        '201':
          x-summary: Request successful.
          description: The package was created successfully.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CreatePackageResponse'
        '400':
          $ref: '#/components/responses/BadRequest'
        '403':
          $ref: '#/components/responses/Forbidden'
        '500':
          $ref: '#/components/responses/InternalServerError'
    put:
      tags:
      - User operations
      summary: Update a package
      description: Use this endpoint to add or delete an artifact to a package, or update a package's metadata.
      operationId: updatePackage
      parameters:
      - $ref: '#/components/parameters/authorization'
      - $ref: '#/components/parameters/x-api-key'
      - $ref: '#/components/parameters/x-gw-ims-org-id'
      - $ref: '#/components/parameters/x-sandbox-name'
      - $ref: '#/components/parameters/content-type'
      requestBody:
        description: The JSON payload outlines the update request for a package.
        content:
          application/json:
            schema:
              oneOf:
              - $ref: '#/components/schemas/AddArtifactPayload'
              - $ref: '#/components/schemas/DeleteArtifactPayload'
              - $ref: '#/components/schemas/UpdatePackageMetadata'
        required: true
      responses:
        '201':
          x-summary: Package updated successfully
          description: The new package was updated.
          content:
            application/json:
              schema:
                oneOf:
                - $ref: '#/components/schemas/AddArtifactResponse'
                - $ref: '#/components/schemas/DeleteArtifactResponse'
                - $ref: '#/components/schemas/UpdatePackageResponse'
        '400':
          $ref: '#/components/responses/BadRequest'
        '403':
          $ref: '#/components/responses/Forbidden'
        '500':
          $ref: '#/components/responses/InternalServerError'
  /exim/packages/import:
    put:
      tags:
      - User operations
      summary: Submit an import
      description: Use this endpoint to submit an import for a package after reviewing conflicts. Only packages with the `PUBLISHED` status can be imported.
      operationId: submitImport
      parameters:
      - $ref: '#/components/parameters/authorization'
      - $ref: '#/components/parameters/x-api-key'
      - $ref: '#/components/parameters/x-gw-ims-org-id'
      - $ref: '#/components/parameters/x-sandbox-name'
      - $ref: '#/components/parameters/content-type'
      requestBody:
        description: The JSON payload provides information on the imported package and an optional map of substitutions where the key is the `artifactId` provided by the package, and the alternative is the value. If the map is empty, no substitutions are performed. The payload also accepts a user-specified name and description for the import job.
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/SubmitImportPayload'
        required: true
      responses:
        '202':
          x-summary: Request successful.
          description: The import request was accepted.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SubmitImportResponse'
        '400':
          $ref: '#/components/responses/BadRequest'
        '403':
          $ref: '#/components/responses/Forbidden'
        '500':
          $ref: '#/components/responses/InternalServerError'
  /exim/packages/jobs:
    get:
      tags:
      - User operations
      summary: List export/import jobs
      description: Use this endpoint to retrieve all current export/import jobs. Make use of the query parameters to filter the list of returned packages.
      operationId: listJobs
      parameters:
      - $ref: '#/components/parameters/authorization'
      - $ref: '#/components/parameters/x-api-key'
      - $ref: '#/components/parameters/x-gw-ims-org-id'
      - $ref: '#/components/parameters/x-sandbox-name'
      - $ref: '#/components/parameters/limit'
      - $ref: '#/components/parameters/start'
      - $ref: '#/components/parameters/orderBy'
      - $ref: '#/components/parameters/status'
      - $ref: '#/components/parameters/jobType'
      - $ref: '#/components/parameters/jobStatus'
      - name: requestType
        in: query
        description: The type of request. This value can be `EXPORT`, `IMPORT`, or `COPY`.
        schema:
          type: string
          enum:
          - EXPORT
          - IMPORT
          - COPY
      responses:
        '200':
          x-summary: Jobs fetched successfully.
          description: The export and import jobs were fetched successfully.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ListJobsResponse'
        '400':
          $ref: '#/components/responses/BadRequest'
        '403':
          $ref: '#/components/responses/Forbidden'
        '500':
          $ref: '#/components/responses/InternalServerError'
  /exim/packages/update:
    put:
      tags:
      - User operations
      summary: Make package public
      description: Use this endpoint to change a package's availability from private to public.
      operationId: makePackagePublic
      parameters:
      - $ref: '#/components/parameters/authorization'
      - $ref: '#/components/parameters/x-api-key'
      - $ref: '#/components/parameters/x-gw-ims-org-id'
      - $ref: '#/components/parameters/x-sandbox-name'
      - $ref: '#/components/parameters/content-type'
      requestBody:
        description: The JSON payload provides information on the imported package and an optional map of substitutions where the key is the `artifactId` provided by the package, and the alternative is the value. If the map is empty, no substitutions are performed. The payload also accepts a user-specified name and description for the import job.
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/MakePackagePublicPayload'
        required: true
      responses:
        '202':
          x-summary: Package visibility update successful.
          description: The package was successfully updated to `PUBLIC`.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/MakePackagePublicResponse'
        '400':
          $ref: '#/components/responses/BadRequest'
        '403':
          $ref: /#components/responses/Forbidden
        '500':
          $ref: '#/components/responses/InternalServerError'
  /exim/packages/{packageID}:
    get:
      tags:
      - User operations
      summary: Look up a package
      description: Use this endpoint to look up an individual package.
      operationId: lookUpPackage
      parameters:
      - $ref: '#/components/parameters/packageID'
      - $ref: '#/components/parameters/authorization'
      - $ref: '#/components/parameters/x-api-key'
      - $ref: '#/components/parameters/x-gw-ims-org-id'
      - $ref: '#/components/parameters/x-sandbox-name'
      responses:
        '200':
          x-summary: Request successful.
          description: The package was retrieved successfully.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PackageResponse'
        '400':
          $ref: '#/components/responses/BadRequest'
        '403':
          $ref: '#/components/responses/Forbidden'
        '500':
          $ref: '#/components/responses/InternalServerError'
    delete:
      tags:
      - User operations
      summary: Delete a package
      description: Use this endpoint to delete a package by ID.
      operationId: deletePackage
      parameters:
      - $ref: '#/components/parameters/packageID'
      - $ref: '#/components/parameters/authorization'
      - $ref: '#/components/parameters/x-api-key'
      - $ref: '#/components/parameters/x-gw-ims-org-id'
      - $ref: '#/components/parameters/x-sandbox-name'
      responses:
        '200':
          x-summary: Request successful.
          description: The package was deleted successfully.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DeletePackageResponse'
        '400':
          $ref: '#/components/responses/BadRequest'
        '403':
          $ref: '#/components/responses/Forbidden'
        '500':
          $ref: '#/components/responses/InternalServerError'
  /exim/packages/{packageID}/export:
    get:
      tags:
      - User operations
      summary: Publish a package
      description: Use this endpoint to publish a package by ID, enabling it to be imported. The package status must be `PARTIAL` or `PUBLISH_FAILED`. If the `packageType` is `PARTIAL` it must contain artifacts.
      operationId: publishPackage
      parameters:
      - $ref: '#/components/parameters/packageID'
      - $ref: '#/components/parameters/authorization'
      - $ref: '#/components/parameters/x-api-key'
      - $ref: '#/components/parameters/x-gw-ims-org-id'
      - $ref: '#/components/parameters/x-sandbox-name'
      - $ref: '#/components/parameters/expiryPeriod'
      responses:
        '200':
          x-summary: Request successful.
          description: The package was published successfully.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PublishPackageResponse'
        '400':
          $ref: '#/components/responses/BadRequest'
        '403':
          $ref: /#components/responses/Forbidden
        '500':
          $ref: '#/components/responses/InternalServerError'
  /exim/packages/{packageID}/import:
    get:
      tags:
      - User operations
      summary: Import a package
      description: Use this endpoint to fetch conflicting objects in the specified target sandbox before submitting an import. Conflicting objects represent similar objects that are already present in the target sandbox.
      operationId: importPackage
      parameters:
      - $ref: '#/components/parameters/packageID'
      - $ref: '#/components/parameters/authorization'
      - $ref: '#/components/parameters/x-api-key'
      - $ref: '#/components/parameters/x-gw-ims-org-id'
      - $ref: '#/components/parameters/x-sandbox-name'
      - $ref: '#/components/parameters/targetSandbox'
      responses:
        '200':
          x-summary: Request successful.
          description: The objects were retrieved successfully.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ImportPackageResponse'
        '400':
          $ref: '#/components/responses/BadRequest'
        '403':
          $ref: '#/components/responses/Forbidden'
        '500':
          $ref: '#/components/responses/InternalServerError'
  /exim/packages/{packageID}/children:
    post:
      tags:
      - User operations
      summary: List all dependent objects
      description: Use this endpoint to list all dependent objects for the provided objects in a package. This cannot be performed on a package with a `DRAFT` status.
      operationId: dependentObjects
      parameters:
      - $ref: '#/components/parameters/packageID'
      - $ref: '#/components/parameters/authorization'
      - $ref: '#/components/parameters/x-api-key'
      - $ref: '#/components/parameters/x-gw-ims-org-id'
      - $ref: '#/components/parameters/x-sandbox-name'
      - $ref: '#/components/parameters/content-type'
      requestBody:
        description: The JSON payload provides a list of the package's objects.
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/DependentObjectsPayload'
        required: true
      responses:
        '201':
          x-summary: Request successful.
          description: The children were found successfully.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CreatePackageResponse'
        '400':
          $ref: '#/components/responses/BadRequest'
        '403':
          $ref: '#/components/responses/Forbidden'
        '500':
          $ref: '#/components/responses/InternalServerError'
  /exim/packages/payload/{packageID}:
    get:
      tags:
      - User operations
      summary: Copy package payload
      description: Use this endpoint to copy a package's payload.
      operationId: packagePayload
      parameters:
      - $ref: '#/components/parameters/packageID'
      - $ref: '#/components/parameters/authorization'
      - $ref: '#/components/parameters/x-api-key'
      - $ref: '#/components/parameters/x-gw-ims-org-id'
      - $ref: '#/components/parameters/x-sandbox-name'
      - $ref: '#/components/parameters/content-type'
      - $ref: '#/components/parameters/accept'
      responses:
        '200':
          x-summary: Request successful.
          description: The package payload was retrieved successfully.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CopyPayloadResponse'
        '400':
          $ref: '#/components/responses/BadRequest'
        '403':
          $ref: '#/components/responses/Forbidden'
        '500':
          $ref: '#/components/responses/InternalServerError'
  /exim/packages/preflight/{packageID}/export:
    get:
      tags:
      - User operations
      summary: Check role-based permissions to import all package artifacts
      description: Use this endpoint to check if you have permissions to import package artifacts.
      operationId: checkImportPermissions
      parameters:
      - $ref: '#/components/parameters/packageID'
      - $ref: '#/components/parameters/authorization'
      - $ref: '#/components/parameters/x-api-key'
      - $ref: '#/components/parameters/x-gw-ims-org-id'
      - $ref: '#/components/parameters/x-sandbox-name'
      - $ref: '#/components/parameters/targetSandbox'
      responses:
        '200':
          x-summary: Request successful.
          description: The permissions were checked successfully.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CheckImportPermissionsResponse'
        '400':
          $ref: '#/components/responses/BadRequest'
        '403':
          $ref: '#/components/responses/Forbidden'
        '500':
          $ref: '#/components/responses/InternalServerError'
  /exim/handshake/bulkCreate:
    post:
      tags:
      - User operations
      summary: Send partnership requests
      description: Use this endpoint to send a request to target partner organizations for a partnership. This is required before you can share private packages.
      operationId: partnershipRequest
      parameters:
      - $ref: '#/components/parameters/authorization'
      - $ref: '#/components/parameters/x-api-key'
      - $ref: '#/components/parameters/x-gw-ims-org-id'
      - $ref: '#/components/parameters/x-sandbox-name'
      - $ref: '#/components/parameters/accept'
      - $ref: '#/components/parameters/content-type'
      requestBody:
        description: The JSON payload provides a list of target organizations and the source organization.
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PartnershipRequestPayload'
        required: true
      responses:
        '201':
          x-summary: Request accepted.
          description: The partnership request was sent successfully.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PartnershipRequestResponse'
        '400':
          $ref: '#/components/responses/BadRequest'
        '403':
          $ref: '#/components/responses/Forbidden'
        '500':
          $ref: '#/components/responses/InternalServerError'
  /exim/handshake/action:
    post:
      tags:
      - User operations
      summary: Approve partnership requests
      description: Use this endpoint to approve partnership requests from target partner organizations. After approval, source partner organizations can share private packages.
      operationId: approveShareRequests
      parameters:
      - $ref: '#/components/parameters/authorization'
      - $ref: '#/components/parameters/x-api-key'
      - $ref: '#/components/parameters/x-gw-ims-org-id'
      - $ref: '#/components/parameters/x-sandbox-name'
      - $ref: '#/components/parameters/accept'
      - $ref: '#/components/parameters/content-type'
      requestBody:
        description: The JSON payload provides the target organization.
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ApprovePartnershipRequestPayload'
        required: true
      responses:
        '201':
          x-summary: Request successful.
          description: The partnership request response was successful.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApprovePartnershipRequestResponse'
        '400':
          $ref: '#/components/responses/BadRequest'
        '403':
          $ref: '#/components/responses/Forbidden'
        '500':
          $ref: '#/components/responses/InternalServerError'
  /exim/handshake/list:
    get:
      tags:
      - User operations
      summary: List partnership requests
      description: Use this endpoint to list all incoming and outgoing partnership requests and their current status. Currently, ordering is only supported with `createdDate`.
      operationId: listPartnershipRequests
      parameters:
      - $ref: '#/components/parameters/authorization'
      - $ref: '#/components/parameters/x-api-key'
      - $ref: '#/components/parameters/x-gw-ims-org-id'
      - $ref: '#/components/parameters/x-sandbox-name'
      - $ref: '#/components/parameters/content-type'
      - $ref: '#/components/parameters/accept'
      - $ref: '#/components/parameters/limit'
      - $ref: '#/components/parameters/start'
      - $ref: '#/components/parameters/orderBy'
      - $ref: '#/components/parameters/property'
      - name: requestType
        in: query
        description: The type of request. This value can be `INCOMING`, or `OUTGOING`.
        required: true
        schema:
          type: string
          enum:
          - INCOMING
          - OUTGOING
      responses:
        '200':
          x-summary: Request successful.
          description: The list of partnership requests was fetched successfully.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ListPartnershipRequestsResponse'
        '400':
          $ref: '#/components/responses/BadRequest'
        '403':
          $ref: '#/components/responses/Forbidden'
        '500':
          $ref: '#/components/responses/InternalServerError'
  /exim/transfer:
    post:
      tags:
      - User operations
      summary: Create share request
      description: Use this endpoint to fetch a published source organization’s package and share it with a target organization.
      operationId: createShareRequest
      parameters:
      - $ref: '#/components/parameters/authorization'
      - $ref: '#/components/parameters/x-api-key'
      - $ref: '#/components/parameters/x-gw-ims-org-id'
      - $ref: '#/components/parameters/x-sandbox-name'
      - $ref: '#/components/parameters/content-type'
      requestBody:
        description: The JSON payload provides the source organization to fetch the request from and the target organization to share it to.
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CreateShareRequestPayload'
        required: true
      responses:
        '201':
          x-summary: Request successful.
          description: The share request was retrieved successfully.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CreateShareRequestResponse'
        '400':
          $ref: '#/components/responses/BadRequest'
        '403':
          $ref: '#/components/responses/Forbidden'
        '500':
          $ref: '#/components/responses/InternalServerError'
  /exim/transfer/{transferID}:
    get:
      tags:
      - User operations
      summary: Fetch share request by ID
      description: Use this endpoint to fetch the details of a specified share request.
      operationId: fetchShareByID
      parameters:
      - $ref: '#/components/parameters/transferID'
      - $ref: '#/components/parameters/authorization'
      - $ref: '#/components/parameters/x-api-key'
      - $ref: '#/components/parameters/x-gw-ims-org-id'
      - $ref: '#/components/parameters/x-sandbox-name'
      responses:
        '200':
          x-summary: Request successful.
          description: The specified share request was fetched successfully.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/FetchShareByIDResponse'
        '400':
          $ref: '#/components/responses/BadRequest'
        '403':
          $ref: '#/components/responses/Forbidden'
        '500':
          $ref: '#/components/responses/InternalServerError'
  /exim/transfer/list:
    get:
      tags:
      - User operations
      summary: List share requests
      description: Use this endpoint to fetch a list of share requests. Currently, ordering is only supported with `createdDate`.
      operationId: fetchShareList
      parameters:
      - $ref: '#/components/parameters/authorization'
      - $ref: '#/components/parameters/x-api-key'
      - $ref: '#/components/parameters/x-gw-ims-org-id'
      - $ref: '#/components/parameters/x-sandbox-name'
      - $ref: '#/components/parameters/property'
      - $ref: '#/components/parameters/start'
      - $ref: '#/components/parameters/limit'
      - $ref: '#/components/parameters/orderBy'
      - name: requestType
        in: query
        description: The type of request. This value can be `PUBLIC`, or `PRIVATE`.
        required: true
        schema:
          type: string
          enum:
          - PUBLIC
          - PRIVATE
      responses:
        '200':
          x-summary: Request successful.
          description: The share requests were fetched successfully.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/FetchShareListResponse'
        '400':
          $ref: '#/components/responses/BadRequest'
        '403':
          $ref: '#/components/responses/Forbidden'
        '500':
          $ref: '#/components/responses/InternalServerError'
  /exim/transfer/pullRequest:
    post:
      tags:
      - User operations
      summary: Import public package
      description: Use this endpoint to import a public package from a source organization.
      operationId: importPublicPackage
      parameters:
      - $ref: '#/components/parameters/authorization'
      - $ref: '#/components/parameters/x-api-key'
      - $ref: '#/components/parameters/x-gw-ims-org-id'
      - $ref: '#/components/parameters/x-sandbox-name'
      - $ref: '#/components/parameters/content-type'
      - $ref: '#/components/parameters/accept'
      requestBody:
        description: The JSON payload provides the source organization and the package ID.
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ImportPublicPackagePayload'
        required: true
      responses:
        '201':
          x-summary: Request successful.
          description: The request to import the package was successful.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ImportPublicPackageResponse'
        '400':
          $ref: '#/components/responses/BadRequest'
        '403':
          $ref: '#/components/responses/Forbidden'
        '500':
          $ref: '#/components/responses/InternalServerError'
  /exim/tools/job/{jobID}:
    get:
      tags:
      - User operations
      summary: Job details
      description: Use this endpoint to fetch the details of a specific job.
      operationId: fetchJob
      parameters:
      - $ref: '#/components/parameters/jobID'
      - $ref: '#/components/parameters/authorization'
      - $ref: '#/components/parameters/x-api-key'
      - $ref: '#/components/parameters/x-gw-ims-org-id'
      - $ref: '#/components/parameters/x-sandbox-name'
      - $ref: '#/components/parameters/content-type'
      - $ref: '#/components/parameters/accept'
      responses:
        '200':
          x-summary: Request successful.
          description: The job was fetched successfully.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/FetchJobResponse'
        '400':
          $ref: '#/components/responses/BadRequest'
        '403':
          $ref: '#/components/responses/Forbidden'
        '500':
          $ref: '#/components/responses/InternalServerError'
components:
  responses:
    InternalServerError:
      x-summary: Internal Server Error.
      description: There was an internal server error. Try the request again in a few minutes, and contact Adobe Support if the problem persists.
      content: {}
    Forbidden:
      x-summary: Forbidden
      description: You do not have the correct access permissions for this endpoint.
      content: {}
    BadRequest:
      x-summary: Bad Request
      description: Bad request. Check the syntax and payload information.
      content: {}
  schemas:
    FetchJobResponse:
      type: object
      description: A successful response returns details for the queried job ID.
      properties:
        status:
          type: string
          description: Indicates whether the job request succeeded at the API level.
          example: OK
        type:
          type: string
          description: Result 

# --- truncated at 32 KB (110 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/adobe-suite/refs/heads/main/openapi/adobe-suite-user-operations-api-openapi.yml