> ## 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 Preference All Categories

> API to get tenant preferences for all categories with translated names and descriptions.



## OpenAPI

````yaml GET /v1/tenant/{tenant_id}/preference/category/
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/category/:
    get:
      summary: Get Tenant Preference All Categories
      description: >-
        API to get tenant preferences for all categories with translated names
        and descriptions.
      operationId: get-tenant-preference-all-categories
      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
        - name: limit
          in: query
          description: Number of results to return per page
          schema:
            type: integer
            default: 10
        - name: offset
          in: query
          description: Number of results to skip
          schema:
            type: integer
            default: 0
      responses:
        '200':
          description: '200'
          content:
            application/json:
              examples:
                Result:
                  value:
                    meta:
                      count: 29
                      limit: 10
                      offset: 0
                    results:
                      - name: sreehari_test
                        category: sreehari_test
                        description: null
                        tags: null
                        effective_tags:
                          - wwr
                        root_category: system
                        default_preference: cant_unsubscribe
                        default_mandatory_channels:
                          - email
                        default_opt_in_channels:
                          - slack
                        enabled_for_tenant: true
                        visible_to_subscriber: true
                        preference: null
                        mandatory_channels: null
                        opt_in_channels: null
                        blocked_channels: null
                        updated_at: null
              schema:
                type: object
                properties:
                  meta:
                    type: object
                    properties:
                      count:
                        type: integer
                      limit:
                        type: integer
                      offset:
                        type: integer
                  results:
                    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
                        root_category:
                          type: string
                          enum:
                            - system
                            - transactional
                            - promotional
                        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.

````