Printago API

Getting Started

Introduction Authentication Realtime MQTT Camera Streaming Webhooks Querying Data OpenAPI Spec Best Practices

API Keys

GET Get all API keys GET Get API key by ID GET Get API key permissions GET Get API key roles POST Create an API key POST Search API keys PATCH Update an API key DEL Delete an API key

Audit Logs

GET GET /v1/audit-logs POST POST /v1/audit-logs/search

Cloud

GET Get sync status for a cloud-storage integration GET List all file sync records for a cloud-storage integration GET List connected accounts for a cloud-storage provider GET List folders in a cloud-storage account for folder selection POST Disconnect a cloud-storage integration POST Enqueue a background sync for a cloud-storage integration (returns immediately) POST Re-import a file whose part was deleted inside Printago POST Select the folder to watch for a cloud-storage integration PATCH Update sync settings for a cloud-storage integration

Cost Catalog

GET Get all cost components GET Get cost component by ID POST Create new cost component POST Search cost components PATCH Update cost component DEL Delete cost component

Customers

GET Get all customers POST Search customers

Customizer

GET Get customizer config GET Get customizer design GET Get customizer Shopify publication state GET Get design SVG GET Get design with per-layer files GET List custom fonts GET List customizer configs GET List customizer designs GET List Google Fonts catalog GET List store custom textures GET List store Google fonts pool POST Add example customizer config POST Add Google font to store pool POST Create customizer config POST Get colors for SKUs POST Preview customizer build overlay POST Publish customizer config to Shopify POST Simulate a customer order for a customizer design POST Upload background SVG POST Upload custom font POST Upload store custom texture PATCH Update customizer config PATCH Update store custom texture DEL Delete background SVG DEL Delete custom font DEL Delete customizer config DEL Delete store custom texture DEL Remove Google font from store pool DEL Unpublish customizer config from Shopify

Default

POST POST /v1/parts/{id}/split-plates

eBay

GET Get eBay settings GET Get eBay status GET List eBay integrations POST Sync eBay orders PATCH Update eBay settings

Entitlements

GET Check if store has specific entitlement GET Get all entitlements GET Get entitlement by ID POST Search entitlements

Etsy

GET Get Etsy listing GET Get Etsy settings GET Get Etsy status GET Get Etsy usage stats GET List Etsy integrations POST Sync Etsy orders PATCH Update Etsy settings

Files

POST Get signed download URLs POST Get signed upload URLs

Folders

GET Get all folders GET Get folder by ID GET Get folders by type GET Get part folders GET Get SKU folders POST Create a new folder POST Search folders PATCH Move folders to a new parent PATCH Rename a folder DEL Delete folders

Hints

GET Get path schema GET Get type schema GET List available paths GET List available types

Integrations

GET Get a specific integration by ID GET Get all integrations POST Search integrations

Linked Parts

GET Get a specific linked part by ID GET Get all linked parts for a store POST Create a new linked part POST Search linked parts PATCH Update a linked part DEL Delete a linked part

Macros

GET Get all GCODE macros GET Get GCODE macro by ID GET List printer models for macro compatibility POST Create GCODE macro POST Run GCODE macro on printers POST Search GCODE macros PATCH Update GCODE macro DEL Delete GCODE macro

Maintenance

GET Get completion history GET Get fleet maintenance status GET Get printer maintenance status GET Get recommended maintenance profiles GET List enrollments GET List maintenance items POST Create maintenance item POST Duplicate maintenance item POST Enroll printers POST Enroll recommended maintenance POST Mark maintenance done PATCH Set maintenance mode PATCH Update maintenance item DEL Delete maintenance item DEL Unenroll printers

Materials

GET Get all material profile assignments GET Get all materials GET Get full material data GET Get material by ID POST Assign profile to material POST Create material POST Search material profile assignments POST Search materials PATCH Update material DEL Clear material profile DEL Delete material DEL Delete materials

Material Groups

GET Get all group members GET Get all groups GET Get group by ID GET Get group member by ID GET Get group members POST Add group member POST Create group PATCH Update group DEL Delete group DEL Delete multiple groups DEL Remove group members

Material Instances

GET Get all material instances GET Get instance by ID POST Create material instance PUT Update material instance DEL Delete material instance

Material Variants

GET Get all material variants GET Get all variants GET Get variant by ID GET Get variants by material POST Assign profile to variant POST Batch create variants POST Create variant POST Search material variants PATCH Update variant DEL Clear variant profile DEL Delete multiple variants DEL Delete variant

Orders

GET Get all customers GET Get all ignored SKUs GET Get all orders GET Get complete order data GET Get customer by ID GET Get ignored SKUs list GET Get order with full details GET Get order without related data GET Get print jobs for an external order POST Cancel an order POST Check if SKUs are ignored POST Create a new customer POST Create a new order POST Reconcile print jobs with orders POST Reconcile print jobs with orders POST Search ignored SKUs POST Search orders PUT Update an order PATCH Batch cancel orders PATCH Batch close orders PATCH Batch reopen orders PATCH Update ignored SKUs list DEL Batch delete orders DEL Delete an order

Order Items

GET Get a specific order item GET Get all order items GET Get all order items GET Get items for a specific order POST Add items to an order POST Search order items PUT Update an order item PATCH Batch update order items DEL Delete an order item

Parts

GET Get all part material assignments GET Get all parts GET Get part by ID GET Get part metadata POST Create a new part POST Create SKUs from parts POST Extract 3MF metadata from a staged upload POST Reprocess a part's metadata POST Search part material assignments POST Search parts POST Trigger part estimation PATCH Bulk update parts PATCH Update a part DEL Delete a part DEL Delete multiple parts

Part Builds

GET Get a specific part build by ID GET Get a specific part build step by ID GET Get all part build steps GET Get all part builds for a store POST Search part build steps POST Search part builds PATCH Archive part builds PATCH Dismiss part builds (deprecated) PATCH Restore archived part builds

Passkeys

GET List passkeys PATCH Rename a passkey DEL Delete a passkey

Permissions

GET Get all permissions GET List permission types POST Search permissions

Print History

GET GET /v1/print-history GET GET /v2/print-history GET GET /v2/print-history/{printerId} POST POST /v1/print-history/search

Print Jobs

GET GET /v1/print-jobs/{id}/telemetry GET GET /v1/print-jobs/{id}/telemetry/attempts GET GET /v1/print-jobs/{id}/telemetry/download-url GET Get all print jobs GET Get completed job count GET Get job matching details GET Get job matching troubleshooting details GET Get print job GET List archived jobs POST Get compatible printers per queue group POST Merge print jobs onto one plate POST Run the queue matcher now POST Search print jobs POST Send job directly to a printer POST Split group POST Un-merge a plate PATCH Adjust group quantity PATCH Bulk reorder jobs PATCH Cancel print jobs PATCH Clear finished jobs PATCH Pause print jobs PATCH Prioritize jobs PATCH Reorder a job PATCH Reorder group PATCH Resume paused jobs PATCH Retry failed jobs PATCH Update print job

Printers

GET Get all printers GET Get latest camera snapshot URL GET Get printer by ID GET Get resolved capabilities GET Last printed history POST Resolve capabilities for printers POST Search printers POST Send command to printers PATCH Bulk update printers PATCH Confirm printer ready PATCH Multi-update printers PATCH Rename a printer PATCH Set Fabmatic PATCH Set printer enabled status PATCH Set provider config PATCH Update a printer DEL Delete a printer DEL Delete multiple printers

Printer Slots

GET Get all printer slots GET Get all printer slots POST Search printer slots PATCH Assign to printer slots

Printing

POST Create and queue prints POST Preview part builds and jobs (dry run)

Profiles

GET Get a specific profile GET Get all available printer models GET Get all slicer profiles GET Get available slicer versions GET Get available slicer versions for a profile GET Get full profile data with optional slicer version GET Get printer models used in your store GET Get profile with inheritance details GET Get profiles by machine model and nozzle size GET Get profiles compatible with a printer GET Get supported printer models POST Create a new profile POST Import pre-parsed profiles POST Import profiles from a file POST Preview profiles from a file POST Search profiles PATCH Update a profile DEL Delete a profile DEL Delete multiple profiles

Reports

GET Jobs report GET Materials report GET Printers report GET Profit report GET Reliability report GET Reports overview

Settings

GET Get available slicer versions GET Get completed Getting Started steps GET Get store settings GET Get user settings POST Mark a Getting Started step complete POST Reset Getting Started progress POST Search notification settings POST Search store settings POST Show or hide the Getting Started checklist PATCH Update store settings PATCH Update user settings

Shopify

GET Get Shopify settings GET Get Shopify status GET List Shopify integrations GET List Shopify products POST Disconnect Shopify POST Retry variant enrichment PATCH Update Shopify settings

SKUs

GET Get a specific SKU GET List all SKUs POST Create a new SKU POST Delete multiple SKUs POST Search SKUs PATCH Update a SKU DEL Delete a SKU

SKU Builds

GET Get a specific SKU build by ID GET Get all SKU builds for a store POST Search SKU builds

SKU Costs

GET Get a specific SKU cost by ID GET Get all costs for a specific SKU GET Get all SKU costs for a store GET Get cost breakdown for a specific SKU POST Create a new SKU cost POST Search SKU costs PATCH Update a SKU cost DEL Delete a SKU cost DEL Delete all costs for a specific SKU

SKU Variants

GET Get a specific property value by ID GET Get a specific SKU variant by ID GET Get a specific variant binding by ID GET Get a specific variant property by ID GET Get a specific variant value by ID GET Get all property values for a store GET Get all SKU variants for a store GET Get all value filters for a SKU GET Get all variant bindings for a store GET Get all variant properties for a store GET Get all variant values for a store GET Get filtered option values for a SKU GET Get SKU-specific properties GET Get value filters for a SKU and option GET Get variant values for a specific group GET Match a SKU string with variants POST Create a new SKU variant POST Create a new variant binding POST Create a new variant property POST Create a new variant value POST Create multiple property values POST Reorder a variant binding POST Reorder a variant property POST Reorder a variant value POST Search SKU options PUT Set filtered values for a SKU option PATCH Update a SKU variant PATCH Update a variant binding PATCH Update a variant property PATCH Update a variant value PATCH Update multiple property values DEL Delete a SKU variant DEL Delete a variant binding DEL Delete a variant property DEL Delete a variant value DEL Delete multiple property values DEL Remove a value filter

Staggered Start

GET Get Staggered Start group GET List Staggered Start group members GET List Staggered Start groups GET List Staggered Start holds POST Create Staggered Start group POST Release a Staggered Start hold PUT Replace Staggered Start group members PATCH Update Staggered Start group DEL Delete Staggered Start group

Stores

GET Get all stores for current user PATCH Update organization settings

Subscriptions

GET Get addon by type with tiers GET Get addon subscription by type GET Get all addon subscriptions GET Get all available addons GET Get current subscription POST Search addon subscriptions POST Search subscriptions PATCH Configure audit logs

TikTok

GET Get TikTok Shop settings GET Get TikTok Shop status GET List TikTok Shop integrations POST Sync TikTok Shop orders PATCH Update TikTok Shop settings

Users

GET GET /v1/permissions/user/{userId} GET GET /v1/roles GET GET /v1/roles/{roleId}/permissions GET GET /v1/roles/with-permissions GET GET /v1/users GET GET /v1/users/{userId} POST POST /v1/users/{userId}/permissions POST POST /v1/users/{userId}/roles POST POST /v1/users/bulk POST POST /v1/users/invite POST POST /v1/users/invite/{invitationId}/resend POST POST /v1/users/invite/{invitationId}/revoke PUT PUT /v1/users/{userId}/permissions PUT PUT /v1/users/{userId}/roles DEL DELETE /v1/users/{userId} DEL DELETE /v1/users/{userId}/permissions DEL DELETE /v1/users/{userId}/roles/{roleId}

Printago API

GET /v1/parts/{partId}/metadata

Get part metadata

Requires: part.view

Path Parameters

partId required

string

Part ID

Response Schema

Response

value

object

API Console

Base URL

Authentication

API Key

Store ID

Parameters

Request Body

Response

Send a request to see the response