Marketplace Apps

List Marketplace Apps

get

Retrieves a paginated list of marketplace app versions. Note: A marketplace app is a version of a blueprint.

Authorizations

ApiKeyAuthBearerAuth

AuthorizationstringRequired

API key passed in the Authorization header. Format: <api-key>

Query parameters

filter[id]stringOptional

Filter results by id.

filter[name]stringOptional

Filter results by name.

filter[allowed]stringOptional

Filter results by allowed.

filter[private]stringOptional

Filter results by private.

filter[visibility]stringOptional

Filter results by visibility.

filter[private_or_allowed]stringOptional

Filter results by private_or_allowed.

filter[labelled]stringOptional

Filter results by label id.

includestringOptional

Comma-separated list of relationships to include. Available: flowTemplates, crossReferenceLookupTemplates, crossReferenceLookupTemplates.crossReferenceLookupValueTemplates, systemTemplates, systemTemplates.logo, scriptTemplates, cacheTemplates, dataPoolTemplates, company, marketplaceCompany, publicCompany, installs

sortstringOptional

Sort field. Prefix with - for descending. Available: name, id, created_at, installs_avg_install_duration

pageinteger · min: 1Optional

Page number for pagination.

Default: 1

per_pageinteger · min: 1 · max: 100Optional

Number of results per page.

Responses

200

Successful response

application/json

401

Unauthenticated

403

Unauthorized

get

/api/v1/patchworks/marketplace-apps

HTTPcURLJavaScriptPython

GET /api/v1/patchworks/marketplace-apps HTTP/1.1
Host: core.wearepatchworks.com
Authorization: YOUR_API_KEY
Accept: */*

{
  "data": [
    {
      "id": 1,
      "help_guide": "example_help_guide",
      "flow_version_ids": "example_flow_version_ids",
      "cross_reference_lookup_ids": "example_cross_reference_lookup_ids",
      "system_ids": "example_system_ids",
      "script_version_ids": "example_script_version_ids",
      "cache_ids": "example_cache_ids",
      "data_pool_ids": "example_data_pool_ids",
      "private": "example_private",
      "created_at": "2025-01-15T10:30:00.000000Z",
      "updated_at": "2025-01-15T10:30:00.000000Z"
    }
  ],
  "meta": {
    "current_page": 1,
    "from": 1,
    "last_page": 1,
    "path": "https://api.example.com/api/v1/patchworks/marketplace-apps",
    "per_page": 25,
    "to": 1,
    "total": 1
  },
  "links": {
    "first": "https://api.example.com/api/v1/patchworks/marketplace-apps?page=1",
    "last": "https://api.example.com/api/v1/patchworks/marketplace-apps?page=1",
    "prev": null,
    "next": null
  }
}

Create Marketplace App

post

Creates a new marketplace app version. Note: A marketplace app is a version of a blueprint.

Authorizations

ApiKeyAuthBearerAuth

AuthorizationstringRequired

API key passed in the Authorization header. Format: <api-key>

Body

application/json

help_guidestring · uri · nullableOptional

flow_version_idsstringOptional

cross_reference_lookup_idsstringOptional

system_idsstringOptional

script_version_idsstringOptional

cache_idsstringOptional

data_pool_idsstringOptional

privatestringOptional

namestring · max: 100Required

Responses

200

Successful response

application/json

401

Unauthenticated

403

Unauthorized

422

Validation Error

application/json

post

/api/v1/marketplace-apps

HTTPcURLJavaScriptPython

POST /api/v1/marketplace-apps HTTP/1.1
Host: core.wearepatchworks.com
Authorization: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 364

{
  "help_guide": "https://example.com",
  "flow_version_ids": "example_flow_version_ids",
  "cross_reference_lookup_ids": "example_cross_reference_lookup_ids",
  "system_ids": "example_system_ids",
  "script_version_ids": "example_script_version_ids",
  "cache_ids": "example_cache_ids",
  "data_pool_ids": "example_data_pool_ids",
  "private": "example_private",
  "name": "My Example",
  "labels": []
}

{
  "data": {
    "id": 1,
    "help_guide": "example_help_guide",
    "flow_version_ids": "example_flow_version_ids",
    "cross_reference_lookup_ids": "example_cross_reference_lookup_ids",
    "system_ids": "example_system_ids",
    "script_version_ids": "example_script_version_ids",
    "cache_ids": "example_cache_ids",
    "data_pool_ids": "example_data_pool_ids",
    "private": "example_private",
    "created_at": "2025-01-15T10:30:00.000000Z",
    "updated_at": "2025-01-15T10:30:00.000000Z"
  }
}

Get Marketplace App

get

Retrieves the details of a specific marketplace app version. Note: A marketplace app is a version of a blueprint.

Authorizations

ApiKeyAuthBearerAuth

AuthorizationstringRequired

API key passed in the Authorization header. Format: <api-key>

Path parameters

marketplace_appstringRequired

The marketplace app identifier.

Query parameters

filter[id]stringOptional

Filter results by id.

filter[name]stringOptional

Filter results by name.

filter[allowed]stringOptional

Filter results by allowed.

filter[private]stringOptional

Filter results by private.

filter[visibility]stringOptional

Filter results by visibility.

filter[private_or_allowed]stringOptional

Filter results by private_or_allowed.

filter[labelled]stringOptional

Filter results by label id.

includestringOptional

Comma-separated list of relationships to include. Available: flowTemplates, crossReferenceLookupTemplates, crossReferenceLookupTemplates.crossReferenceLookupValueTemplates, systemTemplates, systemTemplates.logo, scriptTemplates, cacheTemplates, dataPoolTemplates, company, marketplaceCompany, publicCompany, installs

sortstringOptional

Sort field. Prefix with - for descending. Available: name, id, created_at, installs_avg_install_duration

pageinteger · min: 1Optional

Page number for pagination.

Default: 1

per_pageinteger · min: 1 · max: 100Optional

Number of results per page.

Responses

200

Successful response

application/json

401

Unauthenticated

403

Unauthorized

get

/api/v1/patchworks/marketplace-apps/{marketplace_app}

HTTPcURLJavaScriptPython

GET /api/v1/patchworks/marketplace-apps/{marketplace_app} HTTP/1.1
Host: core.wearepatchworks.com
Authorization: YOUR_API_KEY
Accept: */*

{
  "data": {
    "id": 1,
    "help_guide": "example_help_guide",
    "flow_version_ids": "example_flow_version_ids",
    "cross_reference_lookup_ids": "example_cross_reference_lookup_ids",
    "system_ids": "example_system_ids",
    "script_version_ids": "example_script_version_ids",
    "cache_ids": "example_cache_ids",
    "data_pool_ids": "example_data_pool_ids",
    "private": "example_private",
    "created_at": "2025-01-15T10:30:00.000000Z",
    "updated_at": "2025-01-15T10:30:00.000000Z"
  }
}

Delete Marketplace App

delete

Permanently deletes a specific marketplace app version. Note: A marketplace app is a version of a blueprint.

Authorizations

ApiKeyAuthBearerAuth

AuthorizationstringRequired

API key passed in the Authorization header. Format: <api-key>

Path parameters

marketplace_appstringRequired

The marketplace app identifier.

Responses

200

Successful response

application/json

messagestringOptional

401

Unauthenticated

403

Unauthorized

delete

/api/v1/patchworks/marketplace-apps/{marketplace_app}

HTTPcURLJavaScriptPython

DELETE /api/v1/patchworks/marketplace-apps/{marketplace_app} HTTP/1.1
Host: core.wearepatchworks.com
Authorization: YOUR_API_KEY
Accept: */*

{
  "message": "Action completed successfully."
}

Update Marketplace App

put

Updates an existing marketplace app version. Note: A marketplace app is a version of a blueprint.

Authorizations

ApiKeyAuthBearerAuth

AuthorizationstringRequired

API key passed in the Authorization header. Format: <api-key>

Path parameters

marketplace_appstringRequired

The marketplace app identifier.

Body

application/json

flow_version_idsstringOptional

cross_reference_lookup_idsstringOptional

system_idsstringOptional

script_version_idsstringOptional

cache_idsstringOptional

data_pool_idsstringOptional

namestring · max: 100Optional

Responses

200

Successful response

application/json

401

Unauthenticated

403

Unauthorized

422

Validation Error

application/json

put

/api/v1/marketplace-apps/{marketplace_app}

HTTPcURLJavaScriptPython

PUT /api/v1/marketplace-apps/{marketplace_app} HTTP/1.1
Host: core.wearepatchworks.com
Authorization: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 289

{
  "flow_version_ids": "example_flow_version_ids",
  "cross_reference_lookup_ids": "example_cross_reference_lookup_ids",
  "system_ids": "example_system_ids",
  "script_version_ids": "example_script_version_ids",
  "cache_ids": "example_cache_ids",
  "data_pool_ids": "example_data_pool_ids",
  "name": "My Example"
}

{
  "data": {
    "id": 1,
    "help_guide": "example_help_guide",
    "flow_version_ids": "example_flow_version_ids",
    "cross_reference_lookup_ids": "example_cross_reference_lookup_ids",
    "system_ids": "example_system_ids",
    "script_version_ids": "example_script_version_ids",
    "cache_ids": "example_cache_ids",
    "data_pool_ids": "example_data_pool_ids",
    "private": "example_private",
    "created_at": "2025-01-15T10:30:00.000000Z",
    "updated_at": "2025-01-15T10:30:00.000000Z"
  }
}

Install Marketplace App

post

Installs a specific marketplace app version. Note: A marketplace app is a version of a blueprint.

Authorizations

ApiKeyAuthBearerAuth

AuthorizationstringRequired

API key passed in the Authorization header. Format: <api-key>

Path parameters

marketplaceAppstringRequired

The marketplaceApp identifier.

Body

application/json

flow_template_idsstringOptional

Responses

200

Successful response

application/json

objectOptional

401

Unauthenticated

403

Unauthorized

422

Validation Error

application/json

post

/api/v1/marketplace-apps/{marketplaceApp}/install

HTTPcURLJavaScriptPython

POST /api/v1/marketplace-apps/{marketplaceApp}/install HTTP/1.1
Host: core.wearepatchworks.com
Authorization: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 49

{
  "flow_template_ids": "example_flow_template_ids"
}

{}

Get Convertible

get

To be confirmed. Note: A marketplace app is a version of a blueprint.

Authorizations

ApiKeyAuthBearerAuth

AuthorizationstringRequired

API key passed in the Authorization header. Format: <api-key>

Responses

200

Successful response

No content

401

Unauthenticated

403

Unauthorized

get

/api/v1/patchworks/marketplace-apps/convertible

HTTPcURLJavaScriptPython

GET /api/v1/patchworks/marketplace-apps/convertible HTTP/1.1
Host: core.wearepatchworks.com
Authorization: YOUR_API_KEY
Accept: */*

No content

Convert Marketplace App

post

To be confirmed. Note: A marketplace app is a version of a blueprint.

Authorizations

ApiKeyAuthBearerAuth

AuthorizationstringRequired

API key passed in the Authorization header. Format: <api-key>

Path parameters

marketplaceAppstringRequired

The marketplaceApp identifier.

Responses

200

Successful response

No content

401

Unauthenticated

403

Unauthorized

422

Validation Error

application/json

post

/api/v1/patchworks/marketplace-apps/{marketplaceApp}/convert

HTTPcURLJavaScriptPython

POST /api/v1/patchworks/marketplace-apps/{marketplaceApp}/convert HTTP/1.1
Host: core.wearepatchworks.com
Authorization: YOUR_API_KEY
Accept: */*

No content