Welcome to Pulse API Documentation

Welcome to the Pulse ecosystem, developed by Ingedata. Our mission is to empower our partners and associates with a robust set of tools and resources to interact with the Pulse ecosystem.

Pulse is the centerpiece of Ingedata’s evolution from a traditional BPO to your next-generation data and consulting partner. By integrating data orchestration, business intelligence, AI-driven workflows, and human-in-the-loop processes, Pulse connects every stage of the data lifecycle under a single, cohesive ecosystem.

graph TD A[Pulse] --> B[Project Management] A --> C[ETL Platform] A --> D[BI Platform] A --> E[Low-Code integration] A --> F[Human in the loop] classDef default fill:#f9f9f9,stroke:#007bff,stroke-width:1px,color:#333; classDef main fill:#e6f0ff,stroke:#0073e6,stroke-width:2px,color:#0073e6; class A main;

Getting Started

For Developers

Build integrations and applications using our comprehensive API suite

For Power Users

Integrate Pulse with low-code platforms and create custom workflows

For Customers

Leverage Pulse data in your business systems and analytics platforms

Core Concepts

Authentication & Access - Learn how to authenticate with the API and manage your API keys
JSON:API Format - Understand the standardized API response format
Pagination & Sorting - Control how data is returned in list endpoints
Filtering Collections - Filter data to get exactly what you need
Error Handling - Understand API error responses and how to handle them

Microservices Architecture

Pulse is built on a microservices architecture, with each service providing specific functionality through its API. Each service has its own documentation:

IAM

Identity and Access Management - users, accounts, roles, and organizations

Files

File storage and management system

Workflow

Project and task management workflows

Office

Employee management, leave requests, and HR functions

Talent

Talent management and recruitment

Quiz

Assessment and quiz functionality

Notification

User notifications and alerts

Recruitment

Recruitment and applicant tracking

Integration Options

Pulse offers multiple ways to integrate with your existing systems:

REST API
- Direct HTTP access to all Pulse services
- JSON:API compliant responses
- Comprehensive endpoint documentation
SDK Integration Coming soon!
- Official client libraries for multiple languages
- Simplified authentication and request handling
- Type-safe interfaces
Business Intelligence Coming soon!
- Direct database access for BI tools
- Pre-built dashboards and reports
- Custom data visualization
Webhooks & Event Streaming Coming soon!
- Real-time data updates
- Event-driven architecture
- Custom integrations

How to Use This Documentation

This documentation is organized to help you find what you need quickly:

Start with Authentication - Before making any API calls, learn how to authenticate with the Pulse API.
Understand Core Concepts - Familiarize yourself with JSON:API, filtering, and pagination.
Explore Service APIs - Browse the documentation for each microservice to find the endpoints you need.
Try the Examples - Each endpoint includes example requests and responses to help you get started.
Reference the Schemas - Use the provided schemas and TypeScript definitions to understand the data structures.

Stay Up to Date

We strive to keep our documentation accurate and helpful. We will regularly update this repository with new features and improvements. Keep an eye on our change logs and release notes for the latest updates, breaking changes, and important announcements.

Need Help?

If you have any questions or need assistance, please contact our support team at contact@ingedata.ai.