Skip to content

Partner API

API reference

Generated from the live OpenAPI 3.1 spec. Base URL: https://api.trueplate.ai/v1. Every endpoint path begins with /partner and is printed in full on the endpoint itself, so base plus path is the URL you call. The navigation drops the prefix to keep the tree readable. Authenticate with a secret key (Bearer).

Keys

GET Inspect the calling key

Scopes

Every request authenticates with the apiKey security scheme (http bearer, tp_sk_live_…).

Secret API key from your Developers page. Server-side only: never ship it in an app or web page (that's what publishable keys and the embed viewer are for).

The spec declares no additional key scope for this operation.

Request

This request has no parameters.

Responses

  • 200Key metadata, scopes, and holder.
  • 401Missing or invalid API key.
  • 403Key type, scope, origin, restaurant authorization, or subscription entitlement rejected the request.
  • 429Per-key rate limit exceeded: slow down and retry.

Response body

  • dataMerequired

    • keyIdstringrequired

    • type"SECRET" | "PUBLISHABLE"required

    • environment"LIVE" | "TEST"required

    • namestringrequired

    • scopesarray of stringrequired

    • rateLimitPerMinnumberrequired

    • restaurantobject | nullrequired

    • integratorOrgobject | nullrequired

    • docsUrlstringrequired

GET/partner/me
curl https://api.trueplate.ai/v1/partner/me \
  -H "Authorization: Bearer tp_sk_live_YOUR_KEY"
200Response application/json
{
  "data": {
    "keyId": "string",
    "type": "SECRET",
    "environment": "LIVE",
    "name": "string",
    "scopes": [
      "string"
    ],
    "rateLimitPerMin": 0,
    "restaurant": {
      "id": "string",
      "name": "string",
      "slug": "string"
    },
    "integratorOrg": {
      "id": "string",
      "name": "string",
      "slug": "string"
    },
    "docsUrl": "string"
  }
}