Get company profile
Retrieve the company profile associated with the authenticated user’s current context.
Authorizations
Per-company partner API key (zupy_pk_…). Validated by Zupy against the company integration key hash (Story 14.x); send it on every request as the X-API-Key header. Scoped read-write to the owning company's data.
Path Parameters
Unique identifier for this company.
Response
Company profile with business details, loyalty program statistics, and configuration.
^[-a-zA-Z0-9_]+$UUID identifier for company logo stored in CDN. Points to 2 formats: logo.png (512x512), icon.png (256x256). Use CDNService.get_logo_formats() to construct URLs.
Social media links. Keys: instagram, tiktok, linkedin, x, whatsapp
Instagram profile URL (e.g., https://instagram.com/eosrestaurante)
Google My Business review URL
Digital menu or online store URL (e.g., digital menu, e-commerce)
Customer satisfaction survey URL (e.g., Typeform)
Default currency (e.g., BRL, USD, EUR)
Indicates if this company is a branch/unit of another company
Name of the branch/unit, if applicable
If enabled, this company will be visible in the public directory.
Account status: active, locked (chargeback/fraud), or suspended
active- Ativolocked- Bloqueadosuspended- Suspended
active, locked, suspended Company Z$ (ZUPYies) balance — usable as marketing-campaign budget.
Story 0.2 onboarding gate: true once the merchant has finished the loyalty-program setup wizard. Dashboards use it to hide the 'Finalizar Programa' CTA when the company is fully configured.
Timestamp when the merchant claimed the initial Z$ 2.000 airdrop. null for companies that never went through the campaign-onboarding wizard. The pair (airdrop_claimed_at, zupy_balance) lets a partner UI decide whether to surface the airdrop CTA without a state-mutating call.