Usuários

Com a API de usuários você pode gerenciar os usuários da sua empresa, incluindo cadastro, edição, desativação e restauração.

Listar Usuários

GET https://api.tinko.com.br/v1/users

Retorna uma lista paginada de todos os usuários da empresa.

Headers

Nome	Tipo	Obrigatório	Descrição
Authorization	string	Sim	Token de autenticação. Ex: Bearer seu_token

Query Parameters

Nome	Tipo	Obrigatório	Descrição
page	integer	Não	Número da página. Default: 1
per_page	integer	Não	Registros por página (máx: 100). Default: 20
search	string	Não	Buscar por nome
type	string	Não	Filtrar por tipo: admin, user. Default: todos
status	string	Não	Filtrar por status: active (ativos), inactive (desativados). Default: todos

Exemplo de requisição

curl -X GET "https://api.tinko.com.br/v1/users?type=user&status=active" \
  -H "Authorization: Bearer SEU_TOKEN"

Response

{
  "success": true,
  "data": [
    {
      "id": "01hxyz123abc456def789ghjkm",
      "name": "João Silva",
      "email": "joao.silva@exemplo.com.br",
      "type": "user",
      "signature": "João Silva",
      "signature_active": true,
      "avatar": null,
      "company_id": 1,
      "created_at": "2025-10-23T15:01:02.000000Z",
      "updated_at": "2025-10-23T15:01:02.000000Z",
      "deleted_at": null
    }
  ],
  "pagination": {
    "total": 50,
    "per_page": 20,
    "current_page": 1,
    "last_page": 3
  }
}

Visualizar Usuário

GET https://api.tinko.com.br/v1/users/{id}

Retorna os dados de um usuário específico.

Headers

Nome	Tipo	Obrigatório	Descrição
Authorization	string	Sim	Token de autenticação. Ex: Bearer seu_token

Path Parameters

Nome	Tipo	Obrigatório	Descrição
id	string	Sim	ID do usuário

Exemplo de requisição

curl -X GET "https://api.tinko.com.br/v1/users/01arz3ndektsv4rrffq69g5fav" \
  -H "Authorization: Bearer SEU_TOKEN"

Response

{
  "success": true,
  "data": {
    "id": "01arz3ndektsv4rrffq69g5fav",
    "name": "João Silva",
    "email": "joao.silva@exemplo.com.br",
    "type": "user",
    "signature": "João Silva",
    "avatar": "https://storage.exemplo.com/avatars/01arz3ndektsv4rrffq69g5fav.png",
    "channels": [
      {
        "id": "01arz3ndektsv4rrffq69g5fav",
        "name": "WhatsApp Vendas",
        "type": "whatsapp"
      }
    ],
    "created_at": "2025-06-24T14:19:02.000000Z",
    "updated_at": "2025-10-28T18:09:50.000000Z"
  }
}

Cadastrar Usuário

POST https://api.tinko.com.br/v1/users

Cria um novo usuário na empresa.

Headers

Nome	Tipo	Obrigatório	Descrição
Authorization	string	Sim	Token de autenticação. Ex: Bearer seu_token

Request Body

Nome	Tipo	Obrigatório	Descrição
name	string	Sim	Nome completo (máx: 50 caracteres, apenas letras e espaços)
email	string	Sim	E-mail (único por empresa)
password	string	Sim	Senha (mín: 8 caracteres)
type	string	Sim	Tipo: admin ou user
channels	array	Não	Lista de IDs dos canais que o usuário terá acesso

Usuários admin têm acesso a todos os canais. Usuários user têm acesso apenas aos canais informados em channels.

Exemplo de requisição

curl -X POST "https://api.tinko.com.br/v1/users" \
  -H "Authorization: Bearer SEU_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "name": "João Silva",
    "email": "joao.silva@exemplo.com.br",
    "password": "senha12345",
    "type": "user",
    "channels": ["01arz3ndektsv4rrffq69g5fav", "01hxyz123abc456def789ghjkm"]
  }'

Response

{
  "success": true,
  "message": "Usuário criado com sucesso.",
  "data": {
    "id": "01j7m8n9p0q1r2s3t4u5v6w7x",
    "name": "João Silva",
    "email": "joao.silva@exemplo.com.br",
    "type": "user",
    "signature": "João Silva",
    "avatar": null,
    "channels": [
      {
        "id": "01arz3ndektsv4rrffq69g5fav",
        "name": "WhatsApp Vendas",
        "type": "whatsapp"
      },
      {
        "id": "01hxyz123abc456def789ghjkm",
        "name": "WhatsApp Suporte",
        "type": "whatsapp_unofficial"
      }
    ],
    "created_at": "2025-10-30T16:56:52.000000Z",
    "updated_at": "2025-10-30T16:56:52.000000Z"
  }
}

Erros

Código	Descrição
EMAIL_ALREADY_EXISTS	E-mail já em uso por outro usuário da empresa
FIELD_REQUIRED	Campo obrigatório não informado

Exemplo:

{
  "success": false,
  "message": "Erro de validação",
  "errors": [
    {
      "code": "EMAIL_ALREADY_EXISTS",
      "field": "email",
      "message": "Este e-mail já está sendo usado por outro usuário da empresa."
    }
  ]
}

Editar Usuário

PUT https://api.tinko.com.br/v1/users/{id}

Atualiza os dados de um usuário. Envie apenas os campos que deseja atualizar.

Headers

Nome	Tipo	Obrigatório	Descrição
Authorization	string	Sim	Token de autenticação. Ex: Bearer seu_token

Path Parameters

Nome	Tipo	Obrigatório	Descrição
id	string	Sim	ID do usuário

Request Body

Nome	Tipo	Obrigatório	Descrição
name	string	Não	Nome completo
email	string	Não	E-mail
password	string	Não	Nova senha
type	string	Não	Tipo: admin ou user
channels	array	Não	IDs dos canais (substitui os anteriores)

Exemplo de requisição

curl -X PUT "https://api.tinko.com.br/v1/users/01j7m8n9p0q1r2s3t4u5v6w7x" \
  -H "Authorization: Bearer SEU_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "name": "João Silva",
    "type": "admin"
  }'

Response

{
  "success": true,
  "message": "Usuário atualizado com sucesso.",
  "data": {
    "id": "01j7m8n9p0q1r2s3t4u5v6w7x",
    "name": "João Silva",
    "email": "joao.silva@exemplo.com.br",
    "type": "admin",
    "signature": "João Silva",
    "avatar": null,
    "channels": [],
    "created_at": "2025-10-30T16:56:52.000000Z",
    "updated_at": "2025-10-30T17:30:00.000000Z"
  }
}

Desativar Usuário

DELETE https://api.tinko.com.br/v1/users/{id}

Desativa um usuário (soft delete). O usuário pode ser restaurado posteriormente.

Headers

Nome	Tipo	Obrigatório	Descrição
Authorization	string	Sim	Token de autenticação. Ex: Bearer seu_token

Path Parameters

Nome	Tipo	Obrigatório	Descrição
id	string	Sim	ID do usuário

Exemplo de requisição

curl -X DELETE "https://api.tinko.com.br/v1/users/01j7m8n9p0q1r2s3t4u5v6w7x" \
  -H "Authorization: Bearer SEU_TOKEN"

Response

{
  "success": true,
  "message": "Usuário desativado com sucesso."
}

Restaurar Usuário

POST https://api.tinko.com.br/v1/users/{id}/restore

Restaura um usuário previamente desativado.

Headers

Nome	Tipo	Obrigatório	Descrição
Authorization	string	Sim	Token de autenticação. Ex: Bearer seu_token

Path Parameters

Nome	Tipo	Obrigatório	Descrição
id	string	Sim	ID do usuário

Exemplo de requisição

curl -X POST "https://api.tinko.com.br/v1/users/01j7m8n9p0q1r2s3t4u5v6w7x/restore" \
  -H "Authorization: Bearer SEU_TOKEN"

Response

{
  "success": true,
  "message": "Usuário ativado com sucesso."
}

Campos do Response

Campo	Tipo	Descrição
id	string	ID do usuário
name	string	Nome completo
email	string	E-mail
type	string	Tipo: admin ou user
signature	string	Assinatura nas mensagens
signature_active	boolean	Se a assinatura está ativa
avatar	string/null	URL da imagem de perfil
channels	array	Canais vinculados
deleted_at	datetime/null	Data de desativação