Automation API for Zapier, Make and custom apps
Sign in with OAuth 2.0, then call JSON endpoints under https://app.vindaris.com/api/connectors/{connector} to create tasks, goals, projects and KPIs, update the ones your connection created, record KPI values, post comments and look up goals and projects.
Overview
The automation API takes data in. It creates objects in a Vindaris workspace and keeps them up to date from another tool. Each connection owns the objects it creates, and it can update or comment only on those. You match an object by your own externalId, so you never have to store Vindaris ids.
The {connector} path segment names the integration: zapier or make. Each connector keeps its own set of external ids, so the same id used from Zapier and from Make refers to two different objects.
Every call runs with the signed-in person's access. A workspace admin must turn on AI Tools under Admin, and can switch Zapier or Make off under Allowed Integrations. The person's permission groups decide what they may read and change.
Authentication
The API uses OAuth 2.0 authorization code flow.
- Authorization URL:
https://app.vindaris.com/api/mcp/authorize - Token URL:
https://app.vindaris.com/api/mcp/token - Scope:
mcp:readwrite - PKCE with S256 is supported. Redirect URIs must be registered and must match exactly.
- Access tokens do not expire. A person can revoke one at any time from Settings, AI Tools. There is no refresh token.
Send the token on every request:
Authorization: Bearer <access_token>
To register an OAuth client for your own app, contact support@vindaris.com.
Requests and responses
Requests and responses are JSON. A successful call returns HTTP 200 with:
{ "success": true, "data": { ... } }
A failed call returns an error status with a readable message:
{ "success": false, "error": "No task with external id \"crm-42\" that this connection created. Run the create step first, and pass the same external id." }
| Status | Meaning |
|---|---|
| 400 | A required field is missing or a value is invalid. |
| 401 | The token is missing, revoked or invalid. |
| 403 | AI Tools is off, the connector is switched off, or the person's permissions do not allow the action. |
| 404 | No object with that external id was created by this connection. |
| 409 | The external id is already used, or it belongs to a different object type. |
| 429 | Too many requests. Wait and retry. |
Endpoints
GET /me
Checks the connection. Returns the workspace and the signed-in person.
{ "success": true, "data": { "orgId": "...", "org": "acme", "user": "pat@acme.com", "connector": "MAKE", "connectionLabel": "acme (pat@acme.com)" } }
POST /tasks
Creates a task. The task shows the connector as its source.
| Field | Type | Required | Notes |
|---|---|---|---|
externalId | string | Yes | The id of the object in your source app. Use the same value on create and on every later update or comment. |
title | string | Yes | |
description | string | No | |
status | enum | No | TODO, IN_PROGRESS, BLOCKED, IN_REVIEW, DONE or ARCHIVED. |
priority | enum | No | LOW, MEDIUM, HIGH or URGENT. |
dueDate | date (YYYY-MM-DD or ISO 8601) | No | |
startDate | date | No | |
alignToType | enum | No | GOAL or PROJECT. |
alignToId | string | No | Vindaris id of the goal or project, from the search endpoints. |
externalUrl | string | No | Link back to the object in the source app. |
externalTool | string | No | Name of the source app, shown in Vindaris. |
{ "success": true, "data": { "id": "cmw...", "externalId": "crm-42" } }
POST /tasks/update
Updates a task this connection created. Status changes count as a work signal, like a Jira or Asana sync.
| Field | Type | Required | Notes |
|---|---|---|---|
externalId | string | Yes | The id of the object in your source app. Use the same value on create and on every later update or comment. |
status | enum | No | TODO, IN_PROGRESS, BLOCKED, IN_REVIEW, DONE or ARCHIVED. |
title | string | No | |
description | string | No | |
priority | enum | No | |
dueDate | date (YYYY-MM-DD or ISO 8601) | No | |
startDate | date | No |
POST /goals
Creates a goal.
| Field | Type | Required | Notes |
|---|---|---|---|
externalId | string | Yes | The id of the object in your source app. Use the same value on create and on every later update or comment. |
title | string | Yes | |
dueDate | date | Yes | |
description | string | No | |
status | enum | No | DRAFT, ACTIVE, COMPLETED or CANCELLED. |
type | enum | No | OKR, SMART, OGSM or CUSTOM. |
startDate | date | No | |
externalUrl | string | No | Link back to the object in the source app. |
externalTool | string | No | Name of the source app, shown in Vindaris. |
POST /goals/update
Updates a goal this connection created.
| Field | Type | Required | Notes |
|---|---|---|---|
externalId | string | Yes | The id of the object in your source app. Use the same value on create and on every later update or comment. |
title | string | No | |
description | string | No | |
status | enum | No | DRAFT, ACTIVE, COMPLETED or CANCELLED. |
startDate | date | No | |
dueDate | date (YYYY-MM-DD or ISO 8601) | No |
POST /projects
Creates a project.
| Field | Type | Required | Notes |
|---|---|---|---|
externalId | string | Yes | The id of the object in your source app. Use the same value on create and on every later update or comment. |
title | string | Yes | |
description | string | No | |
status | enum | No | DRAFT, ACTIVE, COMPLETED or CANCELLED. |
startDate | date | No | |
endDate | date | No | |
externalUrl | string | No | Link back to the object in the source app. |
externalTool | string | No | Name of the source app, shown in Vindaris. |
POST /projects/update
Updates a project this connection created.
| Field | Type | Required | Notes |
|---|---|---|---|
externalId | string | Yes | The id of the object in your source app. Use the same value on create and on every later update or comment. |
title | string | No | |
description | string | No | |
status | enum | No | DRAFT, ACTIVE, COMPLETED or CANCELLED. |
startDate | date | No | |
endDate | date | No |
POST /kpis
Creates a KPI.
| Field | Type | Required | Notes |
|---|---|---|---|
externalId | string | Yes | The id of the object in your source app. Use the same value on create and on every later update or comment. |
title | string | Yes | |
unit | string | No | For example %, EUR or users. |
startValue | number | No | |
targetValue | number | No | |
currentValue | number | No | |
startDate | date | No | |
dueDate | date (YYYY-MM-DD or ISO 8601) | No | |
externalUrl | string | No | Link back to the object in the source app. |
externalTool | string | No | Name of the source app, shown in Vindaris. |
POST /kpis/update
Updates a KPI this connection created. A currentValue is recorded as today's measurement.
| Field | Type | Required | Notes |
|---|---|---|---|
externalId | string | Yes | The id of the object in your source app. Use the same value on create and on every later update or comment. |
currentValue | number | No | |
targetValue | number | No | |
title | string | No | |
status | enum | No | DRAFT, ACTIVE, COMPLETED or CANCELLED. |
startDate | date | No | |
dueDate | date (YYYY-MM-DD or ISO 8601) | No |
POST /comments
Posts a comment on a task, goal, project or KPI this connection created.
| Field | Type | Required | Notes |
|---|---|---|---|
externalId | string | Yes | The id of the object in your source app. Use the same value on create and on every later update or comment. |
body | string | Yes | The comment text. |
{ "success": true, "data": { "id": "...", "entityType": "TASK", "entityId": "cmw..." } }
GET /search/goals
Finds active goals by name, for example to align a task. Returns up to 50 results the person may read.
| Field | Type | Required | Notes |
|---|---|---|---|
q | string (query) | No | Part of the goal name. |
{ "success": true, "data": [ { "id": "cmw...", "name": "Grow EU revenue" } ] }
GET /search/projects
Finds active projects by name. Returns up to 50 results the person may read.
| Field | Type | Required | Notes |
|---|---|---|---|
q | string (query) | No | Part of the project name. |
Example
curl -X POST https://app.vindaris.com/api/connectors/make/tasks \
-H "Authorization: Bearer $TOKEN" \
-H "Content-Type: application/json" \
-d '{"externalId":"crm-42","title":"Call back Acme","status":"TODO"}'
curl -X POST https://app.vindaris.com/api/connectors/make/tasks/update \
-H "Authorization: Bearer $TOKEN" \
-H "Content-Type: application/json" \
-d '{"externalId":"crm-42","status":"DONE"}'
Related
- Vindaris for Zapier
- Vindaris for Make
- Vindaris MCP server for AI assistants, with a REST API and OpenAPI spec
Put this into practice
Vindaris keeps strategy, goals, projects and tasks in one place, and the Work Graph flags execution risk before it costs you. Start free, no credit card.
Sign Up for Free