Desenvolvedores

Construa com o Planitude

Uma API REST, webhooks assinados e um servidor MCP: mantenha seus sistemas alinhados ao plano, reaja a cada mudança e deixe um assistente de IA trabalhar nos seus projetos.

Código, nomes de campos e a referência técnica estão em inglês, como na maioria das documentações de API.

URL base: https://planitude.app

Requisições e respostas são JSON sobre HTTPS. Durações e atrasos estão em minutos úteis (um dia de 8 horas vale 480), instantes em ISO 8601 UTC, datas sem hora em YYYY-MM-DD.

Requisição
curl https://planitude.app/api/auth/me \
  -H "Authorization: Bearer $PLANITUDE_API_KEY"
Resposta200 OK
{
  "user": {
    "id": "b1666432-132a-4ea9-b1ae-76ea69e226c5",
    "email": "anna@example.com",
    "name": "Anna Rossi",
    "avatarUrl": null,
    "locale": "en",
    "emailVerified": true
  }
}

Início rápido

Do zero ao primeiro webhook em três passos. Basta um terminal.

  1. Crie uma chave API

    Abra Perfil → Chaves API, escolha Leitura e escrita e copie a chave: ela começa com pln_ e é mostrada uma única vez. Salve-a em uma variável de ambiente.

  2. Faça a primeira chamada

    Liste os projetos que você vê. A chave age como você: os mesmos projetos, os mesmos papéis.

  3. Receba um webhook

    Inscreva um endpoint HTTPS público nos eventos de que precisa, envie logo um evento de teste e verifique a assinatura.

1Terminal
export PLANITUDE_API_KEY="pln_…"
2
curl https://planitude.app/api/projects \
  -H "Authorization: Bearer $PLANITUDE_API_KEY"
Resultado esperado200 OK
{
  "projects": [
    {
      "id": "40be00e0-7e34-4f7a-864b-5cc986f575b8",
      "workspaceId": "824650d2-d0b3-4cac-8df8-5743ae9ff65a",
      "key": "WHX",
      "keyLocked": false,
      "name": "Warehouse expansion",
      "description": null,
      "startDate": "2026-10-05",
      "calendarId": null,
      "currency": "EUR",
      "scheduleFrom": "forward",
      "deadline": null,
      "color": null,
      "settings": {},
      "archivedAt": null,
      "createdBy": "b1666432-132a-4ea9-b1ae-76ea69e226c5",
      "createdAt": "2026-10-01T08:30:12.418Z",
      "updatedAt": "2026-10-01T08:30:12.418Z",
      "workspaceName": "Acme Construction",
      "role": "owner",
      "taskCount": 12,
      "finishAt": "2026-10-07T15:00:00.000Z"
    }
  ]
}
3
curl -X POST https://planitude.app/api/webhooks \
  -H "Authorization: Bearer $PLANITUDE_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
  "url": "https://example.com/hooks/planitude",
  "events": [
    "task.created",
    "task.completed"
  ],
  "projectId": "40be00e0-7e34-4f7a-864b-5cc986f575b8"
}'
Payload de exemplowebhook.ping
{
  "id": "6f1c1d1e-2f4b-4d0a-9a77-2a3c5b1e9f10",
  "type": "webhook.ping",
  "apiVersion": "2026-10-01",
  "createdAt": "2026-10-01T08:30:12.418Z",
  "workspaceId": "824650d2-d0b3-4cac-8df8-5743ae9ff65a",
  "projectId": "40be00e0-7e34-4f7a-864b-5cc986f575b8",
  "actor": {
    "id": "b1666432-132a-4ea9-b1ae-76ea69e226c5",
    "name": "Anna Rossi"
  },
  "data": {
    "message": "Planitude webhook test",
    "webhook": {
      "id": "1747ee7f-a395-4d3c-94b0-54b513d71d88",
      "name": "Warehouse sync",
      "events": [
        "task.created",
        "task.completed"
      ]
    }
  }
}

Autenticação

Autentique cada requisição com uma chave API pessoal no cabeçalho Authorization, como bearer token. As chaves são pessoais: agem como você, com seu papel em cada projeto, nunca mais. Você pode limitar uma chave a um workspace, definir uma validade para ela e revogá-la a qualquer momento; cada chamada fica registrada ao lado da chave.

Scopes

ScopePermite
readplanitude:readLer projetos, tarefas, dependências, membros, comentários, linhas de base e webhooks.
writeplanitude:writeTudo o que a leitura permite, além de criar e alterar projetos, tarefas, dependências, comentários, linhas de base e webhooks.

Chaves e apps OAuth não podem excluir projetos nem tarefas: excluir continua no app web, onde uma pessoa confirma. Um script que mira o id errado não consegue apagar um plano.

OAuth 2.1 para apps de terceiros

Apps que agem em nome de outras pessoas usam OAuth 2.1: authorization code com PKCE (S256), refresh tokens rotacionados a cada uso, registro dinâmico de clientes (RFC 7591). Peça o recurso https://planitude.app/api e o scope planitude:read ou planitude:write.

Os endpoints são publicados nos documentos de discovery padrão, assim as bibliotecas OAuth se configuram sozinhas.

  • https://planitude.app/.well-known/oauth-authorization-server
  • https://planitude.app/.well-known/oauth-protected-resource

Boas práticas

  • Armazene as chaves em variáveis de ambiente ou em um gerenciador de segredos, nunca no código nem em um repositório. As chaves começam com pln_ para que os scanners de segredos as reconheçam.
  • Use uma chave somente leitura quando só precisar ler, e uma chave por integração: assim você revoga uma sem parar as outras.
  • Dê validade às chaves usadas por scripts e faça a rotação.
  • Chame a API do seu servidor, não do navegador: uma chave no código front-end é uma chave pública.
Bearercurl
curl https://planitude.app/api/projects \
  -H "Authorization: Bearer $PLANITUDE_API_KEY"
OAuth 2.1/.well-known/oauth-authorization-server
{
  "issuer": "https://planitude.app",
  "authorization_endpoint": "https://planitude.app/oauth/authorize",
  "token_endpoint": "https://planitude.app/api/oauth/token",
  "registration_endpoint": "https://planitude.app/api/oauth/register",
  "revocation_endpoint": "https://planitude.app/api/oauth/revoke",
  "scopes_supported": [
    "planitude:read",
    "planitude:write"
  ],
  "grant_types_supported": [
    "authorization_code",
    "refresh_token"
  ],
  "code_challenge_methods_supported": [
    "S256"
  ]
}

Erros

O Planitude usa os códigos de status HTTP padrão. Os erros têm sempre a mesma forma JSON: um código error estável para decidir e, quando útil, details com o motivo ou os campos a corrigir.

StatusSignificado
400invalid_requestA requisição não é válida: details.fields lista cada campo e o problema.
401unauthorizedA chave está ausente, inválida, revogada ou expirada.
403forbiddenA chave ou seu papel não permite (details.reason), por exemplo uma escrita com uma chave somente leitura, ou uma exclusão.
404not_foundNão encontrado, ou não visível para você.
409dependency_cycleConflito com o plano, por exemplo uma dependência que fecharia um ciclo (dependency_cycle).
429rate_limitedRequisições demais: aguarde os segundos indicados em Retry-After.
500server_errorErro do nosso lado: tente de novo com espera exponencial.

Error

CampoTipoDescrição
error
obrigatório
stringStable error code: invalid_request, unauthorized, forbidden, not_found, conflict, dependency_cycle, limit_exceeded, rate_limited, server_error, ...
detailsobject
Resposta
{
  "error": "invalid_request",
  "details": {
    "fields": [
      {
        "path": "name",
        "message": "Invalid input: expected string, received undefined"
      },
      {
        "path": "durationMin",
        "message": "Too small: expected number to be >=0"
      }
    ]
  }
}

Limites de taxa

Os limites valem por chave, em uma janela móvel de um minuto: 240 requisições de leitura e 60 de escrita. Acima disso você recebe 429 rate_limited com o cabeçalho Retry-After, em segundos.

Aguarde Retry-After antes de tentar de novo, distribua no tempo os trabalhos em massa e agrupe muitas mudanças em um change set: até 1.000 mudanças em uma requisição e um único recálculo.

RespostaHTTP
HTTP/1.1 429 Too Many Requests
Retry-After: 12
Content-Type: application/json

{
  "error": "rate_limited",
  "details": {
    "retryAfterSec": 12
  }
}

Paginação e busca

As listas de tarefas são paginadas com um cursor. Passe limit (1–500, padrão 100) e, para a página seguinte, o nextCursor da resposta anterior como cursor. Quando nextCursor é null, não há mais páginas.

Filtre com externalId (correspondência exata com seu identificador), q (o nome contém), updatedSince e completed; ordene com sort=-number (mais novas primeiro) ou -updatedAt. As listas mais curtas, como projetos, membros e dependências, chegam inteiras em uma resposta.

Requisição
curl "https://planitude.app/api/projects/40be00e0-7e34-4f7a-864b-5cc986f575b8/tasks?limit=500" \
  -H "Authorization: Bearer $PLANITUDE_API_KEY"

# next page: pass the nextCursor of the previous response
curl "https://planitude.app/api/projects/40be00e0-7e34-4f7a-864b-5cc986f575b8/tasks?limit=500&cursor=$NEXT_CURSOR" \
  -H "Authorization: Bearer $PLANITUDE_API_KEY"

Versões

A API e os payloads dos webhooks são versionados por data. A versão atual é 2026-10-01: é o campo apiVersion de cada evento e a info.version do documento OpenAPI.

Dentro de uma versão só acrescentamos: novos endpoints, novos campos opcionais, novos tipos de evento. Nenhum campo é removido ou muda de tipo sem uma nova versão, então ignore os campos que não conhece.

Requisição
curl https://planitude.app/api/webhooks/events
Resposta200 OK
{
  "apiVersion": "2026-10-01",
  "events": [
    "project.created",
    "project.updated",
    "project.deleted",
    "task.created",
    "task.updated",
    "task.deleted",
    "task.completed",
    "task.dates_changed",
    "dependency.created",
    "dependency.deleted",
    "baseline.saved",
    "member.invited",
    "member.joined",
    "comment.created"
  ]
}

Referência da API

Account

Who is calling, and their workspaces.

User

Atributos

CampoTipoDescrição
idstring (uuid)
emailstring (email)
namestringpode ser null
avatarUrlstringpode ser null
localestring
emailVerifiedboolean
ObjetosUser
{
  "id": "b1666432-132a-4ea9-b1ae-76ea69e226c5",
  "email": "anna@example.com",
  "name": "Anna Rossi",
  "avatarUrl": null,
  "locale": "en",
  "emailVerified": true
}

Workspace

Atributos

CampoTipoDescrição
idstring (uuid)
namestring
rolestring

Um de: owner, admin, member

ObjetosWorkspace
{
  "id": "824650d2-d0b3-4cac-8df8-5743ae9ff65a",
  "name": "Acme Construction",
  "role": "owner"
}

Current user (connection test)

GET/api/auth/me

Chave com acesso de leitura

Retorna

200 OK The user

CampoTipoDescrição
userUser
Requisição
curl https://planitude.app/api/auth/me \
  -H "Authorization: Bearer $PLANITUDE_API_KEY"
Resposta200 OK
{
  "user": {
    "id": "b1666432-132a-4ea9-b1ae-76ea69e226c5",
    "email": "anna@example.com",
    "name": "Anna Rossi",
    "avatarUrl": null,
    "locale": "en",
    "emailVerified": true
  }
}

Workspaces of the user, with role

GET/api/workspaces

Chave com acesso de leitura

Retorna

200 OK Workspaces

CampoTipoDescrição
workspacesarray of Workspace
Requisição
curl https://planitude.app/api/workspaces \
  -H "Authorization: Bearer $PLANITUDE_API_KEY"
Resposta200 OK
{
  "workspaces": [
    {
      "id": "824650d2-d0b3-4cac-8df8-5743ae9ff65a",
      "name": "Acme Construction",
      "role": "owner"
    }
  ]
}

Referência da API

Projects

Projects, templates and baselines.

Project

A project as returned by the write endpoints and project listings.

Atributos

CampoTipoDescrição
idstring (uuid)
workspaceIdstring (uuid)
keystringProject key, e.g. CRON (task keys are CRON-12).
keyLockedboolean
namestring
descriptionstringpode ser null
startDatestring (date)
calendarIdstring (uuid)pode ser null
currencystring
scheduleFromstring

Um de: forward, backward

deadlinestring (date)pode ser null
colorstringpode ser null
settingsobject
archivedAtstring (date-time)pode ser null
createdBystring (uuid)pode ser null
createdAtstring (date-time)
updatedAtstring (date-time)
ObjetosProject
{
  "id": "40be00e0-7e34-4f7a-864b-5cc986f575b8",
  "workspaceId": "824650d2-d0b3-4cac-8df8-5743ae9ff65a",
  "key": "WHX",
  "keyLocked": false,
  "name": "Warehouse expansion",
  "description": null,
  "startDate": "2026-10-05",
  "calendarId": null,
  "currency": "EUR",
  "scheduleFrom": "forward",
  "deadline": null,
  "color": null,
  "settings": {},
  "archivedAt": null,
  "createdBy": "b1666432-132a-4ea9-b1ae-76ea69e226c5",
  "createdAt": "2026-10-01T08:30:12.418Z",
  "updatedAt": "2026-10-01T08:30:12.418Z"
}

Template

Atributos

CampoTipoDescrição
idstringbuiltin:<slug> or the id of a template saved by you.
kindstring

Um de: builtin, user

namestring
descriptionstringpode ser null
taskCountinteger
durationDaysintegerWorking days from start to finish.
ObjetosTemplate
{
  "id": "builtin:website-launch",
  "kind": "builtin",
  "name": "Website launch",
  "description": "From discovery to go-live: design, content, development, testing and launch.",
  "taskCount": 12,
  "durationDays": 43
}

Baseline

Atributos

CampoTipoDescrição
idstring (uuid)
namestring
indexintegerpode ser nullNumbered MS Project baseline (1-10); null for the main baseline and the ones you name.
capturedAtstring (date-time)
capturedBystring (uuid)pode ser null
taskCountinteger
ObjetosBaseline
{
  "id": "b5d68d05-0640-48f9-8eeb-ed7804f4a116",
  "name": "Plan v1",
  "index": null,
  "capturedAt": "2026-10-01T08:30:12.418Z",
  "capturedBy": "b1666432-132a-4ea9-b1ae-76ea69e226c5",
  "taskCount": 12
}

List projects

GET/api/projects

Chave com acesso de leitura

All projects visible to the user (not paginated). ?archived=1 includes archived ones.

Parâmetros de consulta

CampoTipoDescrição
archivedstring

Um de: 1

Retorna

200 OK Projects

CampoTipoDescrição
projectsarray of Project
Requisição
curl https://planitude.app/api/projects \
  -H "Authorization: Bearer $PLANITUDE_API_KEY"
Resposta200 OK
{
  "projects": [
    {
      "id": "40be00e0-7e34-4f7a-864b-5cc986f575b8",
      "workspaceId": "824650d2-d0b3-4cac-8df8-5743ae9ff65a",
      "key": "WHX",
      "keyLocked": false,
      "name": "Warehouse expansion",
      "description": null,
      "startDate": "2026-10-05",
      "calendarId": null,
      "currency": "EUR",
      "scheduleFrom": "forward",
      "deadline": null,
      "color": null,
      "settings": {},
      "archivedAt": null,
      "createdBy": "b1666432-132a-4ea9-b1ae-76ea69e226c5",
      "createdAt": "2026-10-01T08:30:12.418Z",
      "updatedAt": "2026-10-01T08:30:12.418Z",
      "workspaceName": "Acme Construction",
      "role": "owner",
      "taskCount": 12,
      "finishAt": "2026-10-07T15:00:00.000Z"
    }
  ]
}

Create a project

POST/api/projects

Chave com acesso de escrita

Corpo da requisição

CampoTipoDescrição
name
obrigatório
string
workspaceIdstring (uuid)Defaults to your personal workspace.
keystring2-5 letters/digits, starts with a letter. Derived from the name if omitted.
descriptionstringpode ser null
startDatestring (date)
deadlinestring (date)pode ser null
currencystring
scheduleFromstring

Um de: forward, backward

colorstringpode ser null

Retorna

201 Created Created

CampoTipoDescrição
projectProject
Requisição
curl -X POST https://planitude.app/api/projects \
  -H "Authorization: Bearer $PLANITUDE_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"name":"Warehouse expansion","startDate":"2026-10-05","currency":"EUR"}'
Resposta201 Created
{
  "project": {
    "id": "40be00e0-7e34-4f7a-864b-5cc986f575b8",
    "workspaceId": "824650d2-d0b3-4cac-8df8-5743ae9ff65a",
    "key": "WHX",
    "keyLocked": false,
    "name": "Warehouse expansion",
    "description": null,
    "startDate": "2026-10-05",
    "calendarId": null,
    "currency": "EUR",
    "scheduleFrom": "forward",
    "deadline": null,
    "color": null,
    "settings": {},
    "archivedAt": null,
    "createdBy": "b1666432-132a-4ea9-b1ae-76ea69e226c5",
    "createdAt": "2026-10-01T08:30:12.418Z",
    "updatedAt": "2026-10-01T08:30:12.418Z"
  }
}

Create a project from a template

POST/api/projects/from-template

Chave com acesso de escrita

Corpo da requisição

CampoTipoDescrição
templateId
obrigatório
stringId from GET /api/templates.
startDate
obrigatório
string (date)
namestring
keystring
localestringLanguage of the template texts (en, it, es, fr, de, pt, nl, pl, ja, zh, sv, da, no, fi, cs, ro, uk, tr, ar, he, hi, id, vi, ko).
tzstringIANA time zone of the project calendar.
workspaceIdstring (uuid)

Retorna

201 Created Created

CampoTipoDescrição
projectProject
taskCountinteger
conflictsarray of Conflict
Requisição
curl -X POST https://planitude.app/api/projects/from-template \
  -H "Authorization: Bearer $PLANITUDE_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
  "templateId": "builtin:website-launch",
  "startDate": "2026-10-05",
  "name": "Website relaunch",
  "locale": "en"
}'
Resposta201 Created
{
  "project": {
    "id": "40be00e0-7e34-4f7a-864b-5cc986f575b8",
    "workspaceId": "824650d2-d0b3-4cac-8df8-5743ae9ff65a",
    "key": "WHX",
    "keyLocked": false,
    "name": "Warehouse expansion",
    "description": null,
    "startDate": "2026-10-05",
    "calendarId": null,
    "currency": "EUR",
    "scheduleFrom": "forward",
    "deadline": null,
    "color": null,
    "settings": {},
    "archivedAt": null,
    "createdBy": "b1666432-132a-4ea9-b1ae-76ea69e226c5",
    "createdAt": "2026-10-01T08:30:12.418Z",
    "updatedAt": "2026-10-01T08:30:12.418Z"
  },
  "taskCount": 12,
  "conflicts": []
}

List project templates

GET/api/templates

Chave com acesso de leitura

Parâmetros de consulta

CampoTipoDescrição
localestring

Retorna

200 OK Templates

CampoTipoDescrição
templatesarray of Template
Requisição
curl https://planitude.app/api/templates \
  -H "Authorization: Bearer $PLANITUDE_API_KEY"
Resposta200 OK
{
  "templates": [
    {
      "id": "builtin:website-launch",
      "kind": "builtin",
      "name": "Website launch",
      "description": "From discovery to go-live: design, content, development, testing and launch.",
      "taskCount": 12,
      "durationDays": 43
    }
  ]
}

Full project (tasks tree, dependencies, resources, members, baselines)

GET/api/projects/{projectId}

Chave com acesso de leitura

Parâmetros de caminho

CampoTipoDescrição
projectId
obrigatório
string (uuid)Project id.

Retorna

200 OK Project

CampoTipoDescrição
projectProject
tasksarray of Task
dependenciesarray of Dependency
Requisição
curl https://planitude.app/api/projects/40be00e0-7e34-4f7a-864b-5cc986f575b8 \
  -H "Authorization: Bearer $PLANITUDE_API_KEY"
Resposta200 OK
{
  "project": {
    "id": "40be00e0-7e34-4f7a-864b-5cc986f575b8",
    "workspaceId": "824650d2-d0b3-4cac-8df8-5743ae9ff65a",
    "key": "WHX",
    "keyLocked": false,
    "name": "Warehouse expansion",
    "description": null,
    "startDate": "2026-10-05",
    "calendarId": null,
    "currency": "EUR",
    "scheduleFrom": "forward",
    "deadline": null,
    "color": null,
    "settings": {},
    "archivedAt": null,
    "createdBy": "b1666432-132a-4ea9-b1ae-76ea69e226c5",
    "createdAt": "2026-10-01T08:30:12.418Z",
    "updatedAt": "2026-10-01T08:30:12.418Z"
  },
  "tasks": [
    {
      "id": "4dbd104a-00cd-4035-8955-255f52ea586a",
      "number": 1,
      "key": "WHX-1",
      "parentId": null,
      "sortKey": "i",
      "name": "Foundations",
      "type": "task",
      "durationMin": 1440,
      "workMin": 0,
      "progressPct": 0,
      "constraintKind": "asap",
      "constraintDate": null,
      "deadline": null,
      "calendarId": null,
      "costFixed": 0,
      "notes": null,
      "color": null,
      "wbs": null,
      "externalId": "crm-4711",
      "startAt": "2026-10-05T06:00:00.000Z",
      "finishAt": "2026-10-07T15:00:00.000Z",
      "isCritical": true,
      "totalFloatMin": 0,
      "earlyStartAt": "2026-10-05T06:00:00.000Z",
      "lateFinishAt": "2026-10-07T15:00:00.000Z",
      "actualStartAt": null,
      "actualFinishAt": null,
      "actualDurationMin": null,
      "remainingDurationMin": null,
      "manuallyScheduled": false,
      "levelingDelayMin": 0,
      "taskType": "fixed_units",
      "effortDriven": false,
      "durationOptimisticMin": null,
      "durationPessimisticMin": null
    }
  ],
  "dependencies": [
    {
      "id": "9ba5faf8-923d-4ecc-86f0-f245c5d179db",
      "predecessorId": "4dbd104a-00cd-4035-8955-255f52ea586a",
      "successorId": "a22fd799-c4dc-4869-a466-0dd6e96f71ce",
      "type": "FS",
      "lagMin": 0
    }
  ]
}

Update a project

PATCH/api/projects/{projectId}

Chave com acesso de escrita

Parâmetros de caminho

CampoTipoDescrição
projectId
obrigatório
string (uuid)Project id.

Corpo da requisição

CampoTipoDescrição
namestring
descriptionstringpode ser null
startDatestring (date)
deadlinestring (date)pode ser null
currencystring
scheduleFromstring

Um de: forward, backward

colorstringpode ser null
archivedboolean

Retorna

200 OK Updated

CampoTipoDescrição
projectProject
conflictsarray of Conflict
rescheduledbooleanThe schedule was recalculated (start date, calendar or direction changed).
Requisição
curl -X PATCH https://planitude.app/api/projects/40be00e0-7e34-4f7a-864b-5cc986f575b8 \
  -H "Authorization: Bearer $PLANITUDE_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"deadline":"2026-12-18"}'
Resposta200 OK
{
  "project": {
    "id": "40be00e0-7e34-4f7a-864b-5cc986f575b8",
    "workspaceId": "824650d2-d0b3-4cac-8df8-5743ae9ff65a",
    "key": "WHX",
    "keyLocked": false,
    "name": "Warehouse expansion",
    "description": null,
    "startDate": "2026-10-05",
    "calendarId": null,
    "currency": "EUR",
    "scheduleFrom": "forward",
    "deadline": null,
    "color": null,
    "settings": {},
    "archivedAt": null,
    "createdBy": "b1666432-132a-4ea9-b1ae-76ea69e226c5",
    "createdAt": "2026-10-01T08:30:12.418Z",
    "updatedAt": "2026-10-01T08:30:12.418Z"
  },
  "conflicts": [],
  "rescheduled": false
}

Export the plan as a file (Microsoft Project XML, CSV, PNG or PDF)

GET/api/projects/{projectId}/export

Chave com acesso de leitura

Returns the file itself (Content-Disposition: attachment), not JSON. Any role with access to the project, read-only included. png and pdf draw the Gantt chart on the server (title, generation date, legend; in the PDF repeated on every page) and accept the image options below; at most 20 image exports per user every 10 minutes. Over the size limits: 413 limit_exceeded with details.reason (tasks, image_too_large, pages, timeline).

Parâmetros de caminho

CampoTipoDescrição
projectId
obrigatório
string (uuid)Project id.

Parâmetros de consulta

CampoTipoDescrição
formatstringFile format. mspdi = Microsoft Project XML.

Um de: mspdi, csv, png, pdf

Padrão: mspdi

localestringLanguage of headings, legend and dates (e.g. en, it, ar, ja).

Padrão: en

scalestringPNG/PDF: time unit of the columns.

Um de: auto, day, week, month, quarter

Padrão: auto

fromstring (date)PNG/PDF: first day to draw (with to). Default: the whole project.
tostring (date)PNG/PDF: last day to draw (with from).
criticalstringPNG/PDF: highlight the critical path.

Um de: 0, 1

Padrão: 1

baselinestringPNG/PDF: draw the main baseline under each bar.

Um de: 0, 1

Padrão: 1

linksstringPNG/PDF: draw dependency arrows.

Um de: 0, 1

Padrão: 1

paperstringPDF: paper size.

Um de: a4, a3, letter

Padrão: a4

orientationstringPDF: page orientation.

Um de: landscape, portrait

Padrão: landscape

Retorna

200 OK The file: `application/xml`, `text/csv`, `image/png` or `application/pdf`.

Requisição
curl "https://planitude.app/api/projects/40be00e0-7e34-4f7a-864b-5cc986f575b8/export?format=pdf&locale=en&paper=a4" \
  -H "Authorization: Bearer $PLANITUDE_API_KEY" \
  -o plan.pdf

List baselines

GET/api/projects/{projectId}/baseline

Chave com acesso de leitura

Parâmetros de caminho

CampoTipoDescrição
projectId
obrigatório
string (uuid)Project id.

Retorna

200 OK Baselines

CampoTipoDescrição
baselinesarray of Baseline
Requisição
curl https://planitude.app/api/projects/40be00e0-7e34-4f7a-864b-5cc986f575b8/baseline \
  -H "Authorization: Bearer $PLANITUDE_API_KEY"
Resposta200 OK
{
  "baselines": [
    {
      "id": "b5d68d05-0640-48f9-8eeb-ed7804f4a116",
      "name": "Plan v1",
      "index": null,
      "capturedAt": "2026-10-01T08:30:12.418Z",
      "capturedBy": "b1666432-132a-4ea9-b1ae-76ea69e226c5",
      "taskCount": 12
    }
  ]
}

Save a baseline

POST/api/projects/{projectId}/baseline

Chave com acesso de escrita

Parâmetros de caminho

CampoTipoDescrição
projectId
obrigatório
string (uuid)Project id.

Corpo da requisição

CampoTipoDescrição
namestring

Retorna

201 Created Saved

CampoTipoDescrição
baselineBaseline
Requisição
curl -X POST https://planitude.app/api/projects/40be00e0-7e34-4f7a-864b-5cc986f575b8/baseline \
  -H "Authorization: Bearer $PLANITUDE_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"name":"Plan v1"}'
Resposta201 Created
{
  "baseline": {
    "id": "b5d68d05-0640-48f9-8eeb-ed7804f4a116",
    "name": "Plan v1",
    "index": null,
    "capturedAt": "2026-10-01T08:30:12.418Z",
    "capturedBy": "b1666432-132a-4ea9-b1ae-76ea69e226c5",
    "taskCount": 12
  }
}

Referência da API

Tasks

Tasks, search by external id, comments.

Task

Task representation of GET /tasks and webhook payloads: the stored task (without sortKey) plus project, assignees and link.

Atributos

CampoTipoDescrição
idstring (uuid)
numberintegerSequential number in the project, never reused.
keystringHuman key, e.g. CRON-12.
parentIdstring (uuid)pode ser null
namestring
typestring

Um de: summary, task, milestone

durationMinintegerDuration in working minutes (8h day = 480).
workMininteger
progressPctnumber
constraintKindstring

Um de: asap, alap, start_no_earlier_than, start_no_later_than, finish_no_earlier_than, finish_no_later_than, must_start_on, must_finish_on

constraintDatestring (date-time)pode ser null
deadlinestring (date-time)pode ser null
calendarIdstring (uuid)pode ser null
costFixednumber
notesstringpode ser null
colorstringpode ser null
wbsstringpode ser null
externalIdstringpode ser nullYour identifier for this task in another system. Searchable with GET /tasks?externalId=.
startAtstring (date-time)pode ser nullComputed start.
finishAtstring (date-time)pode ser nullComputed finish.
isCriticalbooleanOn the critical path.
totalFloatMinintegerpode ser nullTotal float (slack) in working minutes.
earlyStartAtstring (date-time)pode ser null
lateFinishAtstring (date-time)pode ser null
actualStartAtstring (date-time)pode ser null
actualFinishAtstring (date-time)pode ser null
actualDurationMinintegerpode ser null
remainingDurationMinintegerpode ser null
manuallyScheduledboolean
levelingDelayMininteger
taskTypestring

Um de: fixed_units, fixed_duration, fixed_work, fixed_duration_and_units

effortDrivenboolean
durationOptimisticMinintegerpode ser null
durationPessimisticMinintegerpode ser null
projectIdstring (uuid)
completedbooleanprogressPct = 100.
assigneesarray of Assignee
urlstring (uri)Page of the task in the web app.
ObjetosTask
{
  "id": "4dbd104a-00cd-4035-8955-255f52ea586a",
  "number": 1,
  "key": "WHX-1",
  "parentId": null,
  "name": "Foundations",
  "type": "task",
  "durationMin": 1440,
  "workMin": 0,
  "progressPct": 0,
  "constraintKind": "asap",
  "constraintDate": null,
  "deadline": null,
  "calendarId": null,
  "costFixed": 0,
  "notes": null,
  "color": null,
  "wbs": null,
  "externalId": "crm-4711",
  "startAt": "2026-10-05T06:00:00.000Z",
  "finishAt": "2026-10-07T15:00:00.000Z",
  "isCritical": true,
  "totalFloatMin": 0,
  "earlyStartAt": "2026-10-05T06:00:00.000Z",
  "lateFinishAt": "2026-10-07T15:00:00.000Z",
  "actualStartAt": null,
  "actualFinishAt": null,
  "actualDurationMin": null,
  "remainingDurationMin": null,
  "manuallyScheduled": false,
  "levelingDelayMin": 0,
  "taskType": "fixed_units",
  "effortDriven": false,
  "durationOptimisticMin": null,
  "durationPessimisticMin": null,
  "projectId": "40be00e0-7e34-4f7a-864b-5cc986f575b8",
  "completed": false,
  "assignees": [
    {
      "resourceId": "0c6a8f52-3d7e-4b19-9a4e-6f1d2c8b7e30",
      "userId": "b1666432-132a-4ea9-b1ae-76ea69e226c5",
      "name": "Anna Rossi",
      "unitsPct": 100
    }
  ],
  "url": "https://planitude.app/app/t/WHX-1"
}

WriteResult

Atributos

CampoTipoDescrição
tasksarray of TaskCreated/updated tasks plus the ones the recalculation moved.
deletedTaskIdsarray of string
dependenciesarray of Dependency
deletedDependencyIdsarray of string
conflictsarray of Conflict
projectStartAtstring (date-time)
projectFinishAtstring (date-time)
statsobject
Mostrar os campos de stats
CampoTipoDescrição
taskCountinteger
recomputedCountintegerTasks the scheduling engine recalculated.
savedCountintegerTasks whose stored values changed.
durationMsinteger
ObjetosWriteResult
{
  "tasks": [
    {
      "id": "4dbd104a-00cd-4035-8955-255f52ea586a",
      "number": 1,
      "key": "WHX-1",
      "parentId": null,
      "sortKey": "i",
      "name": "Foundations",
      "type": "task",
      "durationMin": 1440,
      "workMin": 0,
      "progressPct": 0,
      "constraintKind": "asap",
      "constraintDate": null,
      "deadline": null,
      "calendarId": null,
      "costFixed": 0,
      "notes": null,
      "color": null,
      "wbs": null,
      "externalId": "crm-4711",
      "startAt": "2026-10-05T06:00:00.000Z",
      "finishAt": "2026-10-07T15:00:00.000Z",
      "isCritical": true,
      "totalFloatMin": 0,
      "earlyStartAt": "2026-10-05T06:00:00.000Z",
      "lateFinishAt": "2026-10-07T15:00:00.000Z",
      "actualStartAt": null,
      "actualFinishAt": null,
      "actualDurationMin": null,
      "remainingDurationMin": null,
      "manuallyScheduled": false,
      "levelingDelayMin": 0,
      "taskType": "fixed_units",
      "effortDriven": false,
      "durationOptimisticMin": null,
      "durationPessimisticMin": null
    }
  ],
  "deletedTaskIds": [],
  "dependencies": [
    {
      "id": "9ba5faf8-923d-4ecc-86f0-f245c5d179db",
      "predecessorId": "4dbd104a-00cd-4035-8955-255f52ea586a",
      "successorId": "a22fd799-c4dc-4869-a466-0dd6e96f71ce",
      "type": "FS",
      "lagMin": 0
    }
  ],
  "deletedDependencyIds": [],
  "conflicts": [],
  "projectStartAt": "2026-10-05T06:00:00.000Z",
  "projectFinishAt": "2026-10-07T15:00:00.000Z",
  "stats": {
    "taskCount": 12,
    "recomputedCount": 3,
    "savedCount": 2,
    "durationMs": 39
  }
}

Comment

Atributos

CampoTipoDescrição
idstring (uuid)
taskIdstring (uuid)
userIdstring (uuid)
authorNamestring
authorAvatarUrlstringpode ser null
bodystring
mentionsarray of string
createdAtstring (date-time)
editedAtstring (date-time)pode ser null
ObjetosComment
{
  "id": "0fc2dec5-a409-47c9-9c6e-0663e8f8bcf3",
  "taskId": "4dbd104a-00cd-4035-8955-255f52ea586a",
  "userId": "b1666432-132a-4ea9-b1ae-76ea69e226c5",
  "authorName": "Anna Rossi",
  "authorAvatarUrl": null,
  "body": "Concrete delivered, we can start the walls.",
  "mentions": [],
  "createdAt": "2026-10-01T08:30:12.418Z",
  "editedAt": null
}

List or search tasks (paginated)

GET/api/projects/{projectId}/tasks

Chave com acesso de leitura

Parâmetros de caminho

CampoTipoDescrição
projectId
obrigatório
string (uuid)Project id.

Parâmetros de consulta

CampoTipoDescrição
limitinteger1-500.

Padrão: 100

cursorstringnextCursor of the previous page.
sortstring-number = newest first (polling triggers). -updatedAt returns the first page only.

Um de: number, -number, -updatedAt

Padrão: number

externalIdstringExact match on externalId.
qstringName contains (case-insensitive).
updatedSincestring (date-time)
completedstring

Um de: true, false

Retorna

200 OK A page of tasks

CampoTipoDescrição
tasksarray of Task
nextCursorstringpode ser null
Requisição
curl "https://planitude.app/api/projects/40be00e0-7e34-4f7a-864b-5cc986f575b8/tasks?externalId=crm-4711" \
  -H "Authorization: Bearer $PLANITUDE_API_KEY"
Resposta200 OK
{
  "tasks": [
    {
      "id": "4dbd104a-00cd-4035-8955-255f52ea586a",
      "number": 1,
      "key": "WHX-1",
      "parentId": null,
      "name": "Foundations",
      "type": "task",
      "durationMin": 1440,
      "workMin": 0,
      "progressPct": 0,
      "constraintKind": "asap",
      "constraintDate": null,
      "deadline": null,
      "calendarId": null,
      "costFixed": 0,
      "notes": null,
      "color": null,
      "wbs": null,
      "externalId": "crm-4711",
      "startAt": "2026-10-05T06:00:00.000Z",
      "finishAt": "2026-10-07T15:00:00.000Z",
      "isCritical": true,
      "totalFloatMin": 0,
      "earlyStartAt": "2026-10-05T06:00:00.000Z",
      "lateFinishAt": "2026-10-07T15:00:00.000Z",
      "actualStartAt": null,
      "actualFinishAt": null,
      "actualDurationMin": null,
      "remainingDurationMin": null,
      "manuallyScheduled": false,
      "levelingDelayMin": 0,
      "taskType": "fixed_units",
      "effortDriven": false,
      "durationOptimisticMin": null,
      "durationPessimisticMin": null,
      "projectId": "40be00e0-7e34-4f7a-864b-5cc986f575b8",
      "completed": false,
      "assignees": [
        {
          "resourceId": "0c6a8f52-3d7e-4b19-9a4e-6f1d2c8b7e30",
          "userId": "b1666432-132a-4ea9-b1ae-76ea69e226c5",
          "name": "Anna Rossi",
          "unitsPct": 100
        }
      ],
      "url": "https://planitude.app/app/t/WHX-1"
    }
  ],
  "nextCursor": null
}

Create a task, or apply a change set

POST/api/projects/{projectId}/tasks

Chave com acesso de escrita

Send a TaskCreate to create one task (201), or a ChangeSet to apply several changes in one transaction (200). Dates are recalculated by the scheduling engine.

Parâmetros de caminho

CampoTipoDescrição
projectId
obrigatório
string (uuid)Project id.

Corpo da requisição

TaskCreate

CampoTipoDescrição
name
obrigatório
string
parentIdstring (uuid)pode ser nullParent (summary) task; null = top level.
afterTaskIdstring (uuid)pode ser nullInsert after this sibling.
beforeTaskIdstring (uuid)pode ser nullInsert before this sibling.
typestring

Um de: summary, task, milestone

durationMinintegerDuration in working minutes (8h day = 480).
workMininteger
progressPctnumber
constraintKindstring

Um de: asap, alap, start_no_earlier_than, start_no_later_than, finish_no_earlier_than, finish_no_later_than, must_start_on, must_finish_on

constraintDatestring (date-time)pode ser null
deadlinestring (date-time)pode ser null
calendarIdstring (uuid)pode ser null
costFixednumber
notesstringpode ser null
colorstringpode ser null
wbsstringpode ser null
externalIdstringpode ser nullYour identifier for this task in another system. Searchable with GET /tasks?externalId=.

ou ChangeSet

CampoTipoDescrição
createTasksarray of TaskCreate
updateTasksarray of any
createDependenciesarray of DependencyCreate
deleteDependencyIdsarray of string
fullRescheduleboolean

Retorna

201 Created Task created

CampoTipoDescrição
tasksarray of TaskCreated/updated tasks plus the ones the recalculation moved.
deletedTaskIdsarray of string
dependenciesarray of Dependency
deletedDependencyIdsarray of string
conflictsarray of Conflict
projectStartAtstring (date-time)
projectFinishAtstring (date-time)
statsobject
Mostrar os campos de stats
CampoTipoDescrição
taskCountinteger
recomputedCountintegerTasks the scheduling engine recalculated.
savedCountintegerTasks whose stored values changed.
durationMsinteger
Requisição
curl -X POST https://planitude.app/api/projects/40be00e0-7e34-4f7a-864b-5cc986f575b8/tasks \
  -H "Authorization: Bearer $PLANITUDE_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"name":"Foundations","durationMin":1440,"externalId":"crm-4711"}'
Resposta201 Created
{
  "tasks": [
    {
      "id": "4dbd104a-00cd-4035-8955-255f52ea586a",
      "number": 1,
      "key": "WHX-1",
      "parentId": null,
      "sortKey": "i",
      "name": "Foundations",
      "type": "task",
      "durationMin": 1440,
      "workMin": 0,
      "progressPct": 0,
      "constraintKind": "asap",
      "constraintDate": null,
      "deadline": null,
      "calendarId": null,
      "costFixed": 0,
      "notes": null,
      "color": null,
      "wbs": null,
      "externalId": "crm-4711",
      "startAt": "2026-10-05T06:00:00.000Z",
      "finishAt": "2026-10-07T15:00:00.000Z",
      "isCritical": true,
      "totalFloatMin": 0,
      "earlyStartAt": "2026-10-05T06:00:00.000Z",
      "lateFinishAt": "2026-10-07T15:00:00.000Z",
      "actualStartAt": null,
      "actualFinishAt": null,
      "actualDurationMin": null,
      "remainingDurationMin": null,
      "manuallyScheduled": false,
      "levelingDelayMin": 0,
      "taskType": "fixed_units",
      "effortDriven": false,
      "durationOptimisticMin": null,
      "durationPessimisticMin": null
    }
  ],
  "deletedTaskIds": [],
  "dependencies": [
    {
      "id": "9ba5faf8-923d-4ecc-86f0-f245c5d179db",
      "predecessorId": "4dbd104a-00cd-4035-8955-255f52ea586a",
      "successorId": "a22fd799-c4dc-4869-a466-0dd6e96f71ce",
      "type": "FS",
      "lagMin": 0
    }
  ],
  "deletedDependencyIds": [],
  "conflicts": [],
  "projectStartAt": "2026-10-05T06:00:00.000Z",
  "projectFinishAt": "2026-10-07T15:00:00.000Z",
  "stats": {
    "taskCount": 12,
    "recomputedCount": 3,
    "savedCount": 2,
    "durationMs": 39
  }
}

Get a task

GET/api/projects/{projectId}/tasks/{taskId}

Chave com acesso de leitura

Parâmetros de caminho

CampoTipoDescrição
projectId
obrigatório
string (uuid)Project id.
taskId
obrigatório
string (uuid)Task id.

Retorna

200 OK The task

CampoTipoDescrição
taskTask
Requisição
curl https://planitude.app/api/projects/40be00e0-7e34-4f7a-864b-5cc986f575b8/tasks/4dbd104a-00cd-4035-8955-255f52ea586a \
  -H "Authorization: Bearer $PLANITUDE_API_KEY"
Resposta200 OK
{
  "task": {
    "id": "4dbd104a-00cd-4035-8955-255f52ea586a",
    "number": 1,
    "key": "WHX-1",
    "parentId": null,
    "name": "Foundations",
    "type": "task",
    "durationMin": 1440,
    "workMin": 0,
    "progressPct": 0,
    "constraintKind": "asap",
    "constraintDate": null,
    "deadline": null,
    "calendarId": null,
    "costFixed": 0,
    "notes": null,
    "color": null,
    "wbs": null,
    "externalId": "crm-4711",
    "startAt": "2026-10-05T06:00:00.000Z",
    "finishAt": "2026-10-07T15:00:00.000Z",
    "isCritical": true,
    "totalFloatMin": 0,
    "earlyStartAt": "2026-10-05T06:00:00.000Z",
    "lateFinishAt": "2026-10-07T15:00:00.000Z",
    "actualStartAt": null,
    "actualFinishAt": null,
    "actualDurationMin": null,
    "remainingDurationMin": null,
    "manuallyScheduled": false,
    "levelingDelayMin": 0,
    "taskType": "fixed_units",
    "effortDriven": false,
    "durationOptimisticMin": null,
    "durationPessimisticMin": null,
    "projectId": "40be00e0-7e34-4f7a-864b-5cc986f575b8",
    "completed": false,
    "assignees": [
      {
        "resourceId": "0c6a8f52-3d7e-4b19-9a4e-6f1d2c8b7e30",
        "userId": "b1666432-132a-4ea9-b1ae-76ea69e226c5",
        "name": "Anna Rossi",
        "unitsPct": 100
      }
    ],
    "url": "https://planitude.app/app/t/WHX-1"
  }
}

Update a task

PATCH/api/projects/{projectId}/tasks/{taskId}

Chave com acesso de escrita

Only the fields you send change; null clears a field.

Parâmetros de caminho

CampoTipoDescrição
projectId
obrigatório
string (uuid)Project id.
taskId
obrigatório
string (uuid)Task id.

Corpo da requisição

CampoTipoDescrição
namestring
typestring

Um de: summary, task, milestone

durationMinintegerDuration in working minutes (8h day = 480).
workMininteger
progressPctnumber
constraintKindstring

Um de: asap, alap, start_no_earlier_than, start_no_later_than, finish_no_earlier_than, finish_no_later_than, must_start_on, must_finish_on

constraintDatestring (date-time)pode ser null
deadlinestring (date-time)pode ser null
calendarIdstring (uuid)pode ser null
costFixednumber
notesstringpode ser null
colorstringpode ser null
wbsstringpode ser null
externalIdstringpode ser nullYour identifier for this task in another system. Searchable with GET /tasks?externalId=.
placementobject
Mostrar os campos de placement
CampoTipoDescrição
parentIdstring (uuid)pode ser nullParent (summary) task; null = top level.
afterTaskIdstring (uuid)pode ser nullInsert after this sibling.
beforeTaskIdstring (uuid)pode ser nullInsert before this sibling.

Retorna

200 OK Updated

CampoTipoDescrição
tasksarray of TaskCreated/updated tasks plus the ones the recalculation moved.
deletedTaskIdsarray of string
dependenciesarray of Dependency
deletedDependencyIdsarray of string
conflictsarray of Conflict
projectStartAtstring (date-time)
projectFinishAtstring (date-time)
statsobject
Mostrar os campos de stats
CampoTipoDescrição
taskCountinteger
recomputedCountintegerTasks the scheduling engine recalculated.
savedCountintegerTasks whose stored values changed.
durationMsinteger
Requisição
curl -X PATCH https://planitude.app/api/projects/40be00e0-7e34-4f7a-864b-5cc986f575b8/tasks/4dbd104a-00cd-4035-8955-255f52ea586a \
  -H "Authorization: Bearer $PLANITUDE_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"progressPct":100}'
Resposta200 OK
{
  "tasks": [
    {
      "id": "4dbd104a-00cd-4035-8955-255f52ea586a",
      "number": 1,
      "key": "WHX-1",
      "parentId": null,
      "sortKey": "i",
      "name": "Foundations",
      "type": "task",
      "durationMin": 1440,
      "workMin": 0,
      "progressPct": 0,
      "constraintKind": "asap",
      "constraintDate": null,
      "deadline": null,
      "calendarId": null,
      "costFixed": 0,
      "notes": null,
      "color": null,
      "wbs": null,
      "externalId": "crm-4711",
      "startAt": "2026-10-05T06:00:00.000Z",
      "finishAt": "2026-10-07T15:00:00.000Z",
      "isCritical": true,
      "totalFloatMin": 0,
      "earlyStartAt": "2026-10-05T06:00:00.000Z",
      "lateFinishAt": "2026-10-07T15:00:00.000Z",
      "actualStartAt": null,
      "actualFinishAt": null,
      "actualDurationMin": null,
      "remainingDurationMin": null,
      "manuallyScheduled": false,
      "levelingDelayMin": 0,
      "taskType": "fixed_units",
      "effortDriven": false,
      "durationOptimisticMin": null,
      "durationPessimisticMin": null
    }
  ],
  "deletedTaskIds": [],
  "dependencies": [
    {
      "id": "9ba5faf8-923d-4ecc-86f0-f245c5d179db",
      "predecessorId": "4dbd104a-00cd-4035-8955-255f52ea586a",
      "successorId": "a22fd799-c4dc-4869-a466-0dd6e96f71ce",
      "type": "FS",
      "lagMin": 0
    }
  ],
  "deletedDependencyIds": [],
  "conflicts": [],
  "projectStartAt": "2026-10-05T06:00:00.000Z",
  "projectFinishAt": "2026-10-07T15:00:00.000Z",
  "stats": {
    "taskCount": 12,
    "recomputedCount": 3,
    "savedCount": 2,
    "durationMs": 39
  }
}

Comments of a task

GET/api/projects/{projectId}/tasks/{taskId}/comments

Chave com acesso de leitura

Parâmetros de caminho

CampoTipoDescrição
projectId
obrigatório
string (uuid)Project id.
taskId
obrigatório
string (uuid)Task id.

Retorna

200 OK Comments

CampoTipoDescrição
commentsarray of Comment
Requisição
curl https://planitude.app/api/projects/40be00e0-7e34-4f7a-864b-5cc986f575b8/tasks/4dbd104a-00cd-4035-8955-255f52ea586a/comments \
  -H "Authorization: Bearer $PLANITUDE_API_KEY"
Resposta200 OK
{
  "comments": [
    {
      "id": "0fc2dec5-a409-47c9-9c6e-0663e8f8bcf3",
      "taskId": "4dbd104a-00cd-4035-8955-255f52ea586a",
      "userId": "b1666432-132a-4ea9-b1ae-76ea69e226c5",
      "authorName": "Anna Rossi",
      "authorAvatarUrl": null,
      "body": "Concrete delivered, we can start the walls.",
      "mentions": [],
      "createdAt": "2026-10-01T08:30:12.418Z",
      "editedAt": null
    }
  ]
}

Comment on a task

POST/api/projects/{projectId}/tasks/{taskId}/comments

Chave com acesso de escrita

Parâmetros de caminho

CampoTipoDescrição
projectId
obrigatório
string (uuid)Project id.
taskId
obrigatório
string (uuid)Task id.

Corpo da requisição

CampoTipoDescrição
body
obrigatório
stringPlain text.
mentionsarray of stringUser ids to notify.

Retorna

201 Created Created

CampoTipoDescrição
commentComment
Requisição
curl -X POST https://planitude.app/api/projects/40be00e0-7e34-4f7a-864b-5cc986f575b8/tasks/4dbd104a-00cd-4035-8955-255f52ea586a/comments \
  -H "Authorization: Bearer $PLANITUDE_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"body":"Concrete delivered, we can start the walls."}'
Resposta201 Created
{
  "comment": {
    "id": "0fc2dec5-a409-47c9-9c6e-0663e8f8bcf3",
    "taskId": "4dbd104a-00cd-4035-8955-255f52ea586a",
    "userId": "b1666432-132a-4ea9-b1ae-76ea69e226c5",
    "authorName": "Anna Rossi",
    "authorAvatarUrl": null,
    "body": "Concrete delivered, we can start the walls.",
    "mentions": [],
    "createdAt": "2026-10-01T08:30:12.418Z",
    "editedAt": null
  }
}

Referência da API

Dependencies

Links between tasks (FS, SS, FF, SF, with lag).

Dependency

Atributos

CampoTipoDescrição
idstring (uuid)
predecessorIdstring (uuid)
successorIdstring (uuid)
typestring

Um de: FS, SS, FF, SF

lagMinintegerWorking minutes; negative = lead.
ObjetosDependency
{
  "id": "9ba5faf8-923d-4ecc-86f0-f245c5d179db",
  "predecessorId": "4dbd104a-00cd-4035-8955-255f52ea586a",
  "successorId": "a22fd799-c4dc-4869-a466-0dd6e96f71ce",
  "type": "FS",
  "lagMin": 0
}

List dependencies

GET/api/projects/{projectId}/dependencies

Chave com acesso de leitura

Parâmetros de caminho

CampoTipoDescrição
projectId
obrigatório
string (uuid)Project id.

Retorna

200 OK Dependencies

CampoTipoDescrição
dependenciesarray of Dependency
Requisição
curl https://planitude.app/api/projects/40be00e0-7e34-4f7a-864b-5cc986f575b8/dependencies \
  -H "Authorization: Bearer $PLANITUDE_API_KEY"
Resposta200 OK
{
  "dependencies": [
    {
      "id": "9ba5faf8-923d-4ecc-86f0-f245c5d179db",
      "predecessorId": "4dbd104a-00cd-4035-8955-255f52ea586a",
      "successorId": "a22fd799-c4dc-4869-a466-0dd6e96f71ce",
      "type": "FS",
      "lagMin": 0
    }
  ]
}

Create (or update) a dependency

POST/api/projects/{projectId}/dependencies

Chave com acesso de escrita

A dependency that would close a cycle is refused with 409 dependency_cycle.

Parâmetros de caminho

CampoTipoDescrição
projectId
obrigatório
string (uuid)Project id.

Corpo da requisição

DependencyCreate

CampoTipoDescrição
predecessorId
obrigatório
string (uuid)
successorId
obrigatório
string (uuid)
typestring

Um de: FS, SS, FF, SF

Padrão: FS

lagMininteger

Padrão: 0

ou dependencies

CampoTipoDescrição
dependencies
obrigatório
array of DependencyCreate

Retorna

201 Created Created

CampoTipoDescrição
tasksarray of TaskCreated/updated tasks plus the ones the recalculation moved.
deletedTaskIdsarray of string
dependenciesarray of Dependency
deletedDependencyIdsarray of string
conflictsarray of Conflict
projectStartAtstring (date-time)
projectFinishAtstring (date-time)
statsobject
Mostrar os campos de stats
CampoTipoDescrição
taskCountinteger
recomputedCountintegerTasks the scheduling engine recalculated.
savedCountintegerTasks whose stored values changed.
durationMsinteger
Requisição
curl -X POST https://planitude.app/api/projects/40be00e0-7e34-4f7a-864b-5cc986f575b8/dependencies \
  -H "Authorization: Bearer $PLANITUDE_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
  "predecessorId": "4dbd104a-00cd-4035-8955-255f52ea586a",
  "successorId": "a22fd799-c4dc-4869-a466-0dd6e96f71ce",
  "type": "FS",
  "lagMin": 0
}'
Resposta201 Created
{
  "tasks": [
    {
      "id": "4dbd104a-00cd-4035-8955-255f52ea586a",
      "number": 1,
      "key": "WHX-1",
      "parentId": null,
      "sortKey": "i",
      "name": "Foundations",
      "type": "task",
      "durationMin": 1440,
      "workMin": 0,
      "progressPct": 0,
      "constraintKind": "asap",
      "constraintDate": null,
      "deadline": null,
      "calendarId": null,
      "costFixed": 0,
      "notes": null,
      "color": null,
      "wbs": null,
      "externalId": "crm-4711",
      "startAt": "2026-10-05T06:00:00.000Z",
      "finishAt": "2026-10-07T15:00:00.000Z",
      "isCritical": true,
      "totalFloatMin": 0,
      "earlyStartAt": "2026-10-05T06:00:00.000Z",
      "lateFinishAt": "2026-10-07T15:00:00.000Z",
      "actualStartAt": null,
      "actualFinishAt": null,
      "actualDurationMin": null,
      "remainingDurationMin": null,
      "manuallyScheduled": false,
      "levelingDelayMin": 0,
      "taskType": "fixed_units",
      "effortDriven": false,
      "durationOptimisticMin": null,
      "durationPessimisticMin": null
    }
  ],
  "deletedTaskIds": [],
  "dependencies": [
    {
      "id": "9ba5faf8-923d-4ecc-86f0-f245c5d179db",
      "predecessorId": "4dbd104a-00cd-4035-8955-255f52ea586a",
      "successorId": "a22fd799-c4dc-4869-a466-0dd6e96f71ce",
      "type": "FS",
      "lagMin": 0
    }
  ],
  "deletedDependencyIds": [],
  "conflicts": [],
  "projectStartAt": "2026-10-05T06:00:00.000Z",
  "projectFinishAt": "2026-10-07T15:00:00.000Z",
  "stats": {
    "taskCount": 12,
    "recomputedCount": 3,
    "savedCount": 2,
    "durationMs": 39
  }
}

Remove a dependency

DEL/api/projects/{projectId}/dependencies/{dependencyId}

Chave com acesso de escrita

Parâmetros de caminho

CampoTipoDescrição
projectId
obrigatório
string (uuid)Project id.
dependencyId
obrigatório
string (uuid)

Retorna

200 OK Removed

CampoTipoDescrição
tasksarray of TaskCreated/updated tasks plus the ones the recalculation moved.
deletedTaskIdsarray of string
dependenciesarray of Dependency
deletedDependencyIdsarray of string
conflictsarray of Conflict
projectStartAtstring (date-time)
projectFinishAtstring (date-time)
statsobject
Mostrar os campos de stats
CampoTipoDescrição
taskCountinteger
recomputedCountintegerTasks the scheduling engine recalculated.
savedCountintegerTasks whose stored values changed.
durationMsinteger
Requisição
curl -X DELETE https://planitude.app/api/projects/40be00e0-7e34-4f7a-864b-5cc986f575b8/dependencies/9ba5faf8-923d-4ecc-86f0-f245c5d179db \
  -H "Authorization: Bearer $PLANITUDE_API_KEY"
Resposta200 OK
{
  "tasks": [
    {
      "id": "4dbd104a-00cd-4035-8955-255f52ea586a",
      "number": 1,
      "key": "WHX-1",
      "parentId": null,
      "sortKey": "i",
      "name": "Foundations",
      "type": "task",
      "durationMin": 1440,
      "workMin": 0,
      "progressPct": 0,
      "constraintKind": "asap",
      "constraintDate": null,
      "deadline": null,
      "calendarId": null,
      "costFixed": 0,
      "notes": null,
      "color": null,
      "wbs": null,
      "externalId": "crm-4711",
      "startAt": "2026-10-05T06:00:00.000Z",
      "finishAt": "2026-10-07T15:00:00.000Z",
      "isCritical": true,
      "totalFloatMin": 0,
      "earlyStartAt": "2026-10-05T06:00:00.000Z",
      "lateFinishAt": "2026-10-07T15:00:00.000Z",
      "actualStartAt": null,
      "actualFinishAt": null,
      "actualDurationMin": null,
      "remainingDurationMin": null,
      "manuallyScheduled": false,
      "levelingDelayMin": 0,
      "taskType": "fixed_units",
      "effortDriven": false,
      "durationOptimisticMin": null,
      "durationPessimisticMin": null
    }
  ],
  "deletedTaskIds": [],
  "dependencies": [
    {
      "id": "9ba5faf8-923d-4ecc-86f0-f245c5d179db",
      "predecessorId": "4dbd104a-00cd-4035-8955-255f52ea586a",
      "successorId": "a22fd799-c4dc-4869-a466-0dd6e96f71ce",
      "type": "FS",
      "lagMin": 0
    }
  ],
  "deletedDependencyIds": [],
  "conflicts": [],
  "projectStartAt": "2026-10-05T06:00:00.000Z",
  "projectFinishAt": "2026-10-07T15:00:00.000Z",
  "stats": {
    "taskCount": 12,
    "recomputedCount": 3,
    "savedCount": 2,
    "durationMs": 39
  }
}

Referência da API

People

Project members and task assignees.

Member

Atributos

CampoTipoDescrição
userIdstring (uuid)
namestring
emailstring
rolestringEffective role on the project.

Um de: owner, editor, viewer

directRolestringpode ser nullRole granted on the project itself (null = only through the workspace).

Um de: owner, editor, viewer

inheritedbooleanAccess comes from the workspace.
resourceIdstring (uuid)pode ser nullResource used when the person is assigned to tasks.
addedAtstring (date-time)
avatarUrlstringpode ser null
ObjetosMember
{
  "userId": "b1666432-132a-4ea9-b1ae-76ea69e226c5",
  "name": "Anna Rossi",
  "email": "anna@example.com",
  "role": "owner",
  "directRole": null,
  "inherited": false,
  "resourceId": "0c6a8f52-3d7e-4b19-9a4e-6f1d2c8b7e30",
  "addedAt": "2026-10-01T08:30:12.418Z",
  "avatarUrl": null
}

Assignee

Atributos

CampoTipoDescrição
resourceIdstring (uuid)
userIdstring (uuid)pode ser null
namestring
unitsPctinteger
ObjetosAssignee
{
  "resourceId": "0c6a8f52-3d7e-4b19-9a4e-6f1d2c8b7e30",
  "userId": "b1666432-132a-4ea9-b1ae-76ea69e226c5",
  "name": "Anna Rossi",
  "unitsPct": 100
}

Replace the people assigned to a task

PUT/api/projects/{projectId}/tasks/{taskId}/assignees

Chave com acesso de escrita

userIds must be members of the project (GET /members). An empty list removes everyone. Optional resourceIds replaces the people imported from a file (resources without an account) assigned to the task; omit it to leave them as they are.

Parâmetros de caminho

CampoTipoDescrição
projectId
obrigatório
string (uuid)Project id.
taskId
obrigatório
string (uuid)Task id.

Corpo da requisição

CampoTipoDescrição
userIds
obrigatório
array of string
resourceIdsarray of string

Retorna

200 OK Assignees saved

CampoTipoDescrição
taskIdstring (uuid)
assignmentsarray of object
Mostrar os campos de assignments
CampoTipoDescrição
idstring (uuid)
taskIdstring (uuid)
resourceIdstring (uuid)
unitsPctinteger
workMininteger
resourcesarray of object
Mostrar os campos de resources
CampoTipoDescrição
idstring (uuid)
userIdstring (uuid)pode ser null
namestring
kindstring

Um de: work, material, cost

emailstringpode ser null
costPerHournumber
costPerUsenumber
capacityPctinteger
calendarIdstring (uuid)pode ser null
colorstringpode ser null
avatarUrlstringpode ser null
needsRescheduleboolean
conflictsarray of Conflict
Requisição
curl -X PUT https://planitude.app/api/projects/40be00e0-7e34-4f7a-864b-5cc986f575b8/tasks/4dbd104a-00cd-4035-8955-255f52ea586a/assignees \
  -H "Authorization: Bearer $PLANITUDE_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"userIds":["b1666432-132a-4ea9-b1ae-76ea69e226c5"]}'
Resposta200 OK
{
  "taskId": "4dbd104a-00cd-4035-8955-255f52ea586a",
  "assignments": [
    {
      "id": "e62ac96b-e68e-40d3-842e-335e27dfd099",
      "taskId": "4dbd104a-00cd-4035-8955-255f52ea586a",
      "resourceId": "0c6a8f52-3d7e-4b19-9a4e-6f1d2c8b7e30",
      "unitsPct": 100,
      "workMin": 0
    }
  ],
  "resources": [
    {
      "id": "0c6a8f52-3d7e-4b19-9a4e-6f1d2c8b7e30",
      "userId": "b1666432-132a-4ea9-b1ae-76ea69e226c5",
      "name": "Anna Rossi",
      "kind": "builtin",
      "email": "anna@example.com",
      "costPerHour": 0,
      "costPerUse": 0,
      "capacityPct": 0,
      "calendarId": null,
      "color": null,
      "avatarUrl": null
    }
  ],
  "needsReschedule": false,
  "conflicts": []
}

People with access to the project (assignable)

GET/api/projects/{projectId}/members

Chave com acesso de leitura

Parâmetros de caminho

CampoTipoDescrição
projectId
obrigatório
string (uuid)Project id.

Retorna

200 OK Members

CampoTipoDescrição
membersarray of Member
rolestring
Requisição
curl https://planitude.app/api/projects/40be00e0-7e34-4f7a-864b-5cc986f575b8/members \
  -H "Authorization: Bearer $PLANITUDE_API_KEY"
Resposta200 OK
{
  "members": [
    {
      "userId": "b1666432-132a-4ea9-b1ae-76ea69e226c5",
      "name": "Anna Rossi",
      "email": "anna@example.com",
      "role": "owner",
      "directRole": null,
      "inherited": false,
      "resourceId": "0c6a8f52-3d7e-4b19-9a4e-6f1d2c8b7e30",
      "addedAt": "2026-10-01T08:30:12.418Z",
      "avatarUrl": null
    }
  ],
  "role": "owner"
}

Referência da API

Webhooks

Outgoing webhook subscriptions (REST hooks: subscribe/unsubscribe).

Webhook

Atributos

CampoTipoDescrição
idstring (uuid)
workspaceIdstring (uuid)
workspaceNamestring
projectIdstring (uuid)pode ser nullnull = every project of the workspace.
projectNamestringpode ser null
namestring
urlstring (uri)
eventsarray of string

Um de: project.created, project.updated, project.deleted, task.created, task.updated, task.deleted, task.completed, task.dates_changed, dependency.created, dependency.deleted, baseline.saved, member.invited, member.joined, comment.created

secretPrefixstringFirst characters of the signing secret (not secret).
activeboolean
disabledReasonstringpode ser null

Um de: failures, gone, project_deleted, user

disabledAtstring (date-time)pode ser null
consecutiveFailuresinteger
viaApibooleanCreated with the API (REST hook) rather than from the profile.
createdByobjectpode ser null
Mostrar os campos de createdBy
CampoTipoDescrição
idstring (uuid)
namestringpode ser null
createdAtstring (date-time)
updatedAtstring (date-time)
lastDeliveryAtstring (date-time)pode ser null
lastSuccessAtstring (date-time)pode ser null
ObjetosWebhook
{
  "id": "1747ee7f-a395-4d3c-94b0-54b513d71d88",
  "workspaceId": "824650d2-d0b3-4cac-8df8-5743ae9ff65a",
  "workspaceName": "Acme Construction",
  "projectId": "40be00e0-7e34-4f7a-864b-5cc986f575b8",
  "projectName": "Warehouse expansion",
  "name": "Warehouse sync",
  "url": "https://example.com/hooks/planitude",
  "events": [
    "task.created",
    "task.completed"
  ],
  "secretPrefix": "whsec_Fdwl",
  "active": true,
  "disabledReason": null,
  "disabledAt": null,
  "consecutiveFailures": 0,
  "viaApi": true,
  "createdBy": {
    "id": "b1666432-132a-4ea9-b1ae-76ea69e226c5",
    "name": "Anna Rossi"
  },
  "createdAt": "2026-10-01T08:30:12.418Z",
  "updatedAt": "2026-10-01T08:30:12.418Z",
  "lastDeliveryAt": "2026-10-01T08:30:12.418Z",
  "lastSuccessAt": "2026-10-01T08:30:12.418Z"
}

Delivery

Atributos

CampoTipoDescrição
idstring (uuid)
eventIdstring (uuid)
eventTypestring
statusstring

Um de: pending, success, failed, cancelled

attemptsinteger
nextAttemptAtstring (date-time)pode ser null
lastAttemptAtstring (date-time)pode ser null
responseStatusintegerpode ser null
responseExcerptstringpode ser null
errorstringpode ser null
durationMsintegerpode ser null
manualboolean
createdAtstring (date-time)
ObjetosDelivery
{
  "id": "4b207161-80f9-40bb-bc3f-d8f70315be00",
  "eventId": "6f1c1d1e-2f4b-4d0a-9a77-2a3c5b1e9f10",
  "eventType": "task.completed",
  "status": "success",
  "attempts": 1,
  "nextAttemptAt": null,
  "lastAttemptAt": "2026-10-01T08:30:12.418Z",
  "responseStatus": 200,
  "responseExcerpt": "{\"ok\":true}",
  "error": null,
  "durationMs": 39,
  "manual": false,
  "createdAt": "2026-10-01T08:30:12.418Z"
}

Event

Atributos

CampoTipoDescrição
id
obrigatório
string (uuid)Event id, also in the Planitude-Event-Id header: use it to deduplicate.
type
obrigatório
string

Um de: project.created, project.updated, project.deleted, task.created, task.updated, task.deleted, task.completed, task.dates_changed, dependency.created, dependency.deleted, baseline.saved, member.invited, member.joined, comment.created, webhook.ping

apiVersion
obrigatório
string

Um de: 2026-10-01

createdAt
obrigatório
string (date-time)
workspaceId
obrigatório
string (uuid)
projectIdstring (uuid)pode ser null
actorobjectpode ser nullWho made the change (null for system changes).
Mostrar os campos de actor
CampoTipoDescrição
idstring (uuid)
namestringpode ser null
data
obrigatório
object
ObjetosEvent
{
  "id": "6f1c1d1e-2f4b-4d0a-9a77-2a3c5b1e9f10",
  "type": "project.created",
  "apiVersion": "2026-10-01",
  "createdAt": "2026-10-01T08:30:12.418Z",
  "workspaceId": "824650d2-d0b3-4cac-8df8-5743ae9ff65a",
  "projectId": "40be00e0-7e34-4f7a-864b-5cc986f575b8",
  "actor": {
    "id": "b1666432-132a-4ea9-b1ae-76ea69e226c5",
    "name": "Anna Rossi"
  },
  "data": {}
}

Project (event payload)

Compact project representation used in webhook payloads.

Atributos

CampoTipoDescrição
idstring (uuid)
workspaceIdstring (uuid)
keystring
namestring
descriptionstringpode ser null
startDatestring (date)
deadlinestring (date)pode ser null
currencystring
scheduleFromstring

Um de: forward, backward

colorstringpode ser null
archivedboolean
createdAtstring (date-time)
updatedAtstring (date-time)
urlstring (uri)
ObjetosProject (event payload)
{
  "id": "40be00e0-7e34-4f7a-864b-5cc986f575b8",
  "workspaceId": "824650d2-d0b3-4cac-8df8-5743ae9ff65a",
  "key": "WHX",
  "name": "Warehouse expansion",
  "description": null,
  "startDate": "2026-10-05",
  "deadline": null,
  "currency": "EUR",
  "scheduleFrom": "forward",
  "color": null,
  "archived": false,
  "createdAt": "2026-10-01T08:30:12.418Z",
  "updatedAt": "2026-10-01T08:30:12.418Z",
  "url": "https://planitude.app/app/projects/40be00e0-7e34-4f7a-864b-5cc986f575b8"
}

List webhook subscriptions

GET/api/webhooks

Chave com acesso de leitura

Parâmetros de consulta

CampoTipoDescrição
workspaceIdstring (uuid)
projectIdstring (uuid)

Retorna

200 OK Subscriptions

CampoTipoDescrição
webhooksarray of Webhook
Requisição
curl https://planitude.app/api/webhooks \
  -H "Authorization: Bearer $PLANITUDE_API_KEY"
Resposta200 OK
{
  "webhooks": [
    {
      "id": "1747ee7f-a395-4d3c-94b0-54b513d71d88",
      "workspaceId": "824650d2-d0b3-4cac-8df8-5743ae9ff65a",
      "workspaceName": "Acme Construction",
      "projectId": "40be00e0-7e34-4f7a-864b-5cc986f575b8",
      "projectName": "Warehouse expansion",
      "name": "Warehouse sync",
      "url": "https://example.com/hooks/planitude",
      "events": [
        "task.created",
        "task.completed"
      ],
      "secretPrefix": "whsec_Fdwl",
      "active": true,
      "disabledReason": null,
      "disabledAt": null,
      "consecutiveFailures": 0,
      "viaApi": true,
      "createdBy": {
        "id": "b1666432-132a-4ea9-b1ae-76ea69e226c5",
        "name": "Anna Rossi"
      },
      "createdAt": "2026-10-01T08:30:12.418Z",
      "updatedAt": "2026-10-01T08:30:12.418Z",
      "lastDeliveryAt": "2026-10-01T08:30:12.418Z",
      "lastSuccessAt": "2026-10-01T08:30:12.418Z"
    }
  ]
}

Subscribe (REST hook)

POST/api/webhooks

Chave com acesso de escrita

Creates a subscription. The response contains the signing secret: it is shown only once. Aliases accepted for automation platforms: targetUrl for url, event for a single event.

Corpo da requisição

CampoTipoDescrição
url
obrigatório
string (uri)HTTPS endpoint that receives the events. Public addresses only.
events
obrigatório
array of string* = all events.

Um de: project.created, project.updated, project.deleted, task.created, task.updated, task.deleted, task.completed, task.dates_changed, dependency.created, dependency.deleted, baseline.saved, member.invited, member.joined, comment.created, *

namestring
projectIdstring (uuid)Limit to one project (editor role needed). Omit for the whole workspace (owner/admin).
workspaceIdstring (uuid)

Retorna

201 Created Created

CampoTipoDescrição
webhookWebhook
secretstringwhsec_...
Requisição
curl -X POST https://planitude.app/api/webhooks \
  -H "Authorization: Bearer $PLANITUDE_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
  "url": "https://example.com/hooks/planitude",
  "events": [
    "task.created",
    "task.completed"
  ],
  "projectId": "40be00e0-7e34-4f7a-864b-5cc986f575b8"
}'
Resposta201 Created
{
  "webhook": {
    "id": "1747ee7f-a395-4d3c-94b0-54b513d71d88",
    "workspaceId": "824650d2-d0b3-4cac-8df8-5743ae9ff65a",
    "workspaceName": "Acme Construction",
    "projectId": "40be00e0-7e34-4f7a-864b-5cc986f575b8",
    "projectName": "Warehouse expansion",
    "name": "Warehouse sync",
    "url": "https://example.com/hooks/planitude",
    "events": [
      "task.created",
      "task.completed"
    ],
    "secretPrefix": "whsec_Fdwl",
    "active": true,
    "disabledReason": null,
    "disabledAt": null,
    "consecutiveFailures": 0,
    "viaApi": true,
    "createdBy": {
      "id": "b1666432-132a-4ea9-b1ae-76ea69e226c5",
      "name": "Anna Rossi"
    },
    "createdAt": "2026-10-01T08:30:12.418Z",
    "updatedAt": "2026-10-01T08:30:12.418Z",
    "lastDeliveryAt": "2026-10-01T08:30:12.418Z",
    "lastSuccessAt": "2026-10-01T08:30:12.418Z"
  },
  "secret": "whsec_3dvU0T1oaYlW4kH6m2Vb8nqXcR9eZpLsYw1QhGk"
}

Event catalog (public)

GET/api/webhooks/events

Público, sem chave

Retorna

200 OK Events

CampoTipoDescrição
apiVersionstring
eventsarray of string
Requisição
curl https://planitude.app/api/webhooks/events
Resposta200 OK
{
  "apiVersion": "2026-10-01",
  "events": [
    "project.created",
    "project.updated",
    "project.deleted",
    "task.created",
    "task.updated",
    "task.deleted",
    "task.completed",
    "task.dates_changed",
    "dependency.created",
    "dependency.deleted",
    "baseline.saved",
    "member.invited",
    "member.joined",
    "comment.created"
  ]
}

Get a subscription

GET/api/webhooks/{webhookId}

Chave com acesso de leitura

Parâmetros de caminho

CampoTipoDescrição
webhookId
obrigatório
string (uuid)Webhook id.

Retorna

200 OK Subscription

CampoTipoDescrição
webhookWebhook
Requisição
curl https://planitude.app/api/webhooks/1747ee7f-a395-4d3c-94b0-54b513d71d88 \
  -H "Authorization: Bearer $PLANITUDE_API_KEY"
Resposta200 OK
{
  "webhook": {
    "id": "1747ee7f-a395-4d3c-94b0-54b513d71d88",
    "workspaceId": "824650d2-d0b3-4cac-8df8-5743ae9ff65a",
    "workspaceName": "Acme Construction",
    "projectId": "40be00e0-7e34-4f7a-864b-5cc986f575b8",
    "projectName": "Warehouse expansion",
    "name": "Warehouse sync",
    "url": "https://example.com/hooks/planitude",
    "events": [
      "task.created",
      "task.completed"
    ],
    "secretPrefix": "whsec_Fdwl",
    "active": true,
    "disabledReason": null,
    "disabledAt": null,
    "consecutiveFailures": 0,
    "viaApi": true,
    "createdBy": {
      "id": "b1666432-132a-4ea9-b1ae-76ea69e226c5",
      "name": "Anna Rossi"
    },
    "createdAt": "2026-10-01T08:30:12.418Z",
    "updatedAt": "2026-10-01T08:30:12.418Z",
    "lastDeliveryAt": "2026-10-01T08:30:12.418Z",
    "lastSuccessAt": "2026-10-01T08:30:12.418Z"
  }
}

Update, pause or resume a subscription

PATCH/api/webhooks/{webhookId}

Chave com acesso de escrita

Parâmetros de caminho

CampoTipoDescrição
webhookId
obrigatório
string (uuid)Webhook id.

Corpo da requisição

CampoTipoDescrição
namestring
urlstring (uri)
eventsarray of string
activebooleanfalse = pause; true = resume (also resets the failure counter).

Retorna

200 OK Updated

CampoTipoDescrição
webhookWebhook
Requisição
curl -X PATCH https://planitude.app/api/webhooks/1747ee7f-a395-4d3c-94b0-54b513d71d88 \
  -H "Authorization: Bearer $PLANITUDE_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"active":false}'
Resposta200 OK
{
  "webhook": {
    "id": "1747ee7f-a395-4d3c-94b0-54b513d71d88",
    "workspaceId": "824650d2-d0b3-4cac-8df8-5743ae9ff65a",
    "workspaceName": "Acme Construction",
    "projectId": "40be00e0-7e34-4f7a-864b-5cc986f575b8",
    "projectName": "Warehouse expansion",
    "name": "Warehouse sync",
    "url": "https://example.com/hooks/planitude",
    "events": [
      "task.created",
      "task.completed"
    ],
    "secretPrefix": "whsec_Fdwl",
    "active": true,
    "disabledReason": null,
    "disabledAt": null,
    "consecutiveFailures": 0,
    "viaApi": true,
    "createdBy": {
      "id": "b1666432-132a-4ea9-b1ae-76ea69e226c5",
      "name": "Anna Rossi"
    },
    "createdAt": "2026-10-01T08:30:12.418Z",
    "updatedAt": "2026-10-01T08:30:12.418Z",
    "lastDeliveryAt": "2026-10-01T08:30:12.418Z",
    "lastSuccessAt": "2026-10-01T08:30:12.418Z"
  }
}

Unsubscribe (REST hook)

DEL/api/webhooks/{webhookId}

Chave com acesso de escrita

Parâmetros de caminho

CampoTipoDescrição
webhookId
obrigatório
string (uuid)Webhook id.

Retorna

204 No Content Deleted

Requisição
curl -X DELETE https://planitude.app/api/webhooks/1747ee7f-a395-4d3c-94b0-54b513d71d88 \
  -H "Authorization: Bearer $PLANITUDE_API_KEY"

Delivery log (newest first, kept 30 days)

GET/api/webhooks/{webhookId}/deliveries

Chave com acesso de leitura

Parâmetros de caminho

CampoTipoDescrição
webhookId
obrigatório
string (uuid)Webhook id.

Parâmetros de consulta

CampoTipoDescrição
limitinteger1-100.

Padrão: 50

beforestring (date-time)nextCursor of the previous page.

Retorna

200 OK Deliveries

CampoTipoDescrição
deliveriesarray of Delivery
nextCursorstringpode ser null
Requisição
curl https://planitude.app/api/webhooks/1747ee7f-a395-4d3c-94b0-54b513d71d88/deliveries \
  -H "Authorization: Bearer $PLANITUDE_API_KEY"
Resposta200 OK
{
  "deliveries": [
    {
      "id": "4b207161-80f9-40bb-bc3f-d8f70315be00",
      "eventId": "6f1c1d1e-2f4b-4d0a-9a77-2a3c5b1e9f10",
      "eventType": "task.completed",
      "status": "success",
      "attempts": 1,
      "nextAttemptAt": null,
      "lastAttemptAt": "2026-10-01T08:30:12.418Z",
      "responseStatus": 200,
      "responseExcerpt": "{\"ok\":true}",
      "error": null,
      "durationMs": 39,
      "manual": false,
      "createdAt": "2026-10-01T08:30:12.418Z"
    }
  ],
  "nextCursor": null
}

Body sent with a delivery

GET/api/webhooks/{webhookId}/deliveries/{deliveryId}

Chave com acesso de leitura

Parâmetros de caminho

CampoTipoDescrição
webhookId
obrigatório
string (uuid)Webhook id.
deliveryId
obrigatório
string (uuid)

Retorna

200 OK Payload

CampoTipoDescrição
payloadEvent
Requisição
curl https://planitude.app/api/webhooks/1747ee7f-a395-4d3c-94b0-54b513d71d88/deliveries/4b207161-80f9-40bb-bc3f-d8f70315be00 \
  -H "Authorization: Bearer $PLANITUDE_API_KEY"
Resposta200 OK
{
  "payload": {
    "id": "6f1c1d1e-2f4b-4d0a-9a77-2a3c5b1e9f10",
    "type": "project.created",
    "apiVersion": "2026-10-01",
    "createdAt": "2026-10-01T08:30:12.418Z",
    "workspaceId": "824650d2-d0b3-4cac-8df8-5743ae9ff65a",
    "projectId": "40be00e0-7e34-4f7a-864b-5cc986f575b8",
    "actor": {
      "id": "b1666432-132a-4ea9-b1ae-76ea69e226c5",
      "name": "Anna Rossi"
    },
    "data": {}
  }
}

Send the same event again

POST/api/webhooks/{webhookId}/deliveries/{deliveryId}/redeliver

Chave com acesso de escrita

Parâmetros de caminho

CampoTipoDescrição
webhookId
obrigatório
string (uuid)Webhook id.
deliveryId
obrigatório
string (uuid)

Retorna

202 Accepted Queued

CampoTipoDescrição
deliveryDelivery
Requisição
curl -X POST https://planitude.app/api/webhooks/1747ee7f-a395-4d3c-94b0-54b513d71d88/deliveries/4b207161-80f9-40bb-bc3f-d8f70315be00/redeliver \
  -H "Authorization: Bearer $PLANITUDE_API_KEY"
Resposta202 Accepted
{
  "delivery": {
    "id": "4b207161-80f9-40bb-bc3f-d8f70315be00",
    "eventId": "6f1c1d1e-2f4b-4d0a-9a77-2a3c5b1e9f10",
    "eventType": "task.completed",
    "status": "success",
    "attempts": 1,
    "nextAttemptAt": null,
    "lastAttemptAt": "2026-10-01T08:30:12.418Z",
    "responseStatus": 200,
    "responseExcerpt": "{\"ok\":true}",
    "error": null,
    "durationMs": 39,
    "manual": false,
    "createdAt": "2026-10-01T08:30:12.418Z"
  }
}

Send a webhook.ping test event

POST/api/webhooks/{webhookId}/test

Chave com acesso de escrita

Parâmetros de caminho

CampoTipoDescrição
webhookId
obrigatório
string (uuid)Webhook id.

Retorna

202 Accepted Queued

CampoTipoDescrição
deliveryDelivery
Requisição
curl -X POST https://planitude.app/api/webhooks/1747ee7f-a395-4d3c-94b0-54b513d71d88/test \
  -H "Authorization: Bearer $PLANITUDE_API_KEY"
Resposta202 Accepted
{
  "delivery": {
    "id": "4b207161-80f9-40bb-bc3f-d8f70315be00",
    "eventId": "6f1c1d1e-2f4b-4d0a-9a77-2a3c5b1e9f10",
    "eventType": "task.completed",
    "status": "success",
    "attempts": 1,
    "nextAttemptAt": null,
    "lastAttemptAt": "2026-10-01T08:30:12.418Z",
    "responseStatus": 200,
    "responseExcerpt": "{\"ok\":true}",
    "error": null,
    "durationMs": 39,
    "manual": false,
    "createdAt": "2026-10-01T08:30:12.418Z"
  }
}

Generate a new signing secret

POST/api/webhooks/{webhookId}/rotate-secret

Chave com acesso de escrita

Parâmetros de caminho

CampoTipoDescrição
webhookId
obrigatório
string (uuid)Webhook id.

Retorna

200 OK New secret (shown once)

CampoTipoDescrição
webhookWebhook
secretstring
Requisição
curl -X POST https://planitude.app/api/webhooks/1747ee7f-a395-4d3c-94b0-54b513d71d88/rotate-secret \
  -H "Authorization: Bearer $PLANITUDE_API_KEY"
Resposta200 OK
{
  "webhook": {
    "id": "1747ee7f-a395-4d3c-94b0-54b513d71d88",
    "workspaceId": "824650d2-d0b3-4cac-8df8-5743ae9ff65a",
    "workspaceName": "Acme Construction",
    "projectId": "40be00e0-7e34-4f7a-864b-5cc986f575b8",
    "projectName": "Warehouse expansion",
    "name": "Warehouse sync",
    "url": "https://example.com/hooks/planitude",
    "events": [
      "task.created",
      "task.completed"
    ],
    "secretPrefix": "whsec_Fdwl",
    "active": true,
    "disabledReason": null,
    "disabledAt": null,
    "consecutiveFailures": 0,
    "viaApi": true,
    "createdBy": {
      "id": "b1666432-132a-4ea9-b1ae-76ea69e226c5",
      "name": "Anna Rossi"
    },
    "createdAt": "2026-10-01T08:30:12.418Z",
    "updatedAt": "2026-10-01T08:30:12.418Z",
    "lastDeliveryAt": "2026-10-01T08:30:12.418Z",
    "lastSuccessAt": "2026-10-01T08:30:12.418Z"
  },
  "secret": "whsec_3dvU0T1oaYlW4kH6m2Vb8nqXcR9eZpLsYw1QhGk"
}

Webhooks

Webhooks

Os webhooks enviam um POST HTTPS com corpo JSON ao seu endpoint assim que algo muda, venha a mudança do app web, da API, do servidor MCP ou de uma importação. Um webhook cobre um projeto, ou todos os projetos de um workspace (proprietários e administradores).

Crie-os em Perfil → Webhooks ou pela API, como REST hooks: inscrição com POST /api/webhooks, cancelamento com DELETE. O segredo de assinatura é mostrado uma única vez.

Cada requisição traz estes cabeçalhos:

CabeçalhoDescrição
Planitude-Signaturet=<unix seconds>,v1=<hex HMAC-SHA256>: see Verify signatures.
Planitude-EventEvent type, e.g. task.completed.
Planitude-Event-IdEvent id, the same in every retry: use it to deduplicate.
Planitude-DeliveryId of this delivery (changes with a manual resend).
User-AgentPlanitude-Webhooks/1.0 (+https://planitude.app/developers)
Content-Typeapplication/json
Requisição
curl -X POST https://planitude.app/api/webhooks \
  -H "Authorization: Bearer $PLANITUDE_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
  "url": "https://example.com/hooks/planitude",
  "events": [
    "task.created",
    "task.completed"
  ],
  "projectId": "40be00e0-7e34-4f7a-864b-5cc986f575b8"
}'
Resposta201 Created
{
  "webhook": {
    "id": "1747ee7f-a395-4d3c-94b0-54b513d71d88",
    "workspaceId": "824650d2-d0b3-4cac-8df8-5743ae9ff65a",
    "workspaceName": "Acme Construction",
    "projectId": "40be00e0-7e34-4f7a-864b-5cc986f575b8",
    "projectName": "Warehouse expansion",
    "name": "Warehouse sync",
    "url": "https://example.com/hooks/planitude",
    "events": [
      "task.created",
      "task.completed"
    ],
    "secretPrefix": "whsec_Fdwl",
    "active": true,
    "disabledReason": null,
    "disabledAt": null,
    "consecutiveFailures": 0,
    "viaApi": true,
    "createdBy": {
      "id": "b1666432-132a-4ea9-b1ae-76ea69e226c5",
      "name": "Anna Rossi"
    },
    "createdAt": "2026-10-01T08:30:12.418Z",
    "updatedAt": "2026-10-01T08:30:12.418Z",
    "lastDeliveryAt": "2026-10-01T08:30:12.418Z",
    "lastSuccessAt": "2026-10-01T08:30:12.418Z"
  },
  "secret": "whsec_3dvU0T1oaYlW4kH6m2Vb8nqXcR9eZpLsYw1QhGk"
}

Tipos de evento

Inscreva-se em eventos específicos, ou em * para receber todos. Todos os eventos têm o mesmo envelope; data muda conforme o tipo.

EventoDescrição
project.createdA project was created (blank, from a template, duplicated or imported from MS Project).
project.updatedProject fields changed (name, dates, deadline, archive...), or a saved version was restored.
project.deletedA project was deleted.
task.createdA task was created.
task.updatedTask fields or assignees changed. changes lists only the fields that changed.
task.deletedA task was deleted (one event per task of a deleted branch).
task.completedTask progress reached 100%.
task.dates_changedStart or finish moved, because of an edit (cause: edit) or because the schedule was recalculated (cause: reschedule).
dependency.createdA dependency was created or changed.
dependency.deletedA dependency was removed.
baseline.savedA baseline was saved.
member.invitedAn invite link was created for the project.
member.joinedA person joined the project.
comment.createdA comment was added to a task.
Payload de exemplo
{
  "id": "6f1c1d1e-2f4b-4d0a-9a77-2a3c5b1e9f10",
  "type": "project.created",
  "apiVersion": "2026-10-01",
  "createdAt": "2026-10-01T08:30:12.418Z",
  "workspaceId": "824650d2-d0b3-4cac-8df8-5743ae9ff65a",
  "projectId": "40be00e0-7e34-4f7a-864b-5cc986f575b8",
  "actor": {
    "id": "b1666432-132a-4ea9-b1ae-76ea69e226c5",
    "name": "Anna Rossi"
  },
  "data": {
    "project": {
      "id": "40be00e0-7e34-4f7a-864b-5cc986f575b8",
      "workspaceId": "824650d2-d0b3-4cac-8df8-5743ae9ff65a",
      "key": "WHX",
      "name": "Warehouse expansion",
      "description": null,
      "startDate": "2026-10-05",
      "deadline": null,
      "currency": "EUR",
      "scheduleFrom": "forward",
      "color": null,
      "archived": false,
      "createdAt": "2026-10-01T08:30:12.418Z",
      "updatedAt": "2026-10-01T08:30:12.418Z",
      "url": "https://planitude.app/app/projects/40be00e0-7e34-4f7a-864b-5cc986f575b8"
    },
    "source": "blank"
  }
}

Verificar assinaturas

Cada requisição é assinada com HMAC-SHA256 e o segredo do seu webhook. O cabeçalho Planitude-Signature contém um timestamp t e a assinatura v1, calculada sobre t, um ponto e o corpo bruto.

  1. Use o corpo bruto, antes de qualquer parsing JSON: um corpo reserializado tem outra assinatura.
  2. Calcule o HMAC e compare em tempo constante.
  3. Rejeite requisições cujo timestamp se afaste mais de 5 minutos do seu relógio: uma requisição interceptada não pode ser reproduzida.
  4. Faça a rotação do segredo quando quiser: o antigo para de funcionar na hora.
Verify
import { createHmac, timingSafeEqual } from "node:crypto";

// rawBody: the request body as a string, before JSON.parse
export function verifyPlanitude(rawBody, header, secret, toleranceSec = 300) {
  const parts = Object.fromEntries(header.split(",").map((p) => p.split("=")));
  const t = Number(parts.t);
  if (!t || Math.abs(Date.now() / 1000 - t) > toleranceSec) return false; // replay
  const expected = createHmac("sha256", secret).update(`${t}.${rawBody}`).digest();
  const given = Buffer.from(parts.v1 ?? "", "hex");
  return given.length === expected.length && timingSafeEqual(given, expected);
}

// Express: app.post("/hooks/planitude", express.raw({ type: "application/json" }), (req, res) => {
//   if (!verifyPlanitude(req.body.toString("utf8"), req.get("Planitude-Signature"), process.env.PLANITUDE_WEBHOOK_SECRET)) return res.sendStatus(400);
//   res.sendStatus(200); // then process the event in a queue
// });

Novas tentativas e entrega

Responda com qualquer 2xx em até 10 segundos e faça o trabalho real depois, em uma fila. Redirecionamentos não são seguidos. Em erros e timeouts o Planitude tenta até 6 vezes no total: na hora e depois após 1 min, 5 min, 30 min, 2 h, 12 h.

A entrega é pelo menos uma vez e sem ordem garantida. Armazene o id do evento (Planitude-Event-Id, também id no corpo) e ignore os já processados; ordene por createdAt.

Depois de 5 eventos seguidos que falham em todas as tentativas, o webhook é desativado e o proprietário recebe um e-mail. Uma resposta 410 Gone o desativa na hora. Reative-o pelo perfil, ou com PATCH e active: true.

O registro de entregas (status, código HTTP, trecho da resposta, payload, reenvio manual) é mantido por 30 dias. Só endereços públicos são aceitos como destino.

Calendário de tentativas6 × POST
Tentativa 1   imediatamente
Tentativa 2   + 1 min
Tentativa 3   + 5 min
Tentativa 4   + 30 min
Tentativa 5   + 2 h
Tentativa 6   + 12 h

Teste seu endpoint

  1. Envie um evento webhook.ping com o endpoint de teste, ou com o botão Testar no perfil.
  2. Para receber eventos no seu computador, exponha o servidor local com um túnel (por exemplo ngrok ou Cloudflare Tunnel) e inscreva o endereço HTTPS público dele.
  3. Abra o registro de entregas para ver status, código HTTP e resposta, e reenvie uma entrega depois de corrigir o endpoint.
Requisição
curl -X POST https://planitude.app/api/webhooks/1747ee7f-a395-4d3c-94b0-54b513d71d88/test \
  -H "Authorization: Bearer $PLANITUDE_API_KEY"
Resposta202 Accepted
{
  "delivery": {
    "id": "4b207161-80f9-40bb-bc3f-d8f70315be00",
    "eventId": "6f1c1d1e-2f4b-4d0a-9a77-2a3c5b1e9f10",
    "eventType": "task.completed",
    "status": "success",
    "attempts": 1,
    "nextAttemptAt": null,
    "lastAttemptAt": "2026-10-01T08:30:12.418Z",
    "responseStatus": 200,
    "responseExcerpt": "{\"ok\":true}",
    "error": null,
    "durationMs": 39,
    "manual": false,
    "createdAt": "2026-10-01T08:30:12.418Z"
  }
}

IA e MCP

Servidor MCP

O Planitude é um servidor MCP (Model Context Protocol): assistentes de IA e editores de código leem projetos, analisam o caminho crítico e a carga de trabalho, e criam ou alteram tarefas, com suas permissões. Apps web se conectam com OAuth (você entra e permite o acesso); ferramentas de linha de comando e editores usam uma chave API.

URL do servidor

https://planitude.app/mcp

  • ChatGPTOAuth

    No ChatGPT abra Configurações › Segurança e login e ative o Modo desenvolvedor. Crie um app com a URL do servidor e autenticação OAuth, depois entre no Planitude e permita o acesso.

    Documentação oficial ↗
  • ClaudeOAuth

    Abra Personalizar › Conectores › Adicionar conector personalizado, cole a URL do servidor e escolha Conectar: o Planitude abre, você entra e permite o acesso. Funciona no claude.ai, no Claude Desktop e no app móvel.

    Documentação oficial ↗
  • GeminiOAuth

    Em gemini.google.com abra Configurações › Apps conectados, escolha Adicionar um app personalizado e cole a URL do servidor; depois entre no Planitude e permita o acesso.

    Documentação oficial ↗
  • Claude CodeChave API

    Execute o comando com a chave em uma variável de ambiente. Adicione --scope user para usá-lo em todos os projetos e confira com claude mcp list.

    Documentação oficial ↗
  • CodexChave API

    Coloque a chave em PLANITUDE_API_KEY e adicione o bloco a ~/.codex/config.toml: vale para a CLI, o app e a extensão do IDE.

    Documentação oficial ↗
  • CursorChave API

    Adicione o bloco a ~/.cursor/mcp.json (todos os projetos) ou .cursor/mcp.json (um projeto); o Cursor lê a chave do ambiente.

    Documentação oficial ↗
  • Adicione .vscode/mcp.json ao workspace: o VS Code pede a chave uma vez e a guarda com segurança, fora do arquivo.

    Documentação oficial ↗
  • Gemini CLIChave API

    Execute o comando com a chave em uma variável de ambiente, ou adicione o bloco a ~/.gemini/settings.json.

    Documentação oficial ↗

Ferramentas

O servidor oferece 29 ferramentas, da leitura e análise a mudanças seguras. Nenhuma exclui projetos ou tarefas.

read

  • planitude_list_projects
  • planitude_portfolio_overview
  • planitude_get_project
  • planitude_critical_path
  • planitude_delay_impact
  • planitude_monte_carlo
  • planitude_workload
  • planitude_list_baselines
  • planitude_list_versions
  • planitude_list_templates
  • planitude_list_comments
  • planitude_preview_import

write

  • planitude_create_project
  • planitude_create_project_from_template
  • planitude_create_project_from_plan
  • planitude_import_file
  • planitude_edit_project
  • planitude_add_task
  • planitude_update_task
  • planitude_set_progress
  • planitude_indent_task
  • planitude_outdent_task
  • planitude_link_tasks
  • planitude_unlink_tasks
  • planitude_reschedule
  • planitude_configure_simulation
  • planitude_add_comment
  • planitude_save_baseline
  • planitude_save_version
MCP

Server URL

https://planitude.app/mcp

Agentes de IA

Adicione até 5 agentes de IA externos ao workspace como membros: Claude Code, Cursor, Codex, Gemini CLI, GitHub Copilot ou qualquer cliente MCP. Atribua tarefas, mencione-os em comentários e revise as alterações deles.

Owners e admins criam as chaves de agente em Agentes, aba Conexão. A chave começa com pln_, aparece uma única vez e é guardada como hash; cada agente tem até 2 chaves, e revogar uma vale na hora.

As chaves de agente funcionam só com o servidor MCP, que mostra as ferramentas para agentes no lugar das habituais. Na API REST recebem 403 agent_credential.

Cada chave lê e comenta ou pode editar. Assumir, concluir e propor alterações exige uma chave que pode editar; caso contrário, a resposta é 403 agent_key_read_only.

Um agente só vê os projetos em que foi adicionado, como viewer (lê e comenta) ou editor (também altera tarefas), nunca como owner. O projeto também precisa de “Permitir agentes neste projeto”: vem desligado e quem liga é o owner.

Os agentes podem mudar nome, notas, duração, progresso e prazo de uma tarefa, ou criar tarefas. Nenhuma ferramenta exclui, convida pessoas ou muda funções.

Limites padrão por agente: 60 requisições por minuto e 200 gravações por dia, ajustáveis até 240 e 2.000. No máximo 200 alterações por projeto podem aguardar revisão.

As ferramentas de leitura colocam o texto escrito por pessoas (nomes, notas, comentários) em blocos planitude-data com um nonce aleatório, como strings JSON, e marcam como SUSPICIOUS as linhas apontadas por uma verificação automática: são dados, nunca instruções. Comentários lidos com uma chave pessoal vêm nos mesmos blocos.

Como funcionam os agentes de IA no Planitude
MCPClaude Code
claude mcp add --transport http planitude https://planitude.app/mcp \
  --header "Authorization: Bearer $PLANITUDE_AGENT_KEY"

Ferramentas para agentes

Com uma chave de agente, o servidor MCP expõe estas 16 ferramentas:

read

  • planitude_list_my_projects
  • planitude_list_tasks
  • planitude_read_comments
  • planitude_list_my_proposals

propose

  • planitude_add_comment
  • planitude_propose_task_update
  • planitude_propose_status
  • planitude_propose_task_create

events

  • planitude_poll_events
  • planitude_ack_events

runs

  • planitude_list_my_runs
  • planitude_claim_task
  • planitude_extend_lease
  • planitude_complete_task
  • planitude_fail_task
  • planitude_release_task

Durante uma execução Autônomo, as alterações do agente nas próprias tarefas valem na hora e ficam no histórico, prontas para restaurar. Nos outros casos, e no modo Com aprovação, aguardam em “Aguardando revisão” até alguém do projeto aplicá-las.

Sem webhook, o agente lê seus eventos com planitude_poll_events (até 50 por vez) e os confirma com planitude_ack_events.

Requisiçãotools/call
{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "tools/call",
  "params": {
    "name": "planitude_claim_task",
    "arguments": {
      "projectId": "40be00e0-7e34-4f7a-864b-5cc986f575b8",
      "task": "4dbd104a-00cd-4035-8955-255f52ea586a",
      "leaseMinutes": 30
    }
  }
}

Webhook de execução

Para um agente começar sozinho, ligue a execução em Agentes, aba Execução, e informe o webhook do seu runner: o Planitude envia um POST assinado quando o agente tem uma tarefa para executar. O segredo começa com whsec_ e aparece uma única vez. A URL deve ser um endereço HTTPS público: privados e locais são recusados.

Assinatura, cabeçalhos, tempo limite de 10 segundos e novas tentativas (1 min, 5 min, 30 min, 2 h, 12 h) funcionam como nos outros webhooks. Após 5 entregas com falha seguidas o webhook é desligado: salve a URL de novo para religá-lo.

O aviso traz só ids, nunca o texto da tarefa: o agente lê a tarefa via MCP.

EventoDescrição
task.assignedOnly with the “on assignment” trigger: a person assigned the task to the agent. Once per assignment.
task.start_dueDefault trigger: the task’s start date has come (a working day of its calendar).
task.due_todayThe task is due today (deadline or planned finish). Opens a run only if the task never had one.
task.overdueThe task is past its due date, once per due date. Opens a run only if the task never had one.
run.retryThe lease expired without completion, or a person chose Rerun: a new attempt is queued.
run.cancelA run in progress was cancelled (by a person, an emergency stop or the rules): stop working on it.
webhook.pingSent by “Send test event” in the agent’s Execution tab.

Um aviso com newRun: true abre uma execução. O agente a assume com planitude_claim_task e mantém um lease de 30 minutos (de 5 a 240), renovado com planitude_extend_lease. Se o lease expira, começa uma nova tentativa, até 3 (no máximo 10). Uma execução que ninguém assume expira após 24 horas.

planitude_complete_task leva a tarefa a 100% e publica o relatório como comentário; com subtarefas abertas responde 409 subtasks_open. planitude_fail_task registra o motivo e avisa a equipe, que pode executá-la de novo; planitude_release_task devolve a tarefa sem novas tentativas.

Cada execução permite 50 alterações (até 500, depois 429) e cada agente 5 execuções abertas (depois 409 too_many_open_runs). Autônomo, o modo padrão, aplica as alterações na hora e permite restaurá-las; Com aprovação as envia para revisão. Uma parada de emergência, por projeto ou para todo o workspace, cancela as execuções abertas e bloqueia gravações.

Payload de exemplotask.start_due
{
  "id": "6f1c1d1e-2f4b-4d0a-9a77-2a3c5b1e9f10",
  "type": "task.start_due",
  "apiVersion": "2026-10-01",
  "createdAt": "2026-10-14T07:00:00.000Z",
  "workspaceId": "824650d2-d0b3-4cac-8df8-5743ae9ff65a",
  "projectId": "40be00e0-7e34-4f7a-864b-5cc986f575b8",
  "actor": null,
  "data": {
    "agentId": "b4d17e2c-93a8-4c6f-8e15-6a0f2d9c7b31",
    "taskId": "4dbd104a-00cd-4035-8955-255f52ea586a",
    "runId": "7c3e2a91-5d4b-4f08-b6e1-2f9a0c8d4e57",
    "newRun": true,
    "attempt": 1,
    "leaseMinutes": 30,
    "writeMode": "autonomous",
    "day": "2026-10-14",
    "links": {
      "mcp": "https://planitude.app/mcp",
      "app": "https://planitude.app/app/projects/40be00e0-7e34-4f7a-864b-5cc986f575b8?task=4dbd104a-00cd-4035-8955-255f52ea586a"
    }
  }
}

Escrever um runner

O runner é o seu pequeno serviço que recebe os avisos e inicia o agente. Qualquer linguagem serve; com Node 20+ não precisa de dependências.

  1. Verifique a assinatura no corpo bruto e responda 200 na hora: o Planitude espera no máximo 10 segundos.
  2. Ignore eventos já vistos (Planitude-Event-Id): as novas tentativas reenviam o mesmo evento.
  3. Com newRun: true, assuma a tarefa e inicie o agente, por exemplo claude -p com o servidor MCP do Planitude e a chave do agente.
  4. Renove o lease enquanto o agente trabalha; com run.cancel, pare-o.
  5. Peça ao agente para terminar com PLANITUDE: DONE só se a tarefa inteira estiver feita e então conclua com o relatório dele. Caso contrário (PLANITUDE: NOT DONE - … ou nenhuma linha final), marque como falha com o que falta.

Trate o texto da tarefa como dados: diga ao agente para nunca seguir instruções encontradas nele e permita só as ferramentas do Planitude de que ele precisa.

Runner
// after verifyPlanitude(rawBody, signature, secret) and dedupe on Planitude-Event-Id
res.sendStatus(200); // answer at once, work afterwards
const { type, projectId, data } = event;
if (type === "run.cancel") return stopAgent(data.runId);
if (!data.newRun) return;

await callTool("planitude_claim_task", { projectId, task: data.taskId, leaseMinutes: data.leaseMinutes });
const out = await runAgent(data); // renew with planitude_extend_lease while it works
if (out.lastLine === "PLANITUDE: DONE") {
  await callTool("planitude_complete_task", { runId: data.runId, report: out.report }); // task -> 100%
} else {
  await callTool("planitude_fail_task", { runId: data.runId, reason: out.whatIsLeft });
}

// callTool = JSON-RPC tools/call to the MCP URL
// with Authorization: Bearer <agent key>

Feed OData (Power BI, Excel)

Um feed OData v4 somente leitura para Power BI, Excel e qualquer cliente OData, em dois endereços: um projeto, ou todos os projetos que o titular da chave vê em um workspace.

  • https://planitude.app/api/odata/projects/40be00e0-7e34-4f7a-864b-5cc986f575b8
  • https://planitude.app/api/odata/workspaces/824650d2-d0b3-4cac-8df8-5743ae9ff65a

Autenticação com uma chave de API pessoal com acesso de leitura: Authorization: Bearer, ou HTTP Basic com a chave como senha (qualquer nome de usuário), que é o método oferecido pelo Power BI e pelo Excel. Tokens OAuth e cookies de sessão não são aceitos. Uma chave limitada a um workspace não consegue ler os outros.

Tabelas: Projects, Tasks, Milestones, Dependencies, Resources, Assignments. O esquema está em $metadata (CSDL XML) e o documento de serviço no endereço raiz.

Opções suportadas: $select, $filter (comparações, and/or/not, in, contains, startswith, endswith, tolower, toupper), $orderby, $top, $skip, $count e /$count. As páginas contêm 2.000 linhas por padrão, até 5.000 com Prefer: odata.maxpagesize; siga @odata.nextLink. As respostas trazem um ETag: envie If-None-Match para receber 304. $expand, $apply e $search não são suportados (400).

Um feed cobre no máximo 500 projetos e 25.000 tarefas (acima disso, 413). As requisições contam para o limite de leitura da chave, 240 por minuto.

Guia passo a passo para Power BI e Excel
RequisiçãocURL
curl "https://planitude.app/api/odata/projects/40be00e0-7e34-4f7a-864b-5cc986f575b8/Tasks?$select=Key,Name,Start,Finish,ProgressPct,IsCritical&$filter=IsCritical&$orderby=Start&$top=2&$count=true" \
  -u "powerbi:$PLANITUDE_API_KEY"

# schema (CSDL XML), for Power BI, Excel and any OData client
curl "https://planitude.app/api/odata/projects/40be00e0-7e34-4f7a-864b-5cc986f575b8/$metadata" -u "powerbi:$PLANITUDE_API_KEY"
Resposta200 OK
{
  "@odata.context": "https://planitude.app/api/odata/projects/40be00e0-7e34-4f7a-864b-5cc986f575b8/$metadata#Tasks(Key,Name,Start,Finish,ProgressPct,IsCritical)",
  "@odata.count": 3,
  "value": [
    {
      "Key": "WHX-2",
      "Name": "Foundations",
      "Start": "2026-10-05T07:00:00Z",
      "Finish": "2026-10-06T15:00:00Z",
      "ProgressPct": 100,
      "IsCritical": true
    },
    {
      "Key": "WHX-3",
      "Name": "Walls",
      "Start": "2026-10-07T07:00:00Z",
      "Finish": "2026-10-09T15:00:00Z",
      "ProgressPct": 50,
      "IsCritical": true
    }
  ]
}

Novidades

  1. Novo feed OData v4 somente leitura em /api/odata/projects/:projectId e /api/odata/workspaces/:workspaceId para Power BI, Excel e outros clientes OData: seis tabelas, $metadata, $select, $filter, $orderby, $top, $skip, $count, paginação no servidor e ETag.

  2. Novo endpoint GET /api/projects/:projectId/export: o plano em XML do Microsoft Project, CSV, imagem PNG ou PDF, com opções de escala, intervalo de datas, caminho crítico, linha de base, dependências, tamanho do papel e orientação.

  3. Todas as chaves de API agora começam com pln_. Chaves que começam com gnt_ não funcionam mais: crie uma nova.

  4. Agentes executam tarefas: webhook de execução assinado (task.assigned, task.start_due, task.due_today, task.overdue, run.retry, run.cancel), 6 ferramentas de execução com lease e um guia para escrever um runner.

  5. As ferramentas MCP de leitura envolvem o texto escrito por pessoas em blocos planitude-data com um nonce, como strings JSON com a marca SUSPICIOUS, para todo tipo de chave.

  6. Agentes de IA como membros do workspace: chaves de agente que funcionam só com o servidor MCP, 10 ferramentas para ler, comentar e propor alterações, e uma fila de eventos.

  7. Nova documentação para desenvolvedores, gerada a partir do documento OpenAPI. O documento OpenAPI agora descreve todos os campos retornados para membros, comentários, linhas de base, modelos e atribuições.

  8. Versão da API 2026-10-01: webhooks de saída assinados, API REST pública documentada (OpenAPI 3.1), paginação com cursor e busca por externalId.

  9. OAuth 2.1 para o servidor MCP e a API: ChatGPT, Claude e Gemini se conectam sem copiar uma chave.

  10. Servidor MCP e chaves API pessoais com acesso de leitura ou de leitura e escrita.

A publicidade mantém o Planitude gratuito