front_ponto_eletronico/docs/contacts/list.yml
2025-03-17 15:00:51 -03:00

71 lines
1.8 KiB
YAML

Listar Contatos
---
tags:
- Contacts
summary: Lista todos os contatos com paginação
security:
- bearerAuth: []
parameters:
- in: query
name: page
schema:
type: integer
default: 1
description: Número da página
- in: query
name: per_page
schema:
type: integer
default: 10
description: Quantidade de itens por página
responses:
200:
description: Lista de contatos paginada
content:
application/json:
schema:
type: object
properties:
contacts:
type: array
items:
type: object
properties:
id:
type: integer
description: ID do contato
phone:
type: string
description: Telefone do contato
contact_type:
type: string
description: Tipo de contato
description:
type: string
description: Descrição ou nome do responsável
user_id:
type: integer
description: ID do usuário associado
page:
type: integer
description: Página atual
per_page:
type: integer
description: Quantidade de itens por página
total:
type: integer
description: Total de contatos
pages:
type: integer
description: Total de páginas
401:
description: Token inválido ou ausente
content:
application/json:
schema:
type: object
properties:
error:
type: string
example: "Token inválido ou ausente"