> ## Documentation Index > Fetch the complete documentation index at: https://docs.flexxible.com/llms.txt > Use this file to discover all available pages before exploring further. # Listar sessões > Retorna uma lista paginada de sessões da organização. ## OpenAPI ````yaml /pt-BR/api-reference/openapi.pt-v1.json get /v1/organizations/{organization_id}/sessions openapi: 3.0.3 info: title: API Publica Portal version: 1.0.0 description: API pública REST para portal servers: - url: https://api.flexxible.net description: Portal API (production) security: - bearerAuth: [] tags: [] paths: /v1/organizations/{organization_id}/sessions: get: tags: - Sessões summary: Listar sessões description: Retorna uma lista paginada de sessões da organização. operationId: get_sessions parameters: - name: organization_id in: path required: true schema: type: string pattern: ^[0-9a-f]{24}$ minLength: 24 maxLength: 24 description: Identificador da organização. example: 507f1f77bcf86cd799439011 - name: page in: query required: false schema: type: integer default: 1 minimum: 1 description: Número da página. - name: per_page in: query required: false schema: type: integer default: 100 maximum: 100 minimum: 1 description: Número de elementos por página. - name: fields in: query required: false schema: type: string maxLength: 2048 description: Nomes de campos de elementos de resposta separados por vírgulas. - name: filters in: query required: false schema: type: string maxLength: 5120 description: >- Expressão de filtro JSON sobre rotas de campos de resposta filtráveis. examples: simple: summary: Filtrar por nome de usuário value: '{"field":"user_name","op":"contains","value":"jdoe"}' complex-and: summary: Filtrar por estado e estado de conexão value: >- {"and":[{"field":"session_status","op":"eq","value":"active"},{"field":"connection_state","op":"eq","value":"active"}]} complex-or-and: summary: Combinar condições OU e E value: >- {"and":[{"or":[{"field":"connection_state","op":"eq","value":"active"},{"field":"connection_state","op":"eq","value":"disconnected"}]},{"field":"current_dc_name","op":"contains","value":"dc-eu"}]} - name: sort in: query required: false schema: type: string pattern: ^([a-z_]+):(asc|desc)$ description: >- Expressão de ordenação no formato :asc|desc. No modo agregado, só aceita campos de `group_by` ou aliases agregados (`count`, `_`). - name: aggregate in: query required: false schema: type: string maxLength: 1024 description: >- Expressão JSON para agregação. Estrutura: {"group_by":["field"],"aggregates":[{"field":"*","function":"count"}]}. Não pode ser combinado com `fields`. examples: group-by-connection-state-count: summary: Agrupar por estado de conexão e contar value: >- {"group_by":["connection_state"],"aggregates":[{"field":"*","function":"count"}]} group-by-platform-avg-cpu: summary: Agrupar por plataforma e calcular média value: >- {"group_by":["platform_type"],"aggregates":[{"field":"*","function":"count"},{"field":"cpu_usage","function":"avg"}]} responses: '200': description: Sessões recuperadas corretamente. content: application/json: schema: $ref: '#/components/schemas/GetSessionsResponseV1' examples: paginated_result: summary: Lista paginada com sessões value: has_next: true data: - id: 550E8400-E29B-41D4-A716-446655440000 user_name: contoso\jdoe session_type: vdi_desktop windows_session_id: 7 connection_state: active start_date: '2026-03-15T08:30:00Z' cpu_usage: 34.2 ram_usage_gb: 3.8 rtt_usage: 18.1 session_status: active platform_type: windows connected: true current_session_id: 41 current_dc_name: dc-eu-01 current_uid_usage: 2.4 flexx_analyzer_executed: false last_connection_time: '2026-03-15T09:45:11Z' log_on_duration: 35 number_alerts_user: 0 number_alerts_vm: 1 ram_usage: 3891 ram_percentage: 47 session_key: 6BA7B810-9DAD-11D1-80B4-00C04FD430C8 workspace_id: 64f0c2a1b2d3e4f5060708aa organization_id: 507f1f77bcf86cd799439011 empty_result: summary: Nenhuma sessão encontrada value: has_next: false data: [] aggregated_by_connection_state: summary: Resultado agregado por estado de conexão value: has_next: false data: - connection_state: active count: 120 avg_cpu_usage: 17.4 - connection_state: disconnected count: 45 avg_cpu_usage: 3.1 '400': description: Parâmetros de solicitação inválidos. content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' examples: invalid_filters: summary: Formato de filtros inválido value: error: message: Formato de filtros inválido code: bad_request details: filters debe ser una cadena JSON válida '401': description: Não autorizado ou a organização não é acessível. content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' examples: organization_not_authorized: summary: Falha de acesso à organização value: error: message: No autorizado code: unauthorized '404': description: >- Recurso solicitado não encontrado dentro do escopo autorizado da organização. content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' examples: resource_not_found: summary: Não se encontrou o recurso solicitado value: error: message: No encontrado code: not_found '500': description: Erro interno do servidor. content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' examples: unexpected_error: summary: Falha não controlada value: error: message: Error interno del servidor code: internal_error components: schemas: GetSessionsResponseV1: type: object properties: has_next: type: boolean description: Se outra página está disponível. data: type: array items: $ref: '#/components/schemas/GetSessionItemV1' required: - has_next - data ErrorResponse: type: object properties: error: type: object properties: message: type: string code: type: string details: type: string required: - message - code required: - error GetSessionItemV1: type: object properties: id: type: string format: uuid pattern: ^[0-9A-F]{8}-[0-9A-F]{4}-[0-9A-F]{4}-[0-9A-F]{4}-[0-9A-F]{12}$ minLength: 36 maxLength: 36 description: Identificador da sessão. user_name: type: string description: Conta de usuário da sessão. session_type: type: string enum: - vdi_desktop - application - sdi_desktop - device description: Tipo de sessão. windows_session_id: type: integer description: Identificador de sessão do Windows. connection_state: type: string enum: - unknown - connected - disconnected - terminated - preparing_session - active - reconnecting - non_broker_session - other - pending description: Estado de conexão da sessão. start_date: type: string description: Marca de tempo de início da sessão. cpu_usage: type: number nullable: true description: Uso atual de CPU. ram_usage_gb: type: number nullable: true description: Uso atual de RAM em gigabytes. rtt_usage: type: number nullable: true description: Uso atual de RTT. session_status: type: string description: Estado da sessão. platform_type: type: string enum: - windows - mac - linux - android - chrome_os - unknown description: Tipo de plataforma. connected: type: boolean description: Indicador de conexão atual. current_session_id: type: integer description: Identificador de sessão de conexão atual. current_dc_name: type: string description: Nome atual do data center. current_uid_usage: type: number nullable: true description: Uso atual de UID. flexx_analyzer_executed: type: boolean description: Se a execução do analisador foi finalizada. last_connection_time: type: string description: String de marca de tempo da última conexão. log_on_duration: type: number description: Duração do início da sessão. number_alerts_user: type: number nullable: true description: Número de alertas de usuário. number_alerts_vm: type: number nullable: true description: Número de alertas de Workspace. ram_usage: type: number nullable: true description: Uso atual de RAM. ram_percentage: type: number nullable: true description: Porcentagem atual de uso de RAM. session_key: type: string format: uuid pattern: ^[0-9A-F]{8}-[0-9A-F]{4}-[0-9A-F]{4}-[0-9A-F]{4}-[0-9A-F]{12}$ minLength: 36 maxLength: 36 description: Chave de sessão. workspace_id: type: string pattern: ^[0-9a-f]{24}$ minLength: 24 maxLength: 24 description: >- Identificador MongoDB (_id) do Workspace associado com a sessão, resolvido a partir da relação de sessão. organization_id: type: string pattern: ^[0-9a-f]{24}$ minLength: 24 maxLength: 24 description: Identificador da organização associado com a sessão. required: - id - user_name - session_type - windows_session_id - connection_state - start_date - cpu_usage - ram_usage_gb - rtt_usage - session_status - platform_type - connected - current_session_id - current_dc_name - current_uid_usage - flexx_analyzer_executed - last_connection_time - log_on_duration - number_alerts_user - number_alerts_vm - ram_usage - ram_percentage - session_key - workspace_id - organization_id securitySchemes: bearerAuth: type: http scheme: bearer bearerFormat: JWT ````