> ## Documentation Index
> Fetch the complete documentation index at: https://docs.zupy.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Get company profile

> Retrieve the company profile associated with the authenticated user's current context.



## OpenAPI

````yaml /api-reference/openapi.json get /api/v2/companies/{id}/
openapi: 3.0.3
info:
  title: Zupy API v2
  version: 2.0.0
  description: >-
    Zupy API v2 — versioned, gateway-aware API with envelope responses, RFC 7807
    errors, and multi-auth support (JWT, API Key, Device Key).
servers:
  - url: https://api.zupy.com
    description: Production
security: []
tags:
  - name: Authentication
    description: OTP request and verification endpoints
  - name: Customers
    description: Customer management, points, history, and data operations
  - name: Loyalty Programs
    description: Loyalty program configuration and details
  - name: Rewards
    description: Loyalty reward catalog (definitions redeemed with points)
  - name: Companies
    description: Company information and loyalty configuration
  - name: Coupons
    description: >-
      Issued coupons (RewardRedemption) — both loyalty-reward redemptions and
      marketing claims
  - name: Wallet
    description: Apple Wallet pass generation and notifications
  - name: Webhooks
    description: Partner integration webhook endpoints
  - name: Webhook Management
    description: Configure and test outbound webhook delivery
paths:
  /api/v2/companies/{id}/:
    get:
      tags:
        - Companies
      summary: Get company profile
      description: >-
        Retrieve the company profile associated with the authenticated user's
        current context.
      operationId: companies_retrieve
      parameters:
        - in: path
          name: id
          schema:
            type: string
          description: Unique identifier for this company.
          required: true
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CompanyProfile'
          description: ''
        '401':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
          description: ''
        '403':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
          description: ''
        '404':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
          description: ''
        '429':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
          description: ''
      security:
        - apiKeyAuth: []
components:
  schemas:
    CompanyProfile:
      type: object
      description: >-
        Company profile with business details, loyalty program statistics, and
        configuration.
      properties:
        id:
          type: string
          readOnly: true
        name:
          type: string
          readOnly: true
          title: Nome
        trading_name:
          type: string
          readOnly: true
        slug:
          type: string
          readOnly: true
          pattern: ^[-a-zA-Z0-9_]+$
        email:
          type: string
          format: email
          readOnly: true
          title: E-mail
        phone:
          type: string
          readOnly: true
        website:
          type: string
          format: uri
          readOnly: true
        logo_uuid:
          type: string
          format: uuid
          readOnly: true
          nullable: true
          description: >-
            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:
          type: string
          readOnly: true
        secondary_color:
          type: string
          readOnly: true
        social_links:
          readOnly: true
          description: 'Social media links. Keys: instagram, tiktok, linkedin, x, whatsapp'
        instagram_url:
          type: string
          format: uri
          readOnly: true
          description: Instagram profile URL (e.g., https://instagram.com/eosrestaurante)
        google_review_url:
          type: string
          format: uri
          readOnly: true
          description: Google My Business review URL
        menu_url:
          type: string
          format: uri
          readOnly: true
          title: Menu/Store URL
          description: Digital menu or online store URL (e.g., digital menu, e-commerce)
        survey_url:
          type: string
          format: uri
          readOnly: true
          description: Customer satisfaction survey URL (e.g., Typeform)
        address:
          type: string
          readOnly: true
        city:
          type: string
          readOnly: true
        state:
          type: string
          readOnly: true
        zip_code:
          type: string
          readOnly: true
        country:
          type: string
          readOnly: true
        business_type:
          type: string
          readOnly: true
        description:
          type: string
          readOnly: true
        currency:
          type: string
          readOnly: true
          description: Default currency (e.g., BRL, USD, EUR)
        is_branch:
          type: boolean
          readOnly: true
          title: Is Branch/Unit
          description: Indicates if this company is a branch/unit of another company
        branch_name:
          type: string
          readOnly: true
          title: Branch/Unit Name
          description: Name of the branch/unit, if applicable
        is_public:
          type: boolean
          readOnly: true
          title: Public
          description: If enabled, this company will be visible in the public directory.
        status:
          allOf:
            - $ref: '#/components/schemas/CompanyProfileStatusEnum'
          readOnly: true
          title: Account Status
          description: |-
            Account status: active, locked (chargeback/fraud), or suspended

            * `active` - Ativo
            * `locked` - Bloqueado
            * `suspended` - Suspended
        is_active:
          type: boolean
          readOnly: true
        loyalty_programs_count:
          type: integer
          readOnly: true
        active_customers_count:
          type: integer
          readOnly: true
        created_at:
          type: string
          format: date-time
          readOnly: true
        updated_at:
          type: string
          format: date-time
          readOnly: true
        zupy_balance:
          type: string
          format: decimal
          readOnly: true
          description: Company Z$ (ZUPYies) balance — usable as marketing-campaign budget.
        program_setup_completed:
          type: boolean
          readOnly: true
          description: >-
            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:
          type: string
          format: date-time
          readOnly: true
          nullable: true
          description: >-
            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.
      required:
        - active_customers_count
        - address
        - branch_name
        - business_type
        - city
        - country
        - created_at
        - currency
        - description
        - email
        - google_review_url
        - id
        - instagram_url
        - is_active
        - is_branch
        - is_public
        - logo_uuid
        - loyalty_programs_count
        - menu_url
        - name
        - phone
        - primary_color
        - secondary_color
        - slug
        - social_links
        - state
        - status
        - survey_url
        - trading_name
        - updated_at
        - website
        - zip_code
    Error:
      type: object
      description: RFC 7807 Problem Details error response.
      properties:
        type:
          type: string
          format: uri
        title:
          type: string
        status:
          type: integer
        detail:
          type: string
        instance:
          type: string
      required:
        - detail
        - instance
        - status
        - title
        - type
    CompanyProfileStatusEnum:
      enum:
        - active
        - locked
        - suspended
      type: string
      description: |-
        * `active` - Ativo
        * `locked` - Bloqueado
        * `suspended` - Suspended
  securitySchemes:
    apiKeyAuth:
      type: apiKey
      in: header
      name: X-API-Key
      description: >-
        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.

````