Skip to content
hlix docs

Follows

Generated from contract version 1.0.0 — the same document /v1/api/openapi.json serves.

Prerequisites

Section titled “Prerequisites”
  • An API key in x-api-key, or a browser session cookie
  • X-Organization-Id naming the workspace to act in, unless the session already has an active one
  • The base URL for your deployment, https://server.hlix.ai by default

Operations

Section titled “Operations”
Method Path Operation
GET /v1/api/follows List what you follow
POST /v1/api/follows Follow a project or a cycle
DELETE /v1/api/follows/{targetType}/{targetId} Stop following

List what you follow

Section titled “List what you follow”

GET /v1/api/follows · operation ID listFollows

Parameters

Name In Required Type Description
X-Organization-Id header no string The workspace (organization) to act in. Omitted, the session’s active organization is used.

Responses

Status Body Description
200 Follow[] The caller’s follows, newest first. target is null when the followed thing has since been deleted or is no longer visible — the row stays so it can still be removed.
400 ApiError The request named no active organization.
401 ApiError No valid session or API key.
403 ApiError Authenticated, but not a member of the named organization — or a client collaborator without the required access on this project.
404 ApiError The resource does not exist, or the caller is a task-scoped credential and this endpoint is outside its allowlist.

Follow a project or a cycle

Section titled “Follow a project or a cycle”

POST /v1/api/follows · operation ID createFollow

Parameters

Name In Required Type Description
X-Organization-Id header no string The workspace (organization) to act in. Omitted, the session’s active organization is used.

Request body — application/json, FollowTarget (required)

Property Type Required Notes
targetId string yes min length 1
targetType project cycle yes

Responses

Status Body Description
200 Follow The follow. Idempotent: following something twice answers with the existing row rather than creating a second one.
400 ValidationError | ApiError The JSON body failed schema validation (ValidationError), or the request named no active organization (ApiError).
401 ApiError No valid session or API key.
403 ApiError Authenticated, but not a member of the named organization — or a client collaborator without the required access on this project.
404 ApiError No such project or cycle in this workspace — or one a client collaborator was never granted (existence is deliberately not revealed).
409 ApiError That cycle is already assigned to the caller — it belongs in My work, not Following.

Stop following

Section titled “Stop following”

DELETE /v1/api/follows/{targetType}/{targetId} · operation ID deleteFollow

Parameters

Name In Required Type Description
targetType path yes string
targetId path yes string
X-Organization-Id header no string The workspace (organization) to act in. Omitted, the session’s active organization is used.

Responses

Status Body Description
200 Unfollowed The follow was removed.
400 ApiError The request named no active organization.
401 ApiError No valid session or API key.
403 ApiError Authenticated, but not a member of the named organization — or a client collaborator without the required access on this project.
404 ApiError The caller was not following that.

If a request fails

Section titled “If a request fails”

These apply to every operation on this page.

  • 400 — the body failed schema validation, or the request named no active organization. A ValidationError body carries the failing fields; an ApiError body carries only error.
  • 401 — no valid session or API key.
  • 403 — authenticated, but not a member of the named organization, or a client collaborator without the required access.
  • 404 — no such resource in this workspace. Absent and not-visible are deliberately the same answer; do not infer cross-tenant existence from it.
  • 409 — the expected revision or state is stale, or another operation currently owns the transition.
  • 500 — the operation failed server-side. Retry only where an idempotency key makes that safe.

Next steps

Section titled “Next steps”
API referenceEvery resource in the published contract, and what is deliberately not in it.
API & OpenAPIDownload the contract, generate a client, and read the compatibility policy.
TypeScript SDKAuth, retries, typed errors, uploads and streaming, already built.
CLI referenceThe same operations from a terminal, with a stable JSON envelope.