PF
PeopleFlow
HomeFeaturesPricingDocsAboutContact
Sign InStart Free Trial
PF
PeopleFlow

Modern HR & Payroll software for Caribbean and emerging market businesses.

Product

  • Features
  • Pricing
  • Get Started
  • Documentation

Company

  • About Us
  • Contact
  • Blog
  • Careers

Legal

  • Privacy Policy
  • Terms of Service
  • Security

2024-2026 PeopleFlow HR Suite. All rights reserved.

Serving Caribbean & LATAM businesses
Back to Documentation

API Reference

Complete API documentation for integrating PeopleFlow with your applications

API Endpoints
Authentication
API Key Authentication
OAuth 2.0 Supported

Include your API key in the Authorization header as a Bearer token.

Quick Start
Get started with the PeopleFlow API in minutes
curl -X GET "https://peopleflowhr.net/api/v1/employees" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json"
employees API
Available endpoints for employees management
GET/api/employees

List all employees with pagination and filters

Parameters:

pagelimitdepartmentstatussearch
GET/api/employees/:id

Get a single employee by ID

Parameters:

id
POST/api/employees

Create a new employee record

Request Body:

firstNamelastNameemaildepartmentrolehireDate
PUT/api/employees/:id

Update an existing employee

Request Body:

firstNamelastNameemaildepartmentrole
DELETE/api/employees/:id

Delete an employee record

Parameters:

id
Rate Limits
API usage limits and quotas

1,000

Requests per minute

100,000

Requests per day

10 MB

Max request size

Rate limits are applied per API key. Contact support for higher limits on Enterprise plans.

Error Codes
Common error responses and their meanings
400

Bad Request

Invalid request parameters

401

Unauthorized

Invalid or missing API key

403

Forbidden

Insufficient permissions

404

Not Found

Resource does not exist

429

Too Many Requests

Rate limit exceeded

500

Internal Server Error

Server-side error