canonical: https://jentic.com/apis/coordinatehq.com/coordinatehq

# CoordinateHQ API

Jentic publishes the only available OpenAPI specification for CoordinateHQ API, keeping it validated and agent-ready. CoordinateHQ is a client-facing project management platform built around shared projects between a vendor and their external stakeholders. The 25 endpoints span projects, tasks, comments, groups, stakeholders, goals, organizations and webhooks, with operations to apply playbook templates to a project, look up a project by external object ID, and register webhooks for downstream sync. Authentication is API key based and tags partition the surface into clean resource groups for tasks and project hierarchy.

## For AI agents

Create and update client-facing projects and tasks in CoordinateHQ, apply playbook templates and register webhooks for project events.

## Scope

Does not handle billing, time tracking, or messaging - use for client-facing project, task and playbook orchestration only.

## Capabilities

- Create a client project from a playbook template and assign stakeholders
- Add tasks to a project, update their status and post comments on them
- List projects filtered by group, organization or stakeholder
- Resolve a CoordinateHQ project from your own system's external object ID
- Register and manage webhooks for project, task and goal events
- Track goals attached to a project and update their progress

## Use cases

### Client Onboarding Automation

When a new deal closes in the CRM, an automation can create a CoordinateHQ project with the customer organization attached, then apply a standard onboarding playbook to scaffold the task list. POST /projects creates the project, then POST `/projects/{project_id}/apply_playbook` seeds tasks and goals. The external_object_id field lets the CRM keep its own deal record linked to the CoordinateHQ project.

Example prompt: POST /projects with the customer name and external_object_id matching the CRM deal, then POST `/projects/{project_id}/apply_playbook` with the standard onboarding template ID.

### Task Status Sync to External Systems

Engineering and operations teams can mirror CoordinateHQ task status into their internal systems by registering a webhook for task events. The webhook payload includes the project ID and task ID, and a follow-up GET `/projects/{project_id}/task/{task_id}` returns the full state including assignee, due date and comments.

Example prompt: Register a webhook on /webhooks for the task.updated event and on receipt call GET `/projects/{project_id}/task/{task_id}` to fetch the new status.

### Goal-Driven Project Reporting

Customer success teams can pull every active project for a stakeholder organization, list each project's goals, and roll up completion percentages into a weekly report. The Goals tag exposes endpoints to read and update goal records attached to a project, supporting outcome-based reporting rather than raw task counts.

Example prompt: List projects for organization ID 'acme-corp', for each project fetch the goals, and compute the average goal completion percentage.

### AI Agent Project Assistant

An AI agent embedded in a CSM workflow can take instructions like 'create a project for the new Acme account using the onboarding playbook' and execute them against CoordinateHQ via Jentic. The agent uses the external_object_id field to maintain idempotency between CRM events and CoordinateHQ projects.

Example prompt: Use Jentic to call POST /projects creating an Acme onboarding project with external_object_id 'crm-deal-9921', then apply the onboarding playbook to it.

## Key endpoints

| Method | Path | Description |
| --- | --- | --- |
| POST | `/projects` | Create a new project |
| GET | `/projects` | List all projects |
| GET | `/projects/external_object_id/{external_object_id}` | Resolve a project by external system ID |
| POST | `/projects/{project_id}/apply_playbook` | Apply a playbook template to a project |
| POST | `/projects/{project_id}/task` | Create a task on a project |
| GET | `/projects/{project_id}/task` | List tasks on a project |
| POST | `/projects/{project_id}/task/{task_id}` | Update a task |

## Key resources

- **Projects** — CRUD on shared client projects plus playbook application and external ID lookup
- **Tasks** — Project-scoped task lifecycle including create, update, list and comment
- **Comments** — Comments attached to tasks for status notes and stakeholder threads
- **Goals** — Outcome goals attached to projects with progress tracking
- **Stakeholders** — External users participating in shared projects
- **Organizations** — Customer organizations grouping multiple stakeholders and projects
- **Groups** — Internal groupings of projects or stakeholders
- **Webhooks** — Event subscriptions for project, task and goal changes

## Why Jentic

- **Setup:** Wiring CoordinateHQ by hand means setting its X-API-KEY header and coding the project, task, and playbook calls yourself. Through Jentic you install once, import the CoordinateHQ API from the API Directory, store the key once, and your agent calls it.
- **Permission scoping:** CoordinateHQ puts the project id in the URL path (`/projects/{project_id}/apply_playbook`, `/projects/{project_id}/task`), so a rule can pin your agent to one project: it can apply playbooks and manage tasks there and nothing else. You choose the operations it may call, so creating new projects is not included unless you add it.
- **Credential handling:** Your CoordinateHQ API key is stored once, encrypted, by your own Jentic One instance and injected into the X-API-KEY header at execution time. It never enters the agent's prompt, logs, or context.
- **Discovery method:** Agents search Jentic by intent such as 'create a CoordinateHQ project from a playbook' or 'add a task to a project', and Jentic returns the matching operation with its input schema, including the external_object_id field for idempotent linking, so the agent calls the right endpoint without browsing the reference docs.

## Related APIs

- **Asana API** — General-purpose project management API with broader internal team feature set
- **ClickUp API** — Multi-purpose work platform with deeper customisation than CoordinateHQ
- **HubSpot CRM Objects API** — CRM source system that triggers CoordinateHQ project creation when deals close
- **Slack API** — Notify internal channels when CoordinateHQ webhooks fire on task or project events

## FAQ

### Why is there no official OpenAPI spec for CoordinateHQ API?

CoordinateHQ does not publish an OpenAPI specification. Jentic generates and maintains this spec so that AI agents and developers can call CoordinateHQ API via structured tooling. It is validated against the live API and kept up to date. Get started with Jentic One, the self-hosted execution layer.

### What authentication does the CoordinateHQ API use?

The API uses an API key, declared in the spec under the apiKeyAuth scheme. Through Jentic the API key sits in the credential vault and is attached to outbound requests at execution time, so the raw key never appears in agent context.

### Can I create a project from a playbook template with the CoordinateHQ API?

Yes. POST /projects creates the project, then POST `/projects/{project_id}/apply_playbook` attaches the chosen template, which seeds tasks and goals defined by that playbook.

### How do I link a CoordinateHQ project to my CRM deal?

Set the external_object_id on the project at creation time, then use GET `/projects/external_object_id/{external_object_id}` to look it up later. This keeps your CRM record and the CoordinateHQ project in sync without storing CoordinateHQ IDs separately.

### What rate limits apply to the CoordinateHQ API?

The OpenAPI spec does not declare formal rate limits. Use webhook subscriptions on /webhooks for state change notifications instead of polling, and back off on HTTP 429 responses.

### How do I update a task through Jentic with the CoordinateHQ API?

Run pip install jentic, search Jentic with 'update CoordinateHQ task', load the operation schema for POST `/projects/{project_id}/task/{task_id}` and execute with the new status and comment payload.

### Can I limit what my agent is allowed to do with the CoordinateHQ API?

Yes. Because you run Jentic One yourself, your own rules decide which CoordinateHQ operations and credentials the agent can use. Since CoordinateHQ carries the project id in the URL path, such as `/projects/{project_id}/apply_playbook` and `/projects/{project_id}/task`, you can pin the agent to a single project so it applies playbooks and manages tasks there and nothing else. You pick the exact operations it may call, so creating new projects stays off unless you add it.