telos customer list
List customers
- --status? — Customer status filter
- --ownerId? — Owner (DRI) user UUID filter; pair with whoami to list your own accounts
- --cursor? — Pagination cursor from a previous page
- --limit? — Items per page
Install the CLI from npm to get the telos command. Every command calls REST v1 over HTTPS and is gated by the capabilities on your API key.
Install Node.js 20 or newer, then install the public package globally:
npm install --global @telosfoundry/cli
telos --helpnpm reads the package's binary mapping and places the telos executable on your PATH. The installed package is a bundled API client; it does not require access to the Telos source repository.
The CLI authenticates with the same bearer key as REST and MCP, read from TELOS_API_KEY. Keys are issued in the app under Settings → API Keys and carry a subset of your own capabilities. TELOS_API_URL overrides the target instance. Responses are the standard REST envelope's data, printed as JSON.
export TELOS_API_KEY=telos_live_…
# optional; defaults to https://www.telos-app.com
export TELOS_API_URL=https://www.telos-app.com
telos customer list --status live
telos customer create --name "Acme Robotics"
telos customer update 8f14e45f-… --status churned --reason "Budget cut"Flags map 1:1 to the action's input fields. For non-string fields (or to script a whole payload), pass --json with a raw body; explicit flags win over the JSON.
telos customer create --name "Acme Robotics" \
--json '{"arr": "120000", "customerSince": "2026-01-05"}'Auto-rendered from the action registry, the same source that renders the REST reference and the MCP catalog. An action that exists on one surface exists on all three.
List customers
Get a customer
Create a customer
Update a customer
Delete a customer
List a customer's contacts
Add a contact to a customer
Update a customer contact
Delete a customer contact
List a customer's linked opportunities
Link an opportunity to a customer
Unlink an opportunity from a customer
List a customer's update feed
Post a customer update
List every dated client promise
List a customer's ARR history
Record an ARR level for a customer
Delete an ARR history point
Org-wide ARR roll-up and movement
List a customer's stored reviews
Get a stored customer review
Generate a customer review
Get a customer's onboarding state
Start or swap a customer's onboarding template
Move a customer to another onboarding milestone
Complete a customer's onboarding and take the account live
Update one of a customer's onboarding milestones
Create work on a customer's onboarding milestone
List strategies
Get a strategy
Create a strategy
Update a strategy
Publish a strategy
Archive a strategy
List a strategy's version history
Rename a strategy version
List visions
Get a vision
Create a vision
Update a vision
List a vision's version history
List objectives for a vision
Count a vision's children
Rename a vision version
List metrics
Get a metric
Create a metric
Update a metric
Delete a metric
List metric values
Record a metric value
List built-in metrics Telos can track
Start tracking a built-in metric
Get the opportunities betting on a metric
Count what depends on a metric
List objectives
Get an objective
Create an objective
Update an objective
Delete an objective
Get the opportunities linked to an objective
Set an objective's metric
Read the alignment grid
Get an objective's parent and sub-objectives
Point an objective or opportunity at an objective
Get the customer claims on an objective
List opportunities
Get an opportunity
Create an opportunity
Update an opportunity
Delete an opportunity
List tasks attached to an opportunity
Get an opportunity's full context bundle
Get an opportunity's scorecard
Set a scorecard value
Clear a scorecard value
Link an objective to an opportunity
Update an objective link
Unlink an objective from an opportunity
Reject an opportunity and skip remaining template steps
List an opportunity's status updates
Post an opportunity status update
Set an opportunity's lifecycle state
Add a prototype to an opportunity
Remove a prototype link from an opportunity
Draft a PRD from the opportunity's evidence
List an opportunity's validation risks and votes
Vote on one of an opportunity's validation risks
Apply a PRD template to an opportunity
List the org's scoring criteria
List an opportunity's delivery phases
Count an opportunity's unphased work
Write the handoff note out of a finished phase
Add a delivery phase to an opportunity
Rename, re-date or re-own a phase
Remove a phase
Reorder an opportunity's phases
Summarise planned work
Get planned work gaps
List task statuses
Create a task status
Update a task status
Reorder a task status
Archive a task status
Restore a task status
List tasks
Get a task
Create a task
Update a task
Post a development update
List development updates
Delete a task
Set a task's status
Set a task's owner
Preview assigning a task to a cycle
Move a task into a cycle
Count tasks per lifecycle status
Pin a coding session to a task
Time a task has spent in each status
Get a task's full context bundle
List recurring tasks
Get a recurring task
Create a recurring task
Update a recurring task
Pause or resume a recurring task
Delete a recurring task
Get a work item's external links and blockers
Flag work as waiting on someone outside the team
Resolve an external blocker
Link a work item back to the chat message it came from
List coding-agent runs
Cancel a coding-agent run
List teams
Get a team
Create a team
Update a team
Delete a team
List team members
Add a team member
Remove a team member
List team ownership config
List users
Get a user
Update a user
List tags
Create a tag
Update a tag
Delete a tag
List tag themes
Create a tag theme
Update a tag theme
Delete a tag theme
List comments
Post a comment
Edit a comment
Delete a comment
Add or remove your reaction to a comment
List insights
Get an insight
Create an insight
Update an insight
Delete an insight
Attach an insight
Detach an insight
Set the flags on an insight's link
Set an insight's review outcome
Route an insight to a team's review queue
Set an insight's tags
Set an insight's objective impacts
List the insights blocking a work item
Find near-duplicate insights and past rejections
Read the insight pattern board
Accept an insight pattern (deprecated)
Dismiss an insight pattern
Attach a pattern to existing work
Link new pattern insights
List other stakeholders
Create an other stakeholder
List PRD templates
Get a PRD template
Create a PRD template
Update a PRD template
Delete a PRD template
List webhook subscriptions
Create a webhook subscription
Update a webhook subscription
Send a test event to a webhook subscription
Delete a webhook subscription
List templates
Get a template
Create a template
Update a template
Delete a template
Add a template step
Update a template step
Delete a template step
Write a template handoff
List active work using a template
Get the org's default template for an entity type
Move every entity to another template, then delete this one
Read the template running on an entity
Start a template on an entity
Move an entity onto a different template
Advance or reassign a running step
List categories
Get a category
Create a category
Update a category
Delete a category
List notifications
Get unread notification count
Mark a notification read
Mark all notifications read
Pin a notification
Unpin a notification
Unsubscribe at notification source
List time entries
Log a time entry
Update a time entry
Delete a time entry
Aggregate time by category
Get every engineer's costed time in a date range
Actual labor cost of an opportunity
Actual labor cost of a task
Replace a timesheet window
List an opportunity's time entries
List rooms
Get a room
Create a group channel
Update a group channel
Archive a group channel
Open a DM with an org member
List a room's members
Add a member to a group channel
Remove a member from a group channel
Set your own membership state in a room
List a room's messages
List a message's thread replies
List pinned messages
Search messages
Post a message
Update a message
Delete a message
Pin or unpin a message
Add or remove your reaction to a message
List an entity's activity
List file metadata
Get a file's metadata and download URL
Get the org's storage usage
Request a presigned file upload
Confirm a completed file upload
Attach a file to an entity
Detach a file from an entity
Delete a file
List import runs
Get an import run
List integrations
Get an integration
List an integration's delivery log
List roles
Search across the workspace
Check whether you follow an entity
Follow or unfollow an entity
Get the authenticated caller
Set the caller's own avatar
List cycles
Get a cycle
List the cycle grids
List one grid's cycles with delivery stats
Get a cycle by grid and number
Get a cycle's burnup series
Break a cycle's work down by owner, priority and team
Search cycles for a picker
List the cycles work can still be assigned to
Set the default estimate for unestimated work
Get a cycle verdict
Get cycle configuration
Configure cycle planning
Roll over an ended cycle now
Commit a cycle baseline
List a cycle's customer commitments
List several cycles' customer commitments at once
Get a cycle's load per person
Get several cycles' load per person at once
List a cycle's ledger events
Get cycle impact
Update a future cycle
Delete an empty future cycle