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

# Listar segmentos

> Lista segmentos de clientes, ordenados por atualização mais recente.



## OpenAPI

````yaml /openapi.json get /v1/segments
openapi: 3.1.0
info:
  title: Bevits API
  version: 1.0.0
  description: >-
    API pública somente leitura para consultar dados de CRM, compras e automação
    de uma organização Bevits.
  license:
    name: Proprietary
    identifier: LicenseRef-Proprietary
servers:
  - url: https://api.bevits.com
    description: Produção
security:
  - bearerAuth: []
tags:
  - name: Sistema
    description: Disponibilidade da API.
  - name: Identidade
    description: Identidade da organização e da API key.
  - name: Clientes
    description: Clientes e suas relações.
  - name: Segmentos
    description: Segmentos de clientes.
  - name: Compras
    description: Compras importadas das integrações.
  - name: Dados do CRM
    description: Tags e definições de atributos.
  - name: Automações
    description: Flows de automação.
  - name: Campanhas
    description: Campanhas de e-mail.
paths:
  /v1/segments:
    get:
      tags:
        - Segmentos
      summary: Listar segmentos
      description: Lista segmentos de clientes, ordenados por atualização mais recente.
      operationId: listSegments
      parameters:
        - $ref: '#/components/parameters/Limit'
        - $ref: '#/components/parameters/SegmentCursor'
        - $ref: '#/components/parameters/Search'
        - $ref: '#/components/parameters/UpdatedSort'
      responses:
        '200':
          $ref: '#/components/responses/SegmentPage'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '422':
          $ref: '#/components/responses/ValidationError'
        '429':
          $ref: '#/components/responses/RateLimited'
        '500':
          $ref: '#/components/responses/InternalError'
components:
  parameters:
    Limit:
      name: limit
      in: query
      description: Quantidade máxima de itens por página.
      schema:
        type: integer
        minimum: 1
        maximum: 100
        default: 25
    SegmentCursor:
      name: starting_after
      in: query
      description: ID do último segmento da página anterior.
      schema:
        type: string
        pattern: ^seg_[A-Za-z0-9_-]+$
    Search:
      name: q
      in: query
      description: Texto de busca, com até 256 caracteres.
      schema:
        type: string
        minLength: 1
        maxLength: 256
    UpdatedSort:
      name: sort
      in: query
      description: Ordenação de discovery por atualização mais recente.
      schema:
        type: string
        enum:
          - updated
        default: updated
  responses:
    SegmentPage:
      description: Página de segmentos.
      headers:
        ETag:
          $ref: '#/components/headers/ETag'
        X-Request-Id:
          $ref: '#/components/headers/RequestId'
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/SegmentPage'
    Unauthorized:
      description: API key ausente, inválida, expirada ou revogada.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorResponse'
          example:
            error:
              type: authentication_error
              message: Invalid API key.
              request_id: req_07f6cdc3c20249d6afcd90b4
    ValidationError:
      description: Um parâmetro não passou pela validação.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorResponse'
          example:
            error:
              type: validation_error
              message: Invalid query parameters.
              param: limit
              request_id: req_07f6cdc3c20249d6afcd90b4
    RateLimited:
      description: Limite de requisições excedido.
      headers:
        Retry-After:
          $ref: '#/components/headers/RetryAfter'
        X-RateLimit-Limit:
          $ref: '#/components/headers/RateLimitLimit'
        X-RateLimit-Remaining:
          $ref: '#/components/headers/RateLimitRemaining'
        X-RateLimit-Reset:
          $ref: '#/components/headers/RateLimitReset'
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/RateLimitErrorResponse'
    InternalError:
      description: Erro inesperado no servidor.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorResponse'
  headers:
    ETag:
      description: Identificador da versão do conteúdo para cache condicional.
      schema:
        type: string
        example: '"v1-4ad31f5efb6b8f35"'
    RequestId:
      description: Identificador da requisição para suporte e rastreamento.
      schema:
        type: string
        pattern: ^req_[a-f0-9]{24}$
    RetryAfter:
      description: Segundos até uma nova tentativa.
      schema:
        type: integer
        minimum: 1
    RateLimitLimit:
      description: Limite total da janela atual.
      schema:
        type: integer
        example: 600
    RateLimitRemaining:
      description: Requisições restantes na janela atual.
      schema:
        type: integer
        example: 599
    RateLimitReset:
      description: Instante UTC em que a janela atual termina.
      schema:
        type: string
        format: date-time
  schemas:
    SegmentPage:
      allOf:
        - $ref: '#/components/schemas/Page'
        - type: object
          required:
            - data
          properties:
            data:
              type: array
              items:
                $ref: '#/components/schemas/Segment'
    ErrorResponse:
      type: object
      required:
        - error
      properties:
        error:
          $ref: '#/components/schemas/Error'
    RateLimitErrorResponse:
      allOf:
        - $ref: '#/components/schemas/ErrorResponse'
        - type: object
          required:
            - retry_after
          properties:
            retry_after:
              type: integer
              minimum: 1
              description: Segundos até uma nova tentativa.
    Page:
      type: object
      required:
        - data
        - has_more
      properties:
        has_more:
          type: boolean
          description: Indica se existe uma próxima página.
    Segment:
      type: object
      required:
        - object
        - id
        - created_at
        - updated_at
        - html_url
      properties:
        object:
          type: string
          const: segment
        id:
          type: string
          pattern: ^seg_[A-Za-z0-9_-]+$
        name:
          type: string
        description:
          type: string
        customer_count:
          type: integer
          minimum: 0
        created_at:
          type: string
          format: date-time
        updated_at:
          type: string
          format: date-time
        html_url:
          type: string
          format: uri
    Error:
      type: object
      required:
        - type
        - message
        - request_id
      properties:
        type:
          type: string
          enum:
            - authentication_error
            - conflict
            - internal_error
            - invalid_request
            - not_found
            - permission_denied
            - rate_limited
            - validation_error
        message:
          type: string
        param:
          type: string
        request_id:
          type: string
          pattern: ^req_[a-f0-9]{24}$
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      bearerFormat: bvt_live_...
      description: API key criada nas configurações da organização.

````