API reference

Base URL https://api.urlcrop.com/v1 · API version 1.0.0 · 110 operations. Authenticate with an API key in the Authorization: Bearer uc_live_… header; each operation lists the scope it needs. Dashboard-only routes are not part of the public API and are not listed.

• Workspaces1 operation

  The tenant. Every other resource belongs to exactly one workspace (live or test).

• Members8 operations

  People in a workspace and their roles (Owner, Admin, Editor, Viewer).

• Domains7 operations

  Branded domains. DNS-only CNAME/A record to the URLCrop server; TLS issued on demand.

• Links15 operations

  Short links with UTM, expiry, password, social preview, safety and destination health.

• Jobs2 operations

  Progress and results of bulk link creation and CSV imports.

• QR codes9 operations

  Dynamic QR codes (editable, tracked) and static QR codes, with design and cached renders.

• Assets3 operations

  Uploaded images (QR logos, OG images, page images).

• Pages9 operations

  Link-in-bio pages served at `crop.sh/p/slug` or on a custom domain.

• Campaigns6 operations

  Group links and QR codes for roll-up analytics.

• Tags4 operations
• UTM templates5 operations
• Insights6 operations

  Analytics served from hourly/daily rollups; raw recent events; CSV exports.

• Conversions5 operations

  Server-side Conversions API (Phase 2, Business plan). Attribution via click_id, coupon or customer.

• Collect1 operation

  Browser-snippet endpoint authenticated with a publishable key (Phase 2).

• Webhooks11 operations

  Signed outbound webhooks (HMAC-SHA256) with delivery log, retries and secret rotation.

• Billing6 operations

  Plans, subscription, checkout (Razorpay/PayPal), invoices, usage. All purchases are final.

• Usage1 operation
• Test mode2 operations

  Helpers available only with test-mode credentials.

• Public9 operations

  Credential-free or token-bearing routes. None of them creates or stores a link.