Connect SystemLineage
SystemLineage Public API
Connect approved business systems to SystemLineage through a versioned, tenant-scoped API.
Use a documented connection with narrow permissions, visible limits and an audit trail for every approved action.
Illustrative workflow
Public API connection review
Use a documented connection with narrow permissions, visible limits and an audit trail for every approved action.
- Step 1Choose the SystemLineage records and business result the connection needs.
List supported modules and permitted operations
- Step 2Review the smallest read permissions required for that result.
Read the current bounded workspace for one approved module
- Step 3Test the connection in an isolated workspace with altered-ID and tenant-boundary checks.
Return structured, safe errors without exposing private system details
- Step 4Approve the connection, rotate its secret when needed and review its audit history.
Keep write operations unavailable in the first public API version
Who this is for
Common reasons to use Public API.
Small businesses and implementation partners that need a controlled connection between SystemLineage and an approved business system.
Read approved inventory, job and KPI records for an internal business workflow
Read an approved module workspace without sharing a full user login
Review connected operational records before deciding whether a later write integration is needed
Connect a reviewed internal tool while keeping company records separated
Core benefits
Useful access without opening the whole account.
One versioned connection surface across supported SystemLineage modules
A read-only first release with separate module approval
Clear rate limits and safe errors instead of silent partial changes
Revocable credentials and an audit record for accepted actions
Connection scope
Supported operations with a bounded connection surface.
List supported modules and permitted operations
Read the current bounded workspace for one approved module
Return structured, safe errors without exposing private system details
Keep write operations unavailable in the first public API version
Normal workflow
Approve the purpose before opening access.
Choose the SystemLineage records and business result the connection needs.
Review the smallest read permissions required for that result.
Test the connection in an isolated workspace with altered-ID and tenant-boundary checks.
Approve the connection, rotate its secret when needed and review its audit history.
Security and data
Account boundaries apply to every request.
- Every request must resolve one authenticated account and organization
- Version 1 is least-privilege and read-only; write endpoints and write scopes remain unavailable
- Input limits, rate limits, audit logs, safe errors and credential revocation are required
- Cross-tenant and altered-identifier tests must pass before runtime access is enabled
Clear boundaries
What this connection does not include.
- No anonymous access, unauthenticated writes or shared credentials between customers
- No arbitrary database queries, code execution or unrestricted bulk downloads
- No marketplace, accounting or carrier connector is included by default
- No promise of uninterrupted external-provider availability
Connection standard
SystemLineage API v1 is described with OpenAPI 3.1.2 and currently exposes read-only module discovery and workspace reads.
Open the machine-readable API descriptionPrepared, not live
The application-side connection code and documentation are prepared for guarded testing. Runtime API access remains disabled until Clerk, the production database, scoped credential or OAuth setup and witnessed tenant-isolation tests are complete.
Pricing status
API pricing and included usage limits are not published yet. The owner must approve the final catalog after operating limits are witnessed.
Questions answered plainly
Before requesting a connection.
Is the SystemLineage Public API live now?
No. The public documentation and application design can be prepared, but runtime access stays disabled until secure account access, the production database, scoped credentials, rate limits and cross-company isolation tests are witnessed. A connection review records the intended use without promising a live connection.
Can the API change business records?
Not in the first public API version. Version 1 is read-only: it can list approved SystemLineage modules and read one approved module workspace. A later write operation would require a separately documented endpoint, an exact write scope, account-owner approval and witnessed tenant-isolation tests.
Does one API key unlock every SystemLineage tool?
No. Access follows the account's enabled modules and the credential's approved scopes. A connection cannot use an API key to bypass plan limits, roles or company boundaries, and the account owner can rotate or revoke the credential.
Related software
Continue with the closest connected product.
Request a Public API review
Tell SystemLineage which system, records and result you need. The request opens a draft for you to review; it does not activate access or start billing.
Request a Public API review