ViviScape.API.Open · v1 · stable

The ViviScape Work REST API.

Raw HTTPS to api.viviscape.io. Token-authenticated and OpenAPI-described, covering customers, projects, tasks, time entries, notes and insights — ready for any language or runtime. Starter gets read-only access; full read and write starts at Pro.

# 1. Authenticate → access token
curl https://api.viviscape.io/api/v1/account/authenticate \
  -H "Content-Type: application/json" \
  -d '{ "username": "you@co.com", "password": "••••" }'

# 2. Call any endpoint with the returned access_token
curl https://api.viviscape.io/api/v1/companies/list \
  -H "Authorization: Bearer $ACCESS_TOKEN"
Overview REST API MCP server CLI

How do I authenticate with the ViviScape Work API?

Exchange your credentials for an access token, then send Authorization: Bearer <access_token> on every call under /api/v1 at api.viviscape.io. The three steps below take about three minutes end to end.

1

Create a workspace

Sign up free at work.viviscape.io — no credit card.

2

Get credentials

Use your account username + password against /api/v1/account/authenticate to mint an access_token.

3

Pick your client

Raw HTTPS from any language, or reach for the MCP server for AI agents and the vs CLI for the shell.

4

Call the API

Read companies, write notes, log time, query insights, manage prospects — all from one base URL.

ViviScape.API.Open · api.viviscape.io

Every endpoint lives under /api/v1. Authenticate once, then send Authorization: Bearer <access_token> on every subsequent call.

Swagger UI OpenAPI JSON

Account & Auth

POST/api/v1/account/authenticate

Authenticate a user with username and password and return an access token.

GET/api/v1/account/info

Account profile, plan, and entitlements for the bearer token's owner.

GET/api/v1/account/services/list

List billable services / activity types defined on the account.

GET/api/v1/account/users

List users (team members) in the workspace.

CRM — Prospects, Clients, Companies

GET/api/v1/companies/list

List companies with paging and filters.

POST/api/v1/companies/add

Create a new company (organization) record.

POST/api/v1/clients/add

Create a client contact and attach it to a company.

GET/api/v1/clients/by-email/{email}

Look up a client by email — handy for inbound flows.

POST/api/v1/prospects/add

Create a prospect (top-of-funnel lead) with tags and source.

POST/api/v1/prospects/query

Search prospects by name, stage, owner, follow-up date, or tag.

Delivery — Projects, Tasks, Time

GET/api/v1/projects/list

List projects. Use ?active=true for the active subset.

GET/api/v1/projects/{id}/tasks

List tasks attached to a project, with status and assignment.

POST/api/v1/tasks/add

Create a task on a project or milestone.

GET/api/v1/tasks/open

Tasks open to the current user across all projects.

POST/api/v1/timelogs/add

Log time against a task, project, or service.

PUT/api/v1/timelogs/{id}

Adjust a time entry — duration, billability, or memo.

Knowledge — Notes & Insights

POST/api/v1/notes/add

Add a new note attached to any record (client, project, task).

POST/api/v1/notes/featured/upload/{note_id}

Upload a featured file/asset to a note as multipart form data.

POST/api/v1/notes/query

Full-text + structured search across notes.

POST/api/v1/insights/ai/log/summary

Generate an AI summary of an activity log span; result is governed and auditable.

GET/api/v1/insights/hours/by-person

Aggregated hours per person across a date range and project set.

GET/api/v1/insights/hours/by-project

Aggregated hours per project — input for utilization and margin reports.

Is the ViviScape Work API production-ready?

Yes. The API is versioned under /api/v1, authenticated with bearer tokens, rate-limited, and scoped to the permissions of the authenticating user. Every write is attributed and recorded in the workspace activity log.

Auth & identity

Bearer tokens minted via /account/authenticate. Same identity perimeter across web, CLI, and MCP.

Predictable behavior

OpenAPI-described surface. List endpoints support paging, filtering, and stable ordering.

Versioned + stable

Everything lives under /api/v1. Breaking changes move to a new major; v1 stays compatible.

Full audit trail

Every API, MCP, and CLI call lands in the same activity log — attributable by user, agent, or token.

AI-friendly

The MCP server hands typed tools to Claude, ChatGPT and Codex. Insights endpoints expose AI-summarized rollups via REST.

Open by default

ViviScape.API.Open is the public contract — Swagger docs at api.viviscape.io/swagger.

Ship your first integration today.

Authenticate once, then call any endpoint under /api/v1. Every write is attributed and logged.