Overview
The INGENIOUS.BUILD API provides secure, programmatic access to project, financial, and operational data. It is designed for both lightweight internal scripts and production-grade integrations.
What is the INGENIOUS.BUILD API?
The INGENIOUS.BUILD API is a RESTful, Open API. Key characteristics:
Predictable, resource-based REST endpoints
Standard HTTP methods: GET, POST, PUT, PATCH, DELETE
Structured JSON request and response payloads
Secure authentication using access tokens or OAuth 2.0
Versioning and deprecation processes to protect existing integrations
What Customers Use the API For
Building custom integrations with internal or third-party systems
Programmatically importing and exporting data instead of using the UI
Automating repeatable workflows that run reliably over time
Because many integrations run automatically, backward compatibility and change management are critical.
Where to Find API Documentation
All official API reference materials are available at: api.ingenious.build/reference/getaccounttypepub
The documentation hub includes:
Endpoint definitions
Required and optional parameters
Authentication details
Request and response examples
Version-specific behaviour
Authentication Methods
Access Tokens (simple method)
Generated in Company Settings → Access Tokens.
Long-lived tokens used for troubleshooting and simple internal scripts.
OAuth 2.0 (Client Credentials Flow)
Configured in Company Settings → OAuth Applications.
Required for secure, production integrations.
Important: Never regenerate a customer's OAuth Client Secret. Doing so immediately breaks all live integrations. Only the customer can regenerate it, and they must accept the consequences.
OAuth 2.0 setup in Postman
Open the Authorization tab and set Type to OAuth 2.0.
Configure the token with the following:
Token Name — any value
Grant Type — Client Credentials
Access Token URL —
https://<WORKSPACE_SUBDOMAIN>.ingenious.build/api/v2/oauth/tokenClient ID — provided by the customer
Client Secret — provided by the customer (do not regenerate)
Scope — leave blank
Client Authentication — Send as Basic Auth header
Click Get New Access Token, then click Proceed, then Use Token.
Confirm the header prefix is
Bearer.
Note: OAuth tokens are valid for 24 hours. Regenerate the token in Postman when it expires.
API Change Management
Non-breaking changes
Non-breaking changes are safe improvements that do not affect existing integrations. Examples:
Adding optional fields
Adding new filter options
Expanding enum values
Introducing new endpoints
These changes are published in the Public Changelog and typically require no customer action.
Breaking changes
Breaking changes require customers to modify existing code. Examples:
Renaming or removing fields
Changing data types
Modifying endpoint paths or response structures
Engineering avoids breaking changes whenever possible.
Deprecation process
When a breaking change is unavoidable, the following process is used:
Documentation marking — affected fields or endpoints are marked as "will deprecate soon."
Public Changelog announcement — the change and timeline are announced approximately 2–4 weeks in advance.
Transition period — the deprecated version remains available for a defined period.
Final removal — the old behaviour is removed only after the transition period ends.
Customer Communication Rules
All API change notices are published in the Public Changelog.
Customers should subscribe to the Changelog to stay informed.
Direct customer emails about API changes are not sent.
If a customer reports unexpected behaviour:
Check the Public Changelog first.
Escalate unannounced breaking behaviour as a bug.
Encourage the customer to follow the Changelog going forward.
API Versioning
Versioning is used when breaking changes cannot be handled through deprecation alone.
New versions (for example, v2) contain the breaking changes.
Older versions remain active temporarily to allow migration.
When troubleshooting:
Identify which API version the customer is using.
Reference the documentation for that specific version.
Guide the customer through migration if needed.
When to Contact Support
If an issue is not covered in the documentation, or if you need assistance troubleshooting unexpected behaviour, contact the INGENIOUS.BUILD Support team. Reviewing the API reference before reaching out will often provide immediate answers.