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

# Conta colaboradores agrupados por status

> Retorna **agregação rápida** do quadro de funcionários por status, sem precisar paginar a lista completa. Ideal para dashboards e KPIs de RH.

**O que retorna:** objeto com totais por status — `ATIVO`, `INATIVO`, `AFASTADO`, `DEMITIDO` — além do total geral. Os totais respeitam os mesmos filtros aceitos por `GET /colaborador` (departamento, cargo, equipe, etc.).

**Casos de uso:**
- Card "Colaboradores ativos" no dashboard interno
- Alerta "X afastados há mais de 30 dias" (combinar com filtro de período)
- Snapshot mensal para auditoria

**Performance:** muito mais leve que `GET /colaborador` em UNs grandes (10k+ colaboradores) — use sempre que precisar só dos totais.



## OpenAPI

````yaml https://api.pre.pontua.tech/api/public/doc-json get /colaborador/status-count
openapi: 3.0.0
info:
  title: Pontua Public API
  description: >-
    API oficial da Pontua para integrações de clientes externos. Autentique com
    o token gerado no dashboard em **Configurações → API**. Envie o token no
    header `Authorization: Bearer <SEU_TOKEN>`.
  version: '1.0'
  contact: {}
servers: []
security: []
tags: []
paths:
  /colaborador/status-count:
    get:
      tags:
        - Colaborador
      summary: Conta colaboradores agrupados por status
      description: >-
        Retorna **agregação rápida** do quadro de funcionários por status, sem
        precisar paginar a lista completa. Ideal para dashboards e KPIs de RH.


        **O que retorna:** objeto com totais por status — `ATIVO`, `INATIVO`,
        `AFASTADO`, `DEMITIDO` — além do total geral. Os totais respeitam os
        mesmos filtros aceitos por `GET /colaborador` (departamento, cargo,
        equipe, etc.).


        **Casos de uso:**

        - Card "Colaboradores ativos" no dashboard interno

        - Alerta "X afastados há mais de 30 dias" (combinar com filtro de
        período)

        - Snapshot mensal para auditoria


        **Performance:** muito mais leve que `GET /colaborador` em UNs grandes
        (10k+ colaboradores) — use sempre que precisar só dos totais.
      operationId: ColaboradorController_countByStatus
      parameters:
        - name: collaboratorTypes
          required: false
          in: query
          description: Filtro por tipos de cadastro de colaborador, separados por vírgula
          schema:
            example: PRESTADOR_SERVICO,CLT,EXTERNO,API
            type: string
      responses:
        '200':
          description: Totais agregados por status (objeto plano com counts)
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CountCollaboratorsByStatusDto'
        default:
          description: "\n\t\t\t400 - Bad Request: A solicitação não está no formato correto.\n\t\t\t401 - Unauthorized: A solicitação não foi autorizada. Verifique se o token de acesso é válido.\n\t\t\t403 - Forbidden: Acesso proibido! Requer um nível de permissão mais elevado.\n\t\t\t404 - Not Found: O recurso solicitado não foi encontrado.\n\t\t\t500 - Internal Server Error: Erro de execução no servidor!\n\t\t\t"
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorDto'
      deprecated: false
      security:
        - bearer: []
        - cookie: []
components:
  schemas:
    CountCollaboratorsByStatusDto:
      type: object
      properties:
        total:
          type: number
          description: Total de colaboradores
          example: 10
        active:
          type: number
          description: Número de colaboradores ativos
          example: 7
        inactive:
          type: number
          description: Número de colaboradores inativos
          example: 2
        draft:
          type: number
          description: Número de colaboradores em rascunho
          example: 1
      required:
        - total
        - active
        - inactive
        - draft
    ErrorDto:
      type: object
      properties:
        service:
          type: string
          description: Rota solicitada
        method:
          type: string
          description: Método http
        message:
          description: Mensagem do erro
          oneOf:
            - type: string
              example: message erro
            - type: array
              items:
                type: string
                example:
                  - erro 1
                  - erro 2
      required:
        - service
        - method
        - message

````