Get the partner profile
Returns the partner record bound to the key, its public profile, the registered app return URL and its notification settings. The key can read these settings but cannot change them.
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/partner/me"{
"partner": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"user_id": "a169451c-8525-4352-b8ca-070dd449a1a5",
"company_name": "string",
"slug": "string",
"status": "string",
"type": "string",
"website": "string",
"contact_email": "string",
"quote_notification_emails": [
"string"
],
"office_pc4": 0,
"revenue_share_pct": 0,
"min_joulo_fee_pct": 0,
"compensation_model": "string",
"fee_discount_pct": 0,
"referral_fee_floor_pct": 0,
"branding": {},
"partner_share_b_pct": 0,
"partner_share_c_pct": 0,
"partner_share_zakelijk_years": 0,
"zakelijk_portal_enabled": true,
"partner_page_url": "string",
"partner_page_checked_at": "2019-08-24T14:15:22Z",
"partner_page_check": {},
"flat_per_charger_amount": 0,
"recurring_per_charger_amount": 0,
"flat_fee_cap_pct": 0,
"exclude_from_mailing": true,
"contract_offered_at": "2019-08-24T14:15:22Z",
"contract_signed_at": "2019-08-24T14:15:22Z",
"contract_version": "string",
"self_billing_enabled": true,
"kvk_number": "string",
"vat_number": "string",
"billing_address": "string",
"self_billing_accepted_at": "2019-08-24T14:15:22Z"
},
"masked_iban": "string",
"logo_url": "string",
"profile": {
"charger_brands": [
"string"
],
"service_area": [
"string"
],
"tagline": "string",
"about_text": "string"
},
"brand_catalog": [
"string"
],
"app_return_url": "string",
"charger_alert_kinds": [
"nooit_opgestart"
],
"charger_alert_frequency": "weekly",
"lead_settings": {
"lead_max_per_week": 0,
"lead_paused_until": "2019-08-24",
"work_radius_km": 0,
"lead_job_types": [
"vervanging"
],
"leads_last_7d": 0
},
"is_impersonating": true,
"is_primary_owner": true
}{
"error": "Missing or invalid API token"
}{
"error": "No partner is linked to this API key"
}{
"error": "Too many requests",
"retry_after_seconds": 3
}{
"error": "Authentication is temporarily unavailable, try again shortly"
}