Marketplace Apps
Retrieves a paginated list of marketplace app versions. Note: A marketplace app is a version of a blueprint.
API key passed in the Authorization header. Format: <api-key>
Filter results by id.
Filter results by name.
Filter results by allowed.
Filter results by private.
Filter results by visibility.
Filter results by private_or_allowed.
Filter results by label id.
Comma-separated list of relationships to include. Available: flowTemplates, crossReferenceLookupTemplates, crossReferenceLookupTemplates.crossReferenceLookupValueTemplates, systemTemplates, systemTemplates.logo, scriptTemplates, cacheTemplates, dataPoolTemplates, company, marketplaceCompany, publicCompany, installs
Sort field. Prefix with - for descending. Available: name, id, created_at, installs_avg_install_duration
Page number for pagination.
1Number of results per page.
Successful response
Unauthenticated
Unauthorized
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
}
}Creates a new marketplace app version. Note: A marketplace app is a version of a blueprint.
API key passed in the Authorization header. Format: <api-key>
Successful response
Unauthenticated
Unauthorized
Validation Error
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"
}
}Retrieves the details of a specific marketplace app version. Note: A marketplace app is a version of a blueprint.
API key passed in the Authorization header. Format: <api-key>
The marketplace app identifier.
Filter results by id.
Filter results by name.
Filter results by allowed.
Filter results by private.
Filter results by visibility.
Filter results by private_or_allowed.
Filter results by label id.
Comma-separated list of relationships to include. Available: flowTemplates, crossReferenceLookupTemplates, crossReferenceLookupTemplates.crossReferenceLookupValueTemplates, systemTemplates, systemTemplates.logo, scriptTemplates, cacheTemplates, dataPoolTemplates, company, marketplaceCompany, publicCompany, installs
Sort field. Prefix with - for descending. Available: name, id, created_at, installs_avg_install_duration
Page number for pagination.
1Number of results per page.
Successful response
Unauthenticated
Unauthorized
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"
}
}Permanently deletes a specific marketplace app version. Note: A marketplace app is a version of a blueprint.
API key passed in the Authorization header. Format: <api-key>
The marketplace app identifier.
Successful response
Unauthenticated
Unauthorized
DELETE /api/v1/patchworks/marketplace-apps/{marketplace_app} HTTP/1.1
Host: core.wearepatchworks.com
Authorization: YOUR_API_KEY
Accept: */*
{
"message": "Action completed successfully."
}Updates an existing marketplace app version. Note: A marketplace app is a version of a blueprint.
API key passed in the Authorization header. Format: <api-key>
The marketplace app identifier.
Successful response
Unauthenticated
Unauthorized
Validation Error
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"
}
}Installs a specific marketplace app version. Note: A marketplace app is a version of a blueprint.
API key passed in the Authorization header. Format: <api-key>
The marketplaceApp identifier.
Successful response
Unauthenticated
Unauthorized
Validation Error
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"
}{}To be confirmed. Note: A marketplace app is a version of a blueprint.
API key passed in the Authorization header. Format: <api-key>
Successful response
No content
Unauthenticated
Unauthorized
GET /api/v1/patchworks/marketplace-apps/convertible HTTP/1.1
Host: core.wearepatchworks.com
Authorization: YOUR_API_KEY
Accept: */*
No content
To be confirmed. Note: A marketplace app is a version of a blueprint.
API key passed in the Authorization header. Format: <api-key>
The marketplaceApp identifier.
Successful response
No content
Unauthenticated
Unauthorized
Validation Error
POST /api/v1/patchworks/marketplace-apps/{marketplaceApp}/convert HTTP/1.1
Host: core.wearepatchworks.com
Authorization: YOUR_API_KEY
Accept: */*
No content
Last updated
Was this helpful?