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"
const base = "https://api.viviscape.io/api/v1"; const auth = await fetch(`${base}/account/authenticate`, { method: "POST", headers: { "Content-Type": "application/json" }, body: JSON.stringify({ username: "you@co.com", password: "•••" }), }).then(r => r.json()); const companies = await fetch(`${base}/companies/list`, { headers: { Authorization: `Bearer ${auth.access_token}` }, }).then(r => r.json());
import requests base = "https://api.viviscape.io/api/v1" auth = requests.post(f"{base}/account/authenticate", json={"username": "you@co.com", "password": "•••"} ).json() companies = requests.get(f"{base}/companies/list", headers={"Authorization": f"Bearer {auth['access_token']}"} ).json()
using System.Net.Http.Json; var http = new HttpClient { BaseAddress = new("https://api.viviscape.io/api/v1/") }; var auth = await http.PostAsJsonAsync("account/authenticate", new { username = "you@co.com", password = "•••" }); var token = (await auth.Content.ReadFromJsonAsync<LoginToken>())!.AccessToken; http.DefaultRequestHeaders.Authorization = new("Bearer", token); var companies = await http.GetFromJsonAsync<Company[]>("companies/list");
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.
Create a workspace
Sign up free at work.viviscape.io — no credit card.
Get credentials
Use your account username + password against /api/v1/account/authenticate to mint an access_token.
Pick your client
Raw HTTPS from any language, or reach for the MCP server for AI agents and the vs CLI for the shell.
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.
Account & Auth
Authenticate a user with username and password and return an access token.
Account profile, plan, and entitlements for the bearer token's owner.
List billable services / activity types defined on the account.
List users (team members) in the workspace.
CRM — Prospects, Clients, Companies
List companies with paging and filters.
Create a new company (organization) record.
Create a client contact and attach it to a company.
Look up a client by email — handy for inbound flows.
Create a prospect (top-of-funnel lead) with tags and source.
Search prospects by name, stage, owner, follow-up date, or tag.
Delivery — Projects, Tasks, Time
List projects. Use ?active=true for the active subset.
List tasks attached to a project, with status and assignment.
Create a task on a project or milestone.
Tasks open to the current user across all projects.
Log time against a task, project, or service.
Adjust a time entry — duration, billability, or memo.
Knowledge — Notes & Insights
Add a new note attached to any record (client, project, task).
Upload a featured file/asset to a note as multipart form data.
Full-text + structured search across notes.
Generate an AI summary of an activity log span; result is governed and auditable.
Aggregated hours per person across a date range and project set.
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.