Build with APIs
Audience: Administrators and Developers
Purpose: Provides an overview of Kizen's APIs, including how it works, key concepts, and available authentication methods, to help administrators and developers understand what they need before building integrations.
Overview
Kizen's APIs give you programmatic access to the data, Objects, and Agentic Workflow engine that powers the Kizen platform. Using our APIs, allows you to connect to external systems, sync data, trigger Workflows, and build custom integrations without touching the Kizen UI.
What You Can Do with Kizen's APIs
Kizen's APIs support a wide range of operations across the platform, including:
Reading and writing Records for any Object or Contact
Retrieving Object schemas, field definitions, and workflow configuration
Triggering Agentic Workflows programmatically
Scheduling and managing Activities
Checking user permissions at runtime
Extending the platform through webhooks and plugins
How the APIs Work
Kizen's APIs are REST APIs. All requests are made over HTTPS to a base URL. The URL you use depends on your Kizen environment. The following is an example:
https://app.go.kizen.com/api/Requests and responses use JSON. Every API call must include three credentials passed as HTTP request headers — an API Key, a Business ID, and a User ID. Together, these three values tell the API who is making the request, which business account to scope it to, and whether that user has permission to access the requested data.
X-API-KEY
Authenticates the request — acts as the password for the User ID
X-BUSINESS-ID
Scopes the request to the correct Kizen business account
X-USER-ID
Identifies the user, determining which Records and features are accessible based on their permissions
All three headers are required on every request. Generating these credentials is covered in Generate API Credentials.
API Fundamentals
Before diving into API calls, a few core concepts are worth understanding.
Here's a table summarizing the API Fundamentals concepts:
Tables in your data model
Configured by you or your team; Contact Object is a special type for storing individual's information
Unique ID (UUID) or API Name that identifies every Object
API Names are preferred — easier to read, resilient to data model changes, and usable across businesses with different credentials
Access rules that control what data a request can read or modify
Based on the User ID in request headers; a dedicated API user with a purpose-built permission group is strongly recommended
Kizen supports two authentication methods:
Token-based authentication is quick to set up, passing a static API Key, Business ID, and User ID as headers on every request.
OAuth 2.0 is the more secure option for production integrations, using an Authorization Code flow with PKCE (Proof Key for Code Exchange) and automatic token expiration.
For more information see, Authentication.
Topics In This Section
Generate API Credentials: Create your API Key, Business ID, and User ID in the Kizen UI
Create Your First API Call: Use those credentials to make a live, authenticated API request
What's Next
Start with Generate API Credentials — once your credentials are ready, you have everything you need to make your first API call.
Last updated
Was this helpful?