JouloDocs

Identify the API key

Returns the Joulo account behind the key: the partner's primary account, or the partner id when the partner has no linked account. Use it to check that a key works.

GET
/me
AuthorizationBearer <token>

Partner API key, sent as Authorization: Bearer <key>. Production keys start with jpk_live_ and work only on https://api.joulo.nl. Sandbox keys start with jpk_test_ and work only on https://api-staging.joulo.nl. Sandbox keys minted before September 2026 also start with jpk_live_. A key used on the wrong host returns 401 with a detail. A key is bound to one partner and reaches only the Partner API routes. Any other route returns 404 when it does not exist. A route that needs a scope the key lacks, such as GET /sessions, returns 403 with error: Insufficient scope and a required_scope. Every other route returns 403 with error: partner_api_key_scope. Mint and revoke keys in the partner portal. A partner has one active key at a time.

In: header

Response Body

curl -X GET "https://api.joulo.nl/functions/v1/api/me"
{
  "user_id": "string",
  "email": "string",
  "display_name": "string",
  "first_name": "string",
  "last_name": "string",
  "scopes": [
    "string"
  ],
  "effective_fee_pct": 0,
  "ere_price_mid": 0
}
{
  "error": "Missing or invalid API token"
}
{
  "error": "Too many requests",
  "retry_after_seconds": 3
}
{
  "error": "Authentication is temporarily unavailable, try again shortly"
}