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

# List cohorts

> Lists the cohorts defined under your tenant, paged with `page` and `limit`. The response `data` carries `items` alongside `total_count`, `page`, `limit`, `total_pages` and `has_next_page`.



## OpenAPI

````yaml /openapi/kintra-app.json get /tenant/{tenantId}/cohorts
openapi: 3.0.0
info:
  description: >-
    Tenant portal API for the Kintra loyalty platform. Requests are
    authenticated with an Auth0 bearer token and address a tenant by id in the
    path.
  title: Kintra Portal API
  version: 1.0.0
servers:
  - description: Production environment
    url: https://api.kintra.io/api/v1
security: []
paths:
  /tenant/{tenantId}/cohorts:
    get:
      tags:
        - Cohorts
      summary: List cohorts
      description: >-
        Lists the cohorts defined under your tenant, paged with `page` and
        `limit`. The response `data` carries `items` alongside `total_count`,
        `page`, `limit`, `total_pages` and `has_next_page`.
      operationId: ListCohorts
      parameters:
        - in: path
          name: tenantId
          required: true
          schema:
            type: string
        - in: query
          name: page
          required: false
          schema:
            default: 1
            format: double
            type: number
        - in: query
          name: limit
          required: false
          schema:
            default: 20
            format: double
            type: number
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: >-
                  #/components/schemas/ApiResponse_IPaginationResponse_CohortResponse__
          description: ''
        '401':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiResponse_null_'
          description: Unauthorized
        '403':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiResponse_null_'
          description: Feature disabled or insufficient permissions
        '404':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiResponse_null_'
          description: Tenant not found
        '500':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiResponse_null_'
          description: Internal server error
      security:
        - auth0_jwt: []
components:
  schemas:
    ApiResponse_IPaginationResponse_CohortResponse__:
      additionalProperties: false
      properties:
        data:
          $ref: '#/components/schemas/IPaginationResponse_CohortResponse_'
        errors:
          items:
            properties:
              message:
                type: string
              path:
                type: string
            required:
              - path
              - message
            type: object
          type: array
        message:
          type: string
        success:
          type: boolean
      required:
        - success
      type: object
    ApiResponse_null_:
      additionalProperties: false
      properties:
        data:
          enum:
            - null
          nullable: true
          type: number
        errors:
          items:
            properties:
              message:
                type: string
              path:
                type: string
            required:
              - path
              - message
            type: object
          type: array
        message:
          type: string
        success:
          type: boolean
      required:
        - success
      type: object
    IPaginationResponse_CohortResponse_:
      additionalProperties: false
      properties:
        has_next_page:
          type: boolean
        items:
          items:
            $ref: '#/components/schemas/CohortResponse'
          type: array
        limit:
          format: double
          type: number
        page:
          format: double
          type: number
        total_count:
          format: double
          type: number
        total_pages:
          format: double
          type: number
      required:
        - total_count
        - page
        - limit
        - has_next_page
        - total_pages
        - items
      type: object
    CohortResponse:
      additionalProperties: false
      properties:
        created_at:
          type: string
        created_by:
          nullable: true
          type: string
        dead_keys:
          items:
            type: string
          type: array
        description:
          nullable: true
          type: string
        id:
          type: string
        member_count:
          format: double
          type: number
        name:
          type: string
        rules:
          $ref: '#/components/schemas/CohortRuleDocumentDto'
        updated_at:
          type: string
      required:
        - id
        - name
        - description
        - rules
        - member_count
        - dead_keys
        - created_by
        - created_at
        - updated_at
      type: object
    CohortRuleDocumentDto:
      additionalProperties: false
      description: >-
        TSOA-friendly rule document DTO. Cast to CohortRuleDocument at service
        boundary.
      properties:
        operator:
          enum:
            - and
          nullable: false
          type: string
        predicates:
          items:
            $ref: '#/components/schemas/AttributePredicateDto'
          type: array
        version:
          enum:
            - 1
          nullable: false
          type: number
      required:
        - version
        - operator
        - predicates
      type: object
    AttributePredicateDto:
      additionalProperties: false
      description: >-
        TSOA-friendly predicate DTO (no tuple types — TSOA rejects TypeScript
        tuples).
      properties:
        key:
          type: string
        op:
          type: string
        type:
          enum:
            - attribute
          nullable: false
          type: string
        value:
          anyOf:
            - type: string
            - format: double
              type: number
            - items:
                anyOf:
                  - type: string
                  - format: double
                    type: number
              type: array
      required:
        - type
        - key
        - op
        - value
      type: object
  securitySchemes:
    auth0_jwt:
      bearerFormat: JWT
      description: Auth0 access token
      scheme: bearer
      type: http

````