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

# Get Tenant Full Preference

> API to fetch tenant preferences across all categories with translated names and descriptions.



## OpenAPI

````yaml GET /v1/tenant/{tenant_id}/preference/
openapi: 3.1.1
info:
  title: SuprSend API
  description: APIs supported on suprsend platform
  version: 1.2.2
servers:
  - url: https://hub.suprsend.com
security:
  - sec0: []
  - BearerAuth: []
paths:
  /v1/tenant/{tenant_id}/preference/:
    get:
      summary: Get Tenant Full Preference
      description: >-
        API to fetch tenant preferences across all categories with translated
        names and descriptions.
      operationId: get-tenant-full-preference
      parameters:
        - name: tenant_id
          in: path
          description: unique identifier of the tenant you want to get preferences for
          schema:
            type: string
          required: true
        - name: locale
          in: query
          description: >
            Locale code (e.g., `es`, `fr`, `de`, `ja`, `es-AR`) to fetch
            preference translations in user's locale. When provided, the API
            looks for category and section names and descriptions in the
            respective locale file. 

            If a translation is missing for the requested locale, the system
            automatically falls back in this order: `locale-region` (e.g.,
            `es-AR`) → `locale` (e.g., `es`) → `en` (English - always
            available).
          schema:
            type: string
          example: es
      responses:
        '200':
          description: '200'
          content:
            application/json:
              examples:
                Result:
                  value:
                    root_categories:
                      - root_category: system
                        sections:
                          - name: section système
                            slug: system-section
                            description: section système
                            tags:
                              - wwr
                            categories:
                              - name: Sous-catégorie
                                category: sub-category
                                description: Description de la sous-catégorie
                                tags:
                                  - gjhgjhfjfjgfdjthdhtdhdhdyrhdyrdyrdrh
                                  - aaaaeeee
                                effective_tags:
                                  - aaaaeeee
                                  - gjhgjhfjfjgfdjthdhtdhdhdyrhdyrdyrdrh
                                  - wwr
                                default_preference: cant_unsubscribe
                                default_mandatory_channels:
                                  - email
                                default_opt_in_channels:
                                  - inbox
                                enabled_for_tenant: true
                                visible_to_subscriber: true
                                preference: opt_in
                                mandatory_channels: null
                                opt_in_channels: null
                                blocked_channels:
                                  - sms
                                updated_at: '2025-12-04T10:45:39.061095+00:00'
              schema:
                type: object
                properties:
                  root_categories:
                    type: array
                    items:
                      type: object
                      properties:
                        root_category:
                          type: string
                          enum:
                            - system
                            - transactional
                            - promotional
                        sections:
                          type: array
                          items:
                            type: object
                            properties:
                              name:
                                type: string
                                nullable: true
                              slug:
                                type: string
                                nullable: true
                              description:
                                type: string
                                nullable: true
                              tags:
                                type: array
                                nullable: true
                                items:
                                  type: string
                              categories:
                                type: array
                                items:
                                  type: object
                                  properties:
                                    name:
                                      type: string
                                    category:
                                      type: string
                                    description:
                                      type: string
                                      nullable: true
                                    tags:
                                      type: array
                                      nullable: true
                                      items:
                                        type: string
                                    effective_tags:
                                      type: array
                                      nullable: true
                                      items:
                                        type: string
                                    default_preference:
                                      type: string
                                      enum:
                                        - opt_in
                                        - opt_out
                                        - cant_unsubscribe
                                    default_mandatory_channels:
                                      type: array
                                      nullable: true
                                      items:
                                        type: string
                                    default_opt_in_channels:
                                      type: array
                                      nullable: true
                                      items:
                                        type: string
                                    enabled_for_tenant:
                                      type: boolean
                                    visible_to_subscriber:
                                      type: boolean
                                    preference:
                                      type: string
                                      nullable: true
                                      enum:
                                        - opt_in
                                        - opt_out
                                        - cant_unsubscribe
                                    mandatory_channels:
                                      type: array
                                      nullable: true
                                      items:
                                        type: string
                                    opt_in_channels:
                                      type: array
                                      nullable: true
                                      items:
                                        type: string
                                    blocked_channels:
                                      type: array
                                      nullable: true
                                      items:
                                        type: string
                                    updated_at:
                                      type: string
                                      format: date-time
                                      nullable: true
        '404':
          description: '404'
          content:
            application/json:
              examples:
                Result:
                  value:
                    code: 404
                    message: tenant 'tenant_id' not found
              schema:
                type: object
                properties:
                  code:
                    type: integer
                    example: 404
                  message:
                    type: string
                    example: tenant 'tenant_id' not found
      deprecated: false
      security:
        - BearerAuth: []
components:
  securitySchemes:
    sec0:
      type: apiKey
      in: header
      name: Authorization
      x-bearer-format: bearer
      description: >-
        Bearer authentication header of the form `Bearer <token>`, where <token>
        is your auth token.
    BearerAuth:
      type: http
      scheme: bearer
      bearerFormat: API_Key
      description: >-
        Pass as `Bearer <API_KEY>`. Get API Key from SuprSend dashboard
        Developers -> API Keys section.

````