Quickstart

Create a key

An organization admin creates keys in the app under Organization > Integrations > API keys. A key is named, given its scopes at creation, and shown once: copy it into your secret store before closing the dialog. A key belongs to one organization and only ever sees that organization’s data.Keys look like tk_ followed by an opaque string. They are not JSON Web Tokens and carry nothing you can decode.

Make a request

Send the key as a bearer token. Every route lives under /api/v1/ on the app origin.

curl "https://app.portmark.io/api/v1/products?limit=5" \
  -H "Authorization: Bearer tk_your_key_here"

Read the envelope

Every list returns data and meta. data is the page; meta tells you where you are and how many rows exist in total.

{
  "data": [
    {
      "id": "prd_01j9z3a4b5c6d7e8f9g0h1j2k3",
      "name": "Cast iron pan 28 cm",
      "sku": "CIP-28",
      "barcode": null,
      "description": null,
      "hs_code": "732393",
      "cost_cents": 1250,
      "image": null,
      "packaging_levels": [],
      "tags": [],
      "created_at": "2026-08-30T09:12:44.000Z",
      "updated_at": "2026-09-02T15:01:03.000Z"
    }
  ],
  "meta": { "total": 1, "limit": 5, "offset": 0 }
}

A single resource returns the object itself, with no wrapper. Every field is snake_case, every timestamp is ISO 8601 in UTC, and money is in minor units.

Where to go next

Authentication and Scopes cover what a key can and cannot do.
Pagination, filtering and sorting covers the query parameters every list shares.
List products is the request above; every other operation is documented the same way in the API reference, with a playground to try each one.

Get started

Conventions

Webhooks

Where to go next

​Where to go next

Where to go next