Referência completa da API para gerenciar projetos no Blue - criar, atualizar, excluir e consultar projetos
Visão Geral
Os projetos são a unidade organizacional central no Blue. Eles contêm listas, tarefas, campos personalizados, automações e todos os outros dados relacionados ao trabalho. Os projetos pertencem a empresas e têm seus próprios sistemas de permissões, modelos e configurações.
Operações Disponíveis
Operações Principais de Projetos
Operação | Descrição | Link |
---|---|---|
Create Project | Criar um novo projeto ou a partir de um modelo | View Details → |
List Projects | Consultar e filtrar projetos | View Details → |
Delete Project | Excluir permanentemente um projeto | View Details → |
Archive Project | Arquivar/desarquivar projetos | View Details → |
Rename Project | Atualizar nome e slug do projeto | View Details → |
Copy Project | Duplicar um projeto existente | View Details → |
Componentes do Projeto
Componente | Descrição | Link |
---|---|---|
Lists | Gerenciar listas de tarefas dentro dos projetos | View Details → |
Templates | Trabalhar com modelos de projeto | View Details → |
Activity | Rastrear a atividade e as mudanças do projeto | View Details → |
Conceitos Chave
Estrutura do Projeto
- Os projetos pertencem a empresas
- Cada projeto pode ter várias listas
- As listas contêm tarefas
- Os projetos suportam campos personalizados, tags e automações
Modelo de Permissões
Os projetos têm um sistema de permissões em múltiplos níveis:
Nível | Permissões |
---|---|
OWNER | Full control, can delete project |
ADMIN | Manage project settings, users, and content |
MEMBER | Create and edit content |
CLIENT | Limited edit access |
VIEW_ONLY | Read-only access |
COMMENT_ONLY | Can only comment |
Categorias de Projetos
Os projetos podem ser categorizados para melhor organização:
- CRM
- INTERFUNCIONAL
- SUCESSO_DO_CLIENTE
- DESIGN
- ENGENHARIA
- GERAL (padrão)
- RH
- TI
- MARKETING
- OPERAÇÕES
- PESSOAL
- AQUISIÇÃO
- PRODUTO
- VENDAS
Padrões Comuns
Criando um Projeto Básico
mutation CreateProject {
createProject(input: {
name: "Q1 Marketing Campaign"
companyId: "company-123"
category: MARKETING
}) {
id
name
slug
}
}
Consultando Projetos com Filtros
query GetProjects {
projectList(
filter: {
companyIds: ["company-123"]
isArchived: false
categories: [MARKETING, SALES]
}
sort: [{ field: updatedAt, direction: DESC }]
take: 20
) {
items {
id
name
category
todosCount
todosDoneCount
}
pageInfo {
hasNextPage
total
}
}
}
Nota: A consulta
projectList
é a abordagem recomendada para consultar projetos. Uma consulta legadaprojects
existe, mas não deve ser usada para novas implementações.
Gerenciando Listas de Projetos
# Get all lists in a project
query GetProjectLists {
todoLists(projectId: "project-123") {
id
title
position
todosCount
}
}
# Create a new list
mutation CreateList {
createTodoList(input: {
projectId: "project-123"
title: "To Do"
position: 1.0
}) {
id
title
}
}
Melhores Práticas
-
Nomeação de Projetos
- Use nomes claros e descritivos
- Evite caracteres especiais que possam afetar os slugs
- Mantenha os nomes com menos de 50 caracteres
-
Gerenciamento de Permissões
- Comece com permissões mínimas
- Use o papel CLIENTE para partes interessadas externas
- Audite regularmente o acesso ao projeto
-
Organização
- Use categorias para agrupar projetos semelhantes
- Arquive projetos concluídos em vez de excluir
- Use modelos para tipos de projetos repetitivos
-
Desempenho
- Use paginação para listas de projetos grandes
- Filtre por status ativo/arquivado
- Limite o número de listas por projeto (máx. 50)
Tratamento de Erros
Erros comuns que você pode encontrar:
Código de Erro | Descrição | Solução |
---|---|---|
PROJECT_NOT_FOUND |
O projeto não existe ou não há acesso | Verify project ID and permissions |
COMPANY_NOT_FOUND |
A empresa não existe | Check company ID |
FORBIDDEN |
Permissões insuficientes | Ensure proper role level |
BAD_USER_INPUT |
Erro de validação (por exemplo, nome muito longo) | Check input validation requirements |
Recursos Relacionados
- API de Registros - Gerenciando tarefas/registros dentro dos projetos
- API de Campos Personalizados - Adicionando campos personalizados aos projetos
- API de Automações - Configurando automações de projetos
- API de Usuários - Gerenciando usuários e permissões de projetos