API reference · Getting around

Account

Check your key and see what it is allowed to do.

get/me

Who am I

Returns the business behind this API key, its plan, what it may do, its commission rates and its limits. A good first call to check that a key works.

Response 200

In data:

  • keyobject
    Show 6 fields
    • idinteger
    • labelstring · nullable
    • modeenum

      livetest

    • prefixstring

      The first characters of the key (never the key).

    • lastUsedAtdate-time · nullable

      ISO 8601 date-time.

    • createdAtdate-time

      ISO 8601 date-time.

  • limitsobject
    Show 1 fields
    • requestsPerMinuteinteger
  • businessobject · nullable
    Show 5 fields
    • idinteger
    • namestring
    • planenum

      marketplacefleetboth

    • statusenum

      pendingapprovedsuspendedrejected

    • websitestring · nullable
  • capabilitiesobject
    Show 3 fields
    • sellOwnersCarsboolean
    • ownFleetboolean
    • liveModeboolean

      False until we approve your business.

  • ratesobject

    Your rates, in percent: your own agreed ones or our defaults.

    Show 4 fields
    • rentalCommissionPercentnumber
    • rentalSoftwareFeePercentnumber
    • saleReferralPercentnumber
    • saleSoftwareFeePercentnumber
  • webhookobject
    Show 3 fields
    • configuredboolean
    • pausedboolean
    • urlstring · nullable

Errors

  • 401unauthorized: the API key is missing, wrong or revoked.
  • 429rate_limited: more than 120 requests a minute. Wait for RateLimit-Reset seconds.
curl "https://engine-production-0004.up.railway.app/api/v1/me" \
  -H "Authorization: Bearer wc_test_YOUR_KEY"
Response · 200
{
  "data": {
    "key": {
      "id": 4,
      "label": "Production server",
      "mode": "live",
      "prefix": "wc_live_9fK2",
      "lastUsedAt": "2026-11-01T11:59:00.000Z",
      "createdAt": "2026-10-20T08:00:00.000Z"
    },
    "limits": {
      "requestsPerMinute": 120
    },
    "business": {
      "id": 2,
      "name": "Alpha Rentals",
      "plan": "both",
      "status": "approved",
      "website": "https://alpha.example"
    },
    "capabilities": {
      "sellOwnersCars": true,
      "ownFleet": true,
      "liveMode": true
    },
    "rates": {
      "rentalCommissionPercent": 15,
      "rentalSoftwareFeePercent": 3,
      "saleReferralPercent": 1.5,
      "saleSoftwareFeePercent": 1
    },
    "webhook": {
      "configured": true,
      "paused": false,
      "url": "https://alpha.example/hooks/waca"
    }
  }
}