Quick Start Checklist
Use this checklist to track your progress as you integrate with the Core Flow API.
This checklist can optionally save your progress using browser storage. Click the button below if you’d like to track your progress between visits. No data is sent to any server.
Integration Steps
Request API credentials
Contact our API-support to obtain your client ID and client secret for the target environment.
Contact our API-support to obtain your client ID and client secret for the target environment.
Authenticate with OAuth 2.0
Use your credentials to obtain an access token. See Authentication.
Use your credentials to obtain an access token. See Authentication.
Make your first API call
Test your setup by calling
Test your setup by calling
GET /api/User/ApiPermissions to verify permissions. Try the AI Assistant (Beta)
Looking for something specific? Use the chatbot in the bottom-right corner. It has full insight into the documentation and API specification, and can help you find endpoints, understand payloads, and troubleshoot issues.
Looking for something specific? Use the chatbot in the bottom-right corner. It has full insight into the documentation and API specification, and can help you find endpoints, understand payloads, and troubleshoot issues.
Set up Domain Events subscription
Subscribe to relevant domain events to receive real-time updates. See Domain Events.
Subscribe to relevant domain events to receive real-time updates. See Domain Events.
Review best practices
Read the Best Practice section for OData queries and rate limiting.
Read the Best Practice section for OData queries and rate limiting.
Next Steps
Once you’ve completed the checklist, explore these resources:
- Commonly Used Methods - Quick reference for frequent operations
- API Methods - Browse available endpoints by category
- FAQ - Answers to common questions
AI Assistant (Beta)