Skip to main content
GET
Get company profile

Authorizations

X-API-Key
string
header
required

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

id
string
required

Unique identifier for this company.

Response

Company profile with business details, loyalty program statistics, and configuration.

id
string
required
read-only
name
string
required
read-only
trading_name
string
required
read-only
slug
string
required
read-only
Pattern: ^[-a-zA-Z0-9_]+$
email
string<email>
required
read-only
phone
string
required
read-only
website
string<uri>
required
read-only
logo_uuid
string<uuid> | null
required
read-only

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.

primary_color
string
required
read-only
secondary_color
string
required
read-only

Social media links. Keys: instagram, tiktok, linkedin, x, whatsapp

instagram_url
string<uri>
required
read-only

Instagram profile URL (e.g., https://instagram.com/eosrestaurante)

google_review_url
string<uri>
required
read-only

Google My Business review URL

menu_url
string<uri>
required
read-only

Digital menu or online store URL (e.g., digital menu, e-commerce)

survey_url
string<uri>
required
read-only

Customer satisfaction survey URL (e.g., Typeform)

address
string
required
read-only
city
string
required
read-only
state
string
required
read-only
zip_code
string
required
read-only
country
string
required
read-only
business_type
string
required
read-only
description
string
required
read-only
currency
string
required
read-only

Default currency (e.g., BRL, USD, EUR)

is_branch
boolean
required
read-only

Indicates if this company is a branch/unit of another company

branch_name
string
required
read-only

Name of the branch/unit, if applicable

is_public
boolean
required
read-only

If enabled, this company will be visible in the public directory.

status
enum<string>
required

Account status: active, locked (chargeback/fraud), or suspended

  • active - Ativo
  • locked - Bloqueado
  • suspended - Suspended
Available options:
active,
locked,
suspended
is_active
boolean
required
read-only
loyalty_programs_count
integer
required
read-only
active_customers_count
integer
required
read-only
created_at
string<date-time>
required
read-only
updated_at
string<date-time>
required
read-only
zupy_balance
string<decimal>
read-only

Company Z$ (ZUPYies) balance — usable as marketing-campaign budget.

program_setup_completed
boolean
read-only

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.

airdrop_claimed_at
string<date-time> | null
read-only

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.