Collections
List Collections

List collections

Returns your business's collections, newest first.

GET
https://api-prod.useknit.io/api/v1/collections
Scopecollections:readAuthBearer token

Query parameters

All filters are optional and combine with AND.

statusstringoptional

Exact match on collection status, for example PENDING or SUCCESSFUL.

networkstringoptional

Exact match on network identifier, for example MATIC_MAINNET.

tokenstringoptional

Exact match on token symbol, for example USDT.

minAmountnumberoptional

Only collections whose tokenAmount is greater than or equal to this.

maxAmountnumberoptional

Only collections whose tokenAmount is less than or equal to this.

startDatedateoptional

Only collections created at or after this date.

endDatedateoptional

Only collections created at or before this date.

This endpoint returns the full filtered result set — there is no pagination object in the response. Narrow with startDate / endDate rather than fetching everything on a schedule.

Request

cURL
curl -G "https://api-prod.useknit.io/api/v1/collections" \
  -H "Authorization: Bearer $KNIT_ACCESS_TOKEN" \
  -H "Accept: application/json" \
  --data-urlencode "status=SUCCESSFUL" \
  --data-urlencode "token=USDT" \
  --data-urlencode "startDate=2024-08-01"

Response

200 OK
{
  "statusCode": 200,
  "message": "Collections fetched successfully",
  "data": [
    {
      "id": "9cddd3ad-c2a8-463c-a703-158b900beea8",
      "network": "MATIC_MAINNET",
      "token": "USDT",
      "address": "0x3761f3504104f4faa8959963a5d8dce89989d45b",
      "tokenAmount": "2500.000000000000000000",
      "tokenAmountRequested": "2500.000000000000000000",
      "tokenAmountReceived": null,
      "tokenToUsd": "1.00000000",
      "feeInUsd": "0.00000000",
      "feeByToken": "0.000000000000000000",
      "fiatExchangeRateToUsd": null,
      "fiatAmountInUsd": null,
      "fiatAmount": null,
      "fiatAmountCurrency": null,
      "status": "PENDING",
      "transactionHash": null,
      "transactionBlockNumber": null,
      "numberOfConfirmations": null,
      "confirmationThreshold": 10,
      "merchantRedirectUrl": null,
      "merchantCallbackUrl": "https://example.com/webhooks/knit",
      "paymentLinkUrl": "https://checkout.collection.useknit.io/9cddd3ad-c2a8-463c-a703-158b900beea8",
      "expiresAt": "2024-08-27T14:02:10.000000Z",
      "createdAt": "2024-08-27T13:32:10.000000Z",
      "updatedAt": "2024-08-27T13:32:10.000000Z"
    }
  ],
  "success": true
}

Decimal fields come back as strings to preserve full precision. Parse them with a decimal library rather than a float.

Errors

StatusCause
401Missing or invalid token, IP not allow-listed, or missing collections:read
422A filter value has the wrong type, for example a non-date startDate. Query-parameter failures on this endpoint return the full envelope with errors — see Requests & responses