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

# Get detail for a brand in this program's catalog.



## OpenAPI

````yaml /program/api/openapi/2.0.0/perks/openapi.json get /perks/consumers/{consumer_id}/brands/{brand_id}
openapi: 3.1.0
info:
  description: |
    Paylead Program API.
    You can find complete documentation in https://docs.paylead.com/
  license:
    name: Proprietary
    url: https://docs.paylead.com/
  title: Perks
  version: 2.0.0
servers:
  - description: Sandbox
    url: https://api-{programRef}.sandbox.paylead.tech
    variables:
      programRef:
        default: changeme
        description: Program reference provided by Paylead
security:
  - oauth2: []
tags:
  - description: Routes used to query consumers resources
    name: Consumers
    x-displayName: Consumers
  - name: UPM
    x-displayName: UPM
  - name: Brands
    x-displayName: Brands
  - name: KYC
    x-displayName: KYC
  - name: Offers
    x-displayName: Offers
  - name: Rewards
    x-displayName: Rewards
  - name: Segments
    x-displayName: Segments
  - name: Voucher Orders
    x-displayName: Voucher Orders
paths:
  /perks/consumers/{consumer_id}/brands/{brand_id}:
    get:
      tags:
        - Brands
      summary: Get detail for a brand in this program's catalog.
      operationId: perks__consumers__consumer_id__brands__brand_id__get
      parameters:
        - in: path
          name: consumer_id
          required: true
          schema:
            example: consumer-12345
            examples:
              - consumer-12345
            maxLength: 100
            minLength: 2
            pattern: ^[a-zA-Z0-9_-]+$
            title: Consumer Id
            type: string
        - in: path
          name: brand_id
          required: true
          schema:
            example: 3fa85f64-5717-4562-b3fc-2c963f66afa6
            examples:
              - 3fa85f64-5717-4562-b3fc-2c963f66afa6
            format: uuid
            title: Brand Id
            type: string
        - description: >-
            BCP 47 language tag(s) for localised fields; the first tag is
            matched exactly against the tags stored for this brand (e.g.
            'fr-FR', 'en-GB'). A tag with no exact match (including a bare
            language code like 'en') falls back to the program's configured
            language.
          in: header
          name: Accept-Language
          required: false
          schema:
            anyOf:
              - type: string
              - type: 'null'
            description: >-
              BCP 47 language tag(s) for localised fields; the first tag is
              matched exactly against the tags stored for this brand (e.g.
              'fr-FR', 'en-GB'). A tag with no exact match (including a bare
              language code like 'en') falls back to the program's configured
              language.
            example: fr-FR
            examples:
              - fr-FR
            title: Accept-Language
        - examples:
            default:
              value: 2.0.0
          in: header
          name: x-api-version
          required: true
          schema:
            default: 2.0.0
            title: X-Api-Version
            type: string
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Perks_BrandDetailSchema'
          description: Successful Response
        '400':
          content:
            application/json:
              example:
                code: PL-400-00
                errors:
                  - loc:
                      - body
                      - field
                    msg: Field required
                    type: missing
                instance: /path/of/the/request
                status: 400
                title: Bad Request
              schema:
                $ref: '#/components/schemas/ErrorResponse'
          description: Bad Request
        '401':
          content:
            application/json:
              examples:
                PL-401-00:
                  summary: Unauthorized
                  value:
                    code: PL-401-00
                    status: 401
                    title: Unauthorized
              schema:
                $ref: '#/components/schemas/ErrorResponse'
          description: Unauthorized
        '404':
          content:
            application/json:
              examples:
                PL-404-00:
                  summary: Not Found
                  value:
                    code: PL-404-00
                    status: 404
                    title: Not Found
                PL-404-02:
                  summary: Consumer Not Enrolled
                  value:
                    code: PL-404-02
                    status: 404
                    title: Consumer Not Enrolled
              schema:
                $ref: '#/components/schemas/ErrorResponse'
          description: Not Found
components:
  schemas:
    Perks_BrandDetailSchema:
      properties:
        description:
          anyOf:
            - type: string
            - type: 'null'
          description: >-
            Localised brand description, resolved from the `Accept-Language`
            header.
          example: Sportswear, footwear and equipment for every athlete.
          examples:
            - Sportswear, footwear and equipment for every athlete.
          title: Description
        id:
          example: 3fa85f64-5717-4562-b3fc-2c963f66afa6
          examples:
            - 3fa85f64-5717-4562-b3fc-2c963f66afa6
          format: uuid
          title: Id
          type: string
        legal_terms:
          anyOf:
            - type: string
            - type: 'null'
          description: Localised legal terms attached to the brand.
          example: Offer valid on the brand's online store only, excluding sale items.
          examples:
            - >-
              Offer valid on the brand's online store only, excluding sale
              items.
          title: Legal Terms
        logo:
          $ref: '#/components/schemas/Perks_LogoSchema'
        name:
          example: Nike
          examples:
            - Nike
          title: Name
          type: string
      required:
        - id
        - name
        - logo
      title: BrandDetailSchema
      type: object
    ErrorResponse:
      additionalProperties: false
      description: >-
        An error response object (PayLead profile).


        Extension members (e.g. ``errors`` for validation) are allowed and
        serialised as

        top-level keys.
      properties:
        code:
          description: Error code describing the issue
          example: PL-4XX-YY
          title: Code
          type: string
        errors:
          anyOf:
            - items:
                additionalProperties: true
                type: object
              type: array
            - type: 'null'
          default: null
          description: A list of individual error occurrences found
          example:
            - loc:
                - body
                - field
              msg: Field required
              type: missing
          title: Errors
        instance:
          anyOf:
            - type: string
            - type: 'null'
          default: null
          description: A URI reference to the problematic resource
          example: api/resource/424242
          title: Instance
        status:
          description: HTTP code returned by the API
          example: 400
          title: Status
          type: integer
        title:
          description: Description of the issue
          example: The request was invalid.
          title: Title
          type: string
      required:
        - code
        - title
        - status
      title: ErrorResponse
      type: object
    Perks_LogoSchema:
      properties:
        url:
          anyOf:
            - format: uri
              maxLength: 2083
              minLength: 1
              type: string
            - type: 'null'
          description: >-
            Absolute CDN URL of the image; null when there is none or no CDN is
            configured.
          example: https://static.sandbox.paylead.fr/123455.jpeg
          examples:
            - https://static.sandbox.paylead.fr/123455.jpeg
          title: Url
      title: LogoSchema
      type: object
  securitySchemes:
    oauth2:
      flows:
        clientCredentials:
          scopes:
            ALL: Full access to all resources (wildcard).
            LOYALTIES: Access to loyalties features.
            PERKS: Access to perks features.
            TX_INJECTION: Access to transaction sharing.
          tokenUrl: /tokens
      type: oauth2

````