---
title: "Get authenticated partner information"
method: GET
path: "/me"
tags: ["ReferralPartners"]
---

# Get authenticated partner information

`GET /me`

Retrieves complete configuration and styling information for the authenticated referral partner.

Authentication
- Requires a valid API key in the XApiKey header
- The API key uniquely identifies the referral partner

Response Data
- Partner identification (ID, system name, display name)
- Branding configuration (logo URLs, colors, fonts)
- Revenue sharing percentage
- Partner status and settings

Use Cases
- Configure white-label branding for client onboarding pages
- Display partner-specific styling in integrations
- Verify partner configuration and settings
- Retrieve commission/fee percentage for revenue calculations

The styling properties returned can be used to customize the appearance of onboarding pages
and other partner-facing interfaces to match the referral partner's branding.

## Response `200`

Partner information retrieved successfully

- DebituraWebReferralPartnerApiModelsReferralPartnersReferralPartnerResponse — Response containing referral partner information including styling configuration.
  - `id` string, uuid — Unique identifier for the referral partner.
  - `companyName` string, nullable — Company name of the referral partner.
  - `shortName` string, nullable — Short name of the referral partner.
  - `contactEmail` string, nullable — Contact email for the referral partner.
  - `externalSystemId` string, nullable — External system identifier for the partner.
  - `referralFeePercentage` number, double — Percentage of Debitura's earnings that will be paid as referral fee.
  - `isActive` boolean — Whether the partner is currently active.
  - `isPublicDemo` boolean — When true, this partner is used for public onboarding demos and may have demo-specific behaviour.
  - `logoUrl` string, nullable — URL to the referral partner's logo image.
  - `backgroundColorCode` string, nullable — Background color code for custom styling (e.g., "#FFFFFF").
  - `fontColor` string, nullable — Font color code for custom styling (e.g., "#000000").
  - `fontFamily` string, nullable — Font family for custom styling (e.g., "Arial, sans-serif").
  - `invoicingTriggerMode` 'PayWhenPaid' | 'ConfirmedPipeline' — Controls what condition triggers a referral partner's payout to become "ready to invoice" Debitura for their referral fee. Per-partner override; see Debitura.Domain.Model.ReferralPartners.ReferralPartner.InvoicingTriggerMode. This enum is also returned directly on the ReferralPartnerApi `GET /me` response (`ReferralPartnerResponse.InvoicingTriggerMode`). Wire format is locked to named PascalCase string values ("PayWhenPaid", "ConfirmedPipeline") via Newtonsoft.Json StringEnumConverter — that host uses Newtonsoft (AddNewtonsoftJson in Program.cs), so a System.Text.Json JsonStringEnumConverter attribute alone would be silently ignored; both are declared so STJ-based consumers (and our own tests) can also deserialize the string form.

## Other responses

- `404` — Referral partner not found (invalid configuration)
- `500` — Internal server error

---

[API](https://skmtc.net/debitura/apis/debitura-referral-partner-api.md) · [All operations](https://skmtc.net/debitura/apis/debitura-referral-partner-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/debitura/debitura-referral-partner-api/revisions/8d237e9c6592/schema)