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

# Lire un segment



## OpenAPI

````yaml /api-reference/openapi.fr.json get /api/v1/segments/{segment}
openapi: 3.1.0
info:
  title: API Lekalao
  version: 1.0.0
  description: >-
    Tout ce que fait l'interface, votre application peut le faire aussi. Chaque
    appel porte un jeton d'API (Paramètres → Jetons d'API).
servers:
  - url: https://{host}
    description: Votre installation
    variables:
      host:
        default: lekalao.example.com
        description: Le domaine de votre Lekalao
security:
  - bearer: []
tags:
  - name: Listes
  - name: Abonnés
  - name: Tags
  - name: Segments
  - name: Imports
  - name: Modèles
  - name: Campagnes
  - name: Automatisations
  - name: E-mails transactionnels
  - name: Revenu
  - name: Plateforme
paths:
  /api/v1/segments/{segment}:
    get:
      tags:
        - Segments
      summary: Lire un segment
      operationId: api.segments.show
      parameters:
        - name: segment
          in: path
          required: true
          schema:
            type: string
            format: uuid
          description: L'identifiant (uuid) du segment.
      responses:
        '200':
          description: Le segment, avec son nombre d'abonnés.
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    $ref: '#/components/schemas/Segment'
        '401':
          $ref: '#/components/responses/Unauthenticated'
        '403':
          $ref: '#/components/responses/Forbidden'
        '404':
          $ref: '#/components/responses/NotFound'
        '429':
          $ref: '#/components/responses/TooManyRequests'
components:
  schemas:
    Segment:
      type: object
      properties:
        id:
          type: string
          format: uuid
        name:
          type: string
          example: Clients VIP actifs
        list:
          type: string
          format: uuid
        conditions:
          $ref: '#/components/schemas/SegmentConditions'
        subscribers_count:
          type: integer
          description: 'Absent des listes paginées : le calcul a un coût.'
        created_at:
          type: string
          format: date-time
        updated_at:
          type: string
          format: date-time
    SegmentConditions:
      type: object
      required:
        - operator
        - rules
      description: >-
        Un groupe de règles ; un groupe peut en contenir un autre, sur deux
        niveaux au plus, 50 règles au plus.
      properties:
        operator:
          type: string
          enum:
            - and
            - or
        rules:
          type: array
          items:
            oneOf:
              - $ref: '#/components/schemas/SegmentRule'
              - type: object
                properties:
                  operator:
                    type: string
                    enum:
                      - and
                      - or
                  rules:
                    type: array
                    items:
                      $ref: '#/components/schemas/SegmentRule'
      example:
        operator: and
        rules:
          - type: tags
            operator: has_any
            value:
              - vip
          - type: engagement
            operator: active_within_days
            value: 60
    Message:
      type: object
      properties:
        message:
          type: string
    SegmentRule:
      type: object
      required:
        - type
        - operator
      properties:
        type:
          type: string
          enum:
            - email
            - first_name
            - last_name
            - tags
            - language
            - attribute
            - subscribed_at
            - campaign
            - automation_mail
            - link
            - engagement
            - list
          description: Le genre de condition. Voir le guide « Conditions de segment ».
        operator:
          type: string
          description: Dépend du type. Voir Développeurs → Segments.
        value:
          description: >-
            Selon le type : texte, nombre de jours, date AAAA-MM-JJ, code de
            langue ; noms ou uuids de tags pour « tags » ; uuid de la campagne,
            de l'e-mail d'automatisation, du lien ou de la liste pour « campaign
            », « automation_mail », « link » et « list ».
        key:
          type: string
          description: Nom de l'attribut, pour le type « attribute ».
  responses:
    Unauthenticated:
      description: Aucun jeton, ou un jeton invalide ou révoqué.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Message'
          example:
            message: Unauthenticated.
    Forbidden:
      description: Le jeton n'a pas l'aptitude requise, ou l'équipe est suspendue.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Message'
    NotFound:
      description: Aucune ressource de ce uuid dans l'équipe du jeton.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Message'
    TooManyRequests:
      description: >-
        Limite du jeton atteinte. Attendez le nombre de secondes indiqué par
        Retry-After.
      headers:
        X-RateLimit-Limit:
          schema:
            type: integer
          description: Appels permis par minute pour ce jeton.
        X-RateLimit-Remaining:
          schema:
            type: integer
        Retry-After:
          schema:
            type: integer
  securitySchemes:
    bearer:
      type: http
      scheme: bearer
      description: >-
        Jeton d'API. Aptitude « read » : routes GET seulement. « read + write »
        : toutes les routes.

````