REST API endpoints and scopes

This page lists every endpoint in the Helpin REST API and the scope a token needs to call it. All paths are relative to the base URL, https://api.helpin.ai/public/v1 on Helpin Cloud. For request and response details of each endpoint, use the API reference or the OpenAPI file at https://api.helpin.ai/public/v1/openapi.json.

Scopes

A token can only use endpoints whose scope it was given. A workspace manager chooses the scopes when creating an automation account, within what the workspace policy allows.

Scope	Lets the token
`helpin.context.read`	Read workspace context: identity, teams, members, repositories, and search
`helpin.pm.read`	Read project work: tasks, epics, sprints, objectives, labels, and workflows
`helpin.pm.write`	Create and update project work
`helpin.docs.read`	Read documents, collections, and spaces
`helpin.docs.write`	Create and update documents, collections, and spaces
`helpin.docs.publish`	Publish and unpublish Help Center articles
`helpin.crm.read`	Read CRM records
`helpin.crm.write`	Add notes and update CRM records
`helpin.support.read`	Read support conversations
`helpin.support.write`	Assign, move, tag, and rename support conversations. It never sends replies to customers.
`helpin.agents.read`	Read agents and runs
`helpin.agents.run`	Start and cancel agent runs

A read-only account can only call endpoints that read data, even if it was given a write scope. Product areas that aren't enabled for the workspace, such as CRM or Support, return 403 forbidden.

Context

The authenticated identity, workspace directory, and cross-product search.

Method	Path	What it does	Scope
GET	`/me`	Get the authenticated identity and workspace	`helpin.context.read`
GET	`/members`	List workspace members	`helpin.context.read`
GET	`/repositories`	List connected repositories	`helpin.context.read`
GET	`/search`	Search the workspace	`helpin.context.read`
GET	`/teams`	List teams	`helpin.context.read`

Tasks

Tasks, comments, checklists, and workflow state.

Method	Path	What it does	Scope
GET	`/tasks`	List tasks	`helpin.pm.read`
POST	`/tasks`	Create a task	`helpin.pm.write`
POST	`/tasks/batch`	Create tasks in bulk under an epic	`helpin.pm.write`
GET	`/tasks/context`	Get task context	`helpin.pm.read`
GET	`/tasks/{task_id}`	Get a task	`helpin.pm.read`
PATCH	`/tasks/{task_id}`	Update a task	`helpin.pm.write`
POST	`/tasks/{task_id}/archive`	Archive a task	`helpin.pm.write`
GET	`/tasks/{task_id}/checklist`	List checklist items	`helpin.pm.read`
POST	`/tasks/{task_id}/checklist`	Add a checklist item	`helpin.pm.write`
PATCH	`/tasks/{task_id}/checklist/{checklist_item_id}`	Update a checklist item	`helpin.pm.write`
GET	`/tasks/{task_id}/comments`	List task comments	`helpin.pm.read`
POST	`/tasks/{task_id}/comments`	Add a task comment	`helpin.pm.write`
POST	`/tasks/{task_id}/restore`	Restore an archived task	`helpin.pm.write`
PUT	`/tasks/{task_id}/state`	Move a task to a workflow state	`helpin.pm.write`

Planning

Epics, sprints, objectives, labels, and workflows.

Method	Path	What it does	Scope
GET	`/epics`	List epics	`helpin.pm.read`
POST	`/epics`	Create an epic	`helpin.pm.write`
GET	`/epics/{epic_id}`	Get an epic	`helpin.pm.read`
PATCH	`/epics/{epic_id}`	Update an epic	`helpin.pm.write`
GET	`/labels`	List labels	`helpin.pm.read`
GET	`/objectives`	List objectives	`helpin.pm.read`
GET	`/objectives/{objective_id}`	Get an objective	`helpin.pm.read`
GET	`/sprints`	List sprints	`helpin.pm.read`
POST	`/sprints`	Create a sprint	`helpin.pm.write`
GET	`/sprints/{sprint_id}`	Get a sprint	`helpin.pm.read`
PATCH	`/sprints/{sprint_id}`	Update a sprint	`helpin.pm.write`
GET	`/sprints/{sprint_id}/tasks`	List a sprint's tasks	`helpin.pm.read`
GET	`/workflows`	List team workflows and their states	`helpin.pm.read`

Docs

Spaces, collections, and documents, including publishing.

Method	Path	What it does	Scope
GET	`/collections`	List collections	`helpin.docs.read`
POST	`/collections`	Create a collection	`helpin.docs.write`
PATCH	`/collections/{collection_id}`	Update or move a collection	`helpin.docs.write`
GET	`/documents`	List documents	`helpin.docs.read`
POST	`/documents`	Create a document	`helpin.docs.write`
GET	`/documents/search`	Search documents	`helpin.docs.read`
GET	`/documents/{document_id}`	Get a document	`helpin.docs.read`
PATCH	`/documents/{document_id}`	Update document metadata	`helpin.docs.write`
POST	`/documents/{document_id}/archive`	Archive a document	`helpin.docs.write`
GET	`/documents/{document_id}/content`	Read document content	`helpin.docs.read`
POST	`/documents/{document_id}/move`	Move a document	`helpin.docs.write`
POST	`/documents/{document_id}/publish`	Publish a document	`helpin.docs.publish`
POST	`/documents/{document_id}/restore`	Restore an archived document	`helpin.docs.write`
POST	`/documents/{document_id}/unpublish`	Unpublish a document	`helpin.docs.publish`
GET	`/spaces`	List spaces	`helpin.docs.read`
POST	`/spaces`	Create a space	`helpin.docs.write`
PATCH	`/spaces/{space_id}`	Update a space	`helpin.docs.write`

CRM

Contacts, companies, deals, pipelines, and signals.

Method	Path	What it does	Scope
POST	`/crm/activities`	Log an activity	`helpin.crm.write`
GET	`/crm/companies`	List companies	`helpin.crm.read`
GET	`/crm/companies/{company_id}`	Get a company	`helpin.crm.read`
PATCH	`/crm/companies/{company_id}`	Update a company	`helpin.crm.write`
GET	`/crm/contacts`	List contacts	`helpin.crm.read`
GET	`/crm/contacts/{contact_id}`	Get a contact	`helpin.crm.read`
PATCH	`/crm/contacts/{contact_id}`	Update a contact	`helpin.crm.write`
GET	`/crm/deals`	List deals	`helpin.crm.read`
POST	`/crm/deals`	Create a deal	`helpin.crm.write`
GET	`/crm/deals/{deal_id}`	Get a deal	`helpin.crm.read`
PATCH	`/crm/deals/{deal_id}`	Update a deal	`helpin.crm.write`
POST	`/crm/deals/{deal_id}/notes`	Add a deal note	`helpin.crm.write`
PUT	`/crm/deals/{deal_id}/stage`	Move a deal to a pipeline stage	`helpin.crm.write`
GET	`/crm/pipelines`	List pipelines	`helpin.crm.read`
GET	`/crm/signals`	List signals	`helpin.crm.read`

Support

Support conversations, messages, tags, and routing. The API can organize conversations but can't send replies.

Method	Path	What it does	Scope
GET	`/support/conversations`	List conversations	`helpin.support.read`
GET	`/support/conversations/{conversation_id}`	Get a conversation	`helpin.support.read`
PATCH	`/support/conversations/{conversation_id}`	Rename a conversation	`helpin.support.write`
PUT	`/support/conversations/{conversation_id}/assignee`	Assign or unassign a conversation	`helpin.support.write`
PUT	`/support/conversations/{conversation_id}/inbox`	Move a conversation to another inbox	`helpin.support.write`
GET	`/support/conversations/{conversation_id}/messages`	List public messages	`helpin.support.read`
POST	`/support/conversations/{conversation_id}/tags`	Tag a conversation	`helpin.support.write`
DELETE	`/support/conversations/{conversation_id}/tags/{tag_id}`	Remove a tag from a conversation	`helpin.support.write`
GET	`/support/inboxes`	List inboxes	`helpin.support.read`
GET	`/support/tags`	List tags	`helpin.support.read`

Agents

Helpin agents and durable agent runs.

Method	Path	What it does	Scope
POST	`/agent-runs`	Start an agent run	`helpin.agents.run`
GET	`/agent-runs/{run_id}`	Get an agent run	`helpin.agents.read`
POST	`/agent-runs/{run_id}/cancel`	Cancel an agent run	`helpin.agents.run`
GET	`/agents`	List agents	`helpin.agents.read`

Was this article helpful?