API Documentation
Public API for DeCyph AI. Authenticate with X-Client-Id and X-Client-Passkey. Try endpoints below.
Text-only API reference
Public APIv1.0.0
This document describes API version 1 (/v1/... paths). Breaking changes are introduced under new path prefixes (e.g. /v2/...); non-breaking additions may appear on existing version paths.
API access uses X-Client-Id and X-Client-Passkey (no user session). Rate limited per client. Successful JSON responses include X-API-Version: 1.
Row limits — GET /v1/clients/deals-pipeline is paginated (page, page_size / limit, up to 100 per page). Other list responses are capped at 1000 rows; if a team or client has more records, the response contains at most the first 1000; use other channels or contact support if you need full exports.
Clients — Single-client access: one API client is tied to one team. Clients: Acquisitions covers the deal pipeline, deal attributes, and standardized income statements. Clients: Asset Management covers listing properties for the portfolio, listing base tables in the portfolio SQL schema (/v1/clients/portfolio-sql/...), and running read-only SQL (SELECT or WITH) with a 5000-row cap per request and a server-side statement timeout.
Partners — Platform partner access: one API client can access multiple teams' data (e.g. external platforms pulling data for their clients). Use GET /v1/partners/clients to discover teams, then GET /v1/partners/properties with X-Team-Id to fetch properties per team.
Servers
- https://api.decyph.ai
Tags
- Clients: Acquisitions
- Clients: Asset Management
- Partners
Endpoints
GET/v1/clients/deals-pipeline— List deals pipeline for the authenticated client
Operation ID: listClientsDealsPipeline
Tags: Clients: Acquisitions
Returns financial-analysis deals (identifiers, labels, pipeline stage, and creation time) for the authenticated client's team, ordered by creation time (newest first). Results are paginated. Same auth as GET /v1/clients/properties.
GET/v1/clients/deals/{deal_uid}/attributes— Deal attributes for a deal
Operation ID: getClientsDealAttributes
Tags: Clients: Acquisitions
Returns pipeline deal attributes for the authenticated client's team for the given deal_uid (same identifier as GET /v1/clients/deals-pipeline). All fields are optional in the JSON: only non-null values are present, and null is stripped recursively.
GET/v1/clients/deals/{deal_uid}/standardized-income-statement— Standardized income statement for a deal
Operation ID: getClientsDealStandardizedIncomeStatement
Tags: Clients: Acquisitions
Returns the standardized trailing-twelve income statement for the authenticated client’s team and the given deal_uid (same identifier as GET /v1/clients/deals-pipeline). Requires income statement to be available for the deal.
POST/v1/clients/portfolio-sql/execute— Execute read-only portfolio SQL for the authenticated client
Operation ID: executeClientsPortfolioSql
Tags: Clients: Asset Management
Runs a single read-only SQL query as the team's dedicated database user. Same validation as the in-app SQL Explorer: only SELECT or WITH; one statement; row cap 5000; server-side timeout. Does not record query history.
GET/v1/clients/portfolio-sql/tables— List portfolio SQL tables for the authenticated client
Operation ID: listClientsPortfolioSqlTables
Tags: Clients: Asset Management
Returns base table names in the team's portfolio database schema (same scope as the in-app SQL Explorer). analysis_* tables are omitted. Requires the same database credentials configuration as SQL Explorer for the team.
GET/v1/clients/properties— List properties for the authenticated client
Operation ID: listClientsProperties
Tags: Clients: Asset Management
Returns properties from the authenticated API client's team. Use for single-client API access (X-Client-Id and X-Client-Passkey). The client is tied to one team; no X-Team-Id is required.
GET/v1/partners/clients— List partner client teams
Operation ID: getPartnersClients
Tags: Partners
Returns the list of teams (team_id, team_name) associated with the authenticated platform API client. Only platform API clients (partners) are allowed. Use this to discover which team_ids you can pass to GET /v1/partners/properties.
GET/v1/partners/properties— List properties for a team
Operation ID: listPartnersProperties
Tags: Partners
Returns properties for the team specified by X-Team-Id. Use GET /v1/partners/clients to list teams you may query.