> ## 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. # List brands with active offers in the program's catalog. ## OpenAPI ````yaml /program/api/openapi/2.0.0/perks/openapi.json get /perks/brands 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: - name: Brands x-displayName: Brands - description: Routes used to query consumers resources name: Consumers x-displayName: Consumers - name: UPM x-displayName: UPM - name: KYC x-displayName: KYC - name: Offers x-displayName: Offers - name: Rewards x-displayName: Rewards - name: Segments x-displayName: Segments - name: Universes x-displayName: Universes - name: Voucher Orders x-displayName: Voucher Orders paths: /perks/brands: get: tags: - Brands summary: List brands with active offers in the program's catalog. operationId: perks__brands__get parameters: - in: query name: page required: false schema: default: 1 minimum: 1 title: Page type: integer - in: query name: per_page required: false schema: default: 50 maximum: 1000 minimum: 1 title: Per Page type: integer - description: >- Sort field, prefixed by `-` for descending (e.g. `-max_highlight_level`). `max_highlight_level` orders on the brand's prominence, `max_rate` on the rate it headlines. A brand advertising no rate at all, listed only through a coupon offer, sorts last on `max_rate` either way. Omit to keep the catalog's brand-name order. in: query name: sort required: false schema: anyOf: - enum: - max_highlight_level - '-max_highlight_level' - max_rate - '-max_rate' example: max_highlight_level type: string - type: 'null' description: >- Sort field, prefixed by `-` for descending (e.g. `-max_highlight_level`). `max_highlight_level` orders on the brand's prominence, `max_rate` on the rate it headlines. A brand advertising no rate at all, listed only through a coupon offer, sorts last on `max_rate` either way. Omit to keep the catalog's brand-name order. example: '-max_highlight_level' examples: - '-max_highlight_level' title: Sort - description: Filter brands by name (case-insensitive partial match). in: query name: name required: false schema: anyOf: - type: string - type: 'null' description: Filter brands by name (case-insensitive partial match). example: nike examples: - nike title: Name - description: Filter brands by universe name (case-insensitive partial match). in: query name: universe__name required: false schema: anyOf: - type: string - type: 'null' description: Filter brands by universe name (case-insensitive partial match). example: fashion examples: - fashion title: Universe Name - description: >- Filter brands on `max_highlight_level`, returning exactly the brands reporting it. One of HIGHEST, HIGH or NORMAL — any other value matches no brand and returns an empty listing. in: query name: max_highlight_level required: false schema: anyOf: - type: string - type: 'null' description: >- Filter brands on `max_highlight_level`, returning exactly the brands reporting it. One of HIGHEST, HIGH or NORMAL — any other value matches no brand and returns an empty listing. example: HIGHEST examples: - HIGHEST title: Max Highlight Level - 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_Page_ProgramBrandSchema_' 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 components: schemas: Perks_Page_ProgramBrandSchema_: properties: items: items: $ref: '#/components/schemas/Perks_ProgramBrandSchema' title: Items type: array meta: $ref: '#/components/schemas/Perks_PageMeta' required: - items - meta title: Page[ProgramBrandSchema] 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_ProgramBrandSchema: properties: id: example: 3fa85f64-5717-4562-b3fc-2c963f66afa6 examples: - 3fa85f64-5717-4562-b3fc-2c963f66afa6 format: uuid title: Id type: string logo: $ref: '#/components/schemas/Perks_LogoSchema' max_highlight_level: $ref: '#/components/schemas/Perks_ProgramOfferHighlights' description: >- Highest display prominence among the brand's active cashback and voucher offers, for contextual surfaces such as a banner or a carousel. NORMAL when none of them carries one, and for a brand listed only through a coupon offer. example: HIGHEST examples: - HIGHEST max_rate: anyOf: - pattern: ^(?!^[-+.]*$)[+-]?0*\d*\.?\d*$ type: string - type: 'null' description: >- Highest rate among the brand's active offers, as a percentage (e.g. 5.00 for 5%): the cashback rate for cashback offers, the discount rate for vouchers. Null when no active offer of this brand carries a rate. example: '12.00' examples: - '12.00' title: Max Rate name: example: Nike examples: - Nike title: Name type: string universe: anyOf: - $ref: '#/components/schemas/Perks_UniverseSchema' - type: 'null' required: - id - name - max_highlight_level - logo title: ProgramBrandSchema type: object Perks_PageMeta: properties: page: example: 1 examples: - 1 title: Page type: integer per_page: example: 50 examples: - 50 title: Per Page type: integer total: example: 137 examples: - 137 title: Total type: integer required: - page - per_page - total title: PageMeta 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 Perks_ProgramOfferHighlights: description: >- How prominently an offer is displayed. Stored in the `program_offer_highlights` PG enum. enum: - HIGHEST - HIGH - NORMAL example: HIGHEST title: ProgramOfferHighlights type: string Perks_UniverseSchema: properties: id: example: 8f14e45f-ceea-467a-9e1b-2c8f9a0d1e23 examples: - 8f14e45f-ceea-467a-9e1b-2c8f9a0d1e23 format: uuid title: Id type: string name: example: Fashion examples: - Fashion title: Name type: string required: - id - name title: UniverseSchema 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 ````