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

# Get program

> Returns the settings of your own white-label affiliate program. Requires a brand key with scope `whitelabel:program:read`.

Returns the settings of your own white-label affiliate program. Requires scope `whitelabel:program:read`.


## OpenAPI

````yaml api-reference/brand/openapi.json GET /brand/whitelabel/program
openapi: 3.1.0
info:
  title: Lomadee Brand API
  version: 1.0.0
  description: >-
    Read-only REST API for brands. Network and white-label programs have
    separate paths and separate keys.
servers:
  - url: https://api.lomadee.com.br
    description: Production
security:
  - x-api-key: []
tags:
  - name: Network
    description: >-
      Your affiliate program on the Lomadee network. Affiliates are never
      identified; only their channels are.
  - name: White label
    description: Your own white-label affiliate program.
paths:
  /brand/whitelabel/program:
    get:
      tags:
        - White label
      summary: Get program
      description: >-
        Returns the settings of your own white-label affiliate program. Requires
        a brand key with scope `whitelabel:program:read`.
      parameters: []
      responses:
        '200':
          description: Program settings
          headers:
            X-RateLimit-Limit:
              $ref: '#/components/headers/X-RateLimit-Limit'
            X-RateLimit-Remaining:
              $ref: '#/components/headers/X-RateLimit-Remaining'
            X-RateLimit-Reset:
              $ref: '#/components/headers/X-RateLimit-Reset'
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    $ref: '#/components/schemas/WhitelabelProgram'
                required:
                  - data
        '401':
          $ref: '#/components/responses/Unauthorized'
        '403':
          $ref: '#/components/responses/Forbidden'
        '429':
          $ref: '#/components/responses/TooManyRequests'
components:
  headers:
    X-RateLimit-Limit:
      description: Requests allowed in the window.
      schema:
        type: integer
    X-RateLimit-Remaining:
      description: Requests left in the window.
      schema:
        type: integer
    X-RateLimit-Reset:
      description: Unix timestamp when the window resets.
      schema:
        type: integer
  schemas:
    WhitelabelProgram:
      type: object
      properties:
        vertical:
          type: string
          enum:
            - whitelabel
        organizationId:
          type: string
          description: Your organization id.
          format: uuid
        name:
          type: string
          description: Brand name.
        slug:
          type: string
          description: Brand slug.
        active:
          type: boolean
          description: Whether the program is active.
        isPublic:
          type: boolean
          description: Whether the program is open to any affiliate without an invitation.
        domain:
          type: string
          description: Domain where the program runs.
        businessModel:
          type: string
          description: Program business model.
          enum:
            - ecommerce
            - transactions
    Error:
      type: object
      properties:
        success:
          type: boolean
          enum:
            - false
        message:
          type: string
          description: Human-readable description.
        code:
          type: string
          description: Error code.
          example: FORBIDDEN
      required:
        - success
        - message
        - code
  responses:
    Unauthorized:
      description: >-
        Missing, invalid, expired or revoked key, or a key that is not a brand
        key.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
          example:
            success: false
            message: Invalid API key
            code: UNAUTHORIZED
    Forbidden:
      description: The key belongs to the other vertical or lacks the scope of the route.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
          example:
            success: false
            message: Insufficient scope
            code: FORBIDDEN
    TooManyRequests:
      description: Rate limit exceeded.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
          example:
            success: false
            message: Too many requests
            code: TOO_MANY_REQUESTS
      headers:
        Retry-After:
          description: Seconds to wait before retrying.
          schema:
            type: integer
  securitySchemes:
    x-api-key:
      type: apiKey
      in: header
      name: x-api-key
      description: Brand key created in the dashboard.

````

This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.