Skip to content
DOTWICK
Start free

API reference

Routes

Routes not listed here are for the app only and answer a key with 403 session_required. Routes marked idempotent accept an Idempotency-Key.

Codes

MethodPathScopePurpose
GET/v1/codescodes:readList codes, filter by folder, type or status
POST/v1/codescodes:writeCreate a codeidempotent
GET/v1/codes/{id}codes:readRetrieve a code with its design and rules
PATCH/v1/codes/{id}codes:writeChange destination, name, design, rules
DELETE/v1/codes/{id}codes:writeDelete a code (its short link answers 410)
POST/v1/codes/movecodes:writeMove codes to a folderidempotent
POST/v1/codes/move-domaincodes:writeMove codes to another domainidempotent
POST/v1/codes/tagscodes:writeAdd or remove tags on many codesidempotent
POST/v1/codes/{id}/duplicatecodes:writeDuplicate a codeidempotent
PATCH/v1/codes/bulkcodes:writePause, resume, archive, tag, move or delete many codes
GET/v1/utm-presetscodes:readList saved UTM presets
GET/v1/codes/{id}/versionscodes:readDestination history of a code
GET/v1/codes/{id}/activitycodes:readActivity feed of a code
GET/v1/codes/{id}/exportcodes:readDownload as SVG, PNG, JPG, PDF or EPS
GET/v1/codes/{id}/hosted-statscodes:readCounters of a hosted code
GET/v1/codes/{id}/submissionssubmissions:readResponses to a form code
GET/v1/codes/{id}/submissions/exportsubmissions:readForm responses as CSV
GET/v1/gs1/productscodes:readList GS1 products (the gs1 codes)
GET/v1/codes/{id}/gs1/qualifierscodes:readBatch, CPV and serial levels of a GS1 code
GET/v1/codes/{id}/gs1/print-runscodes:readPrint runs of a GS1 code
GET/v1/codes/{id}/gs1/print-runs/{runId}codes:readPoll a print run and get its file links

Bulk runs

MethodPathScopePurpose
POST/v1/codes/bulkcodes:writeCreate up to 500 codes as one runidempotent
GET/v1/bulk-importscodes:readList bulk runs
GET/v1/bulk-imports/{id}codes:readPoll a bulk run
GET/v1/bulk-imports/{id}/rowscodes:readRows of a bulk run
GET/v1/bulk-imports/{id}/results.csvcodes:readResults of a run as CSV
POST/v1/bulk-imports/{id}/cancelcodes:writeCancel a queued or running runidempotent
POST/v1/bulk-imports/{id}/retrycodes:writeRetry the failed rows of a runidempotent

Analytics

MethodPathScopePurpose
GET/v1/analytics/summaryanalytics:readScan totals for a range
GET/v1/analytics/timeseriesanalytics:readScans over time
GET/v1/analytics/breakdownanalytics:readTop countries, devices, …
GET/v1/analytics/scansanalytics:readPer-scan records
GET/v1/analytics/sparklinesanalytics:readDaily counts for codes
GET/v1/analytics/compareanalytics:readCompare up to 4 codes
GET/v1/analytics/exportanalytics:readScans as CSV (small ranges)
POST/v1/analytics/exportsanalytics:readScans as CSV, prepared in the backgroundidempotent
GET/v1/codes/{id}/analytics/summaryanalytics:readOne code's totals
GET/v1/codes/{id}/analytics/timeseriesanalytics:readOne code over time
GET/v1/codes/{id}/analytics/breakdownanalytics:readOne code's top lists
GET/v1/codes/{id}/scansanalytics:readOne code's per-scan records
GET/v1/codes/{id}/gs1/batchesanalytics:readScans per batch of a GS1 code
GET/v1/codes/{id}/downloadsanalytics:readDownloads by file of a Documents code
GET/v1/analytics/locationsanalytics:readGPS map of consenting scans
GET/v1/codes/{id}/analytics/locationsanalytics:readOne code's GPS map
GET/v1/alertsanalytics:readList scan alert rules

Exports

MethodPathScopePurpose
POST/v1/exportscodes:readExport many codes as one ZIPidempotent
GET/v1/exportscodes:readList exports
GET/v1/exports/{id}codes:readPoll an export and get the ZIP link

Folders

MethodPathScopePurpose
GET/v1/foldersfolders:readList folders
POST/v1/foldersfolders:writeCreate a folderidempotent
GET/v1/folders/{id}folders:readRetrieve a folder
PATCH/v1/folders/{id}folders:writeRename or move a folder
DELETE/v1/folders/{id}folders:writeDelete a folder (codes move up)

Templates

MethodPathScopePurpose
GET/v1/templatestemplates:readList design templates
POST/v1/templatestemplates:writeCreate a templateidempotent
GET/v1/templates/{id}templates:readRetrieve a template
PATCH/v1/templates/{id}templates:writeChange a template
DELETE/v1/templates/{id}templates:writeDelete a template

Uploads

MethodPathScopePurpose
POST/v1/assetscodes:writeUpload a logo or a file
GET/v1/assets/{id}codes:readRetrieve an upload with a signed URL

Domains

MethodPathScopePurpose
GET/v1/domainsdomains:readList custom domains
GET/v1/domains/{id}domains:readRetrieve a domain and its status
GET/v1/subdomaindomains:readThe workspace's subdomain and its links
GET/v1/subdomain/availabilitydomains:readCheck if a subdomain label is free

Workspace

MethodPathScopePurpose
GET/v1/workspaces/currentany keyThe key's workspace and plan
GET/v1/usageany keyPlan limits and usage this month

Webhooks

MethodPathScopePurpose
GET/v1/webhookswebhooks:readList webhook endpoints
POST/v1/webhookswebhooks:writeRegister an endpoint and event typesidempotent
GET/v1/webhooks/{id}webhooks:readRetrieve an endpoint
PATCH/v1/webhooks/{id}webhooks:writeChange or re-enable an endpoint
DELETE/v1/webhooks/{id}webhooks:writeDelete an endpoint
POST/v1/webhooks/{id}/testwebhooks:writeSend a webhook.test eventidempotent
GET/v1/webhooks/{id}/deliverieswebhooks:readDeliveries of an endpoint
GET/v1/webhooks/{id}/deliveries/{deliveryId}webhooks:readA delivery with its attempts
POST/v1/webhooks/{id}/deliveries/{deliveryId}/redeliverwebhooks:writeSend a delivery againidempotent
POST/v1/webhooks/{id}/recoverwebhooks:writeResend failed deliveriesidempotent

Tags

MethodPathScopePurpose
GET/v1/tagstags:readList tags
POST/v1/tagstags:writeCreate a tagidempotent
GET/v1/tags/{id}tags:readRetrieve a tag
PATCH/v1/tags/{id}tags:writeRename or recolour a tag
DELETE/v1/tags/{id}tags:writeDelete a tag (removed from its codes)

Reports

MethodPathScopePurpose
POST/v1/reportsanalytics:readRender a PDF or CSV analytics reportidempotent
GET/v1/reportsanalytics:readList rendered reports
GET/v1/reports/{id}analytics:readPoll a report and get its link

Zapier and Make hooks

MethodPathScopePurpose
GET/v1/hookswebhooks:readList integration hooks
POST/v1/hookswebhooks:writeSubscribe a hook to one eventidempotent
DELETE/v1/hooks/{id}webhooks:writeUnsubscribe a hook
GET/v1/hooks/samples/{event}webhooks:readRecent events of a type, for a trigger's sample

Business cards

MethodPathScopePurpose
GET/v1/cardscards:readList team business cards
POST/v1/cardscards:writeCreate a business cardidempotent
GET/v1/cards/{id}cards:readRetrieve a business card
PATCH/v1/cards/{id}cards:writeChange a business card
POST/v1/cards/{id}/deactivatecards:writeDeactivate a business cardidempotent
GET/v1/cards/{id}/analyticscards:readViews, saves and taps of a card

Conversions

MethodPathScopePurpose
POST/v1/conversionsconversions:writeRecord a conversionidempotent
GET/v1/analytics/funnelanalytics:readScan to revenue funnel

NFC tags

MethodPathScopePurpose
GET/v1/nfc/tagscodes:readList NFC tags
POST/v1/nfc/tagscodes:writeRegister an NFC tag on a codeidempotent