API Reference

The Flowxtra REST API allows you to manage your recruitment data programmatically — jobs, candidates, pipelines, meetings, and more.

Base URL

All API requests use the central endpoint with a subdomain query parameter to identify your tenant:

https://app.flowxtra.com/api/{endpoint}?subdomain={your-subdomain}

For example, if your dashboard is at dpro.flowxtra.com:

https://app.flowxtra.com/api/jobs/index?subdomain=acme

Authentication

The API uses Bearer Token authentication. Your token is available in Settings → API Rest on your dashboard.

Authorization: Bearer YOUR_TOKEN

Response Format

All responses are JSON with this structure:

Success

{
  "success": true,
  "data": { ... },
  "message": 200
}

Paginated

{
  "success": true,
  "data": {
    "current_page": 1,
    "data": [ ... ],
    "last_page": 5,
    "per_page": 10,
    "total": 48
  },
  "message": 200
}

Error

{
  "error": "Unauthenticated",
  "message": "Bearer token is required"
}

Interactive Documentation

Swagger UI is available for testing endpoints directly:

https://app.flowxtra.com/api/doc

Available APIs

Category	Endpoints	Description
Jobs	15 endpoints	Job CRUD, status, publish, analytics
Candidates	12 endpoints	Applications, stages, email, notes
Company	10 endpoints	Profile, offices, pipelines, team
Social Media	5 endpoints	Accounts, posts, scheduling
Meetings	4 endpoints	Schedule, list, manage meetings

Rate Limits

Context	Limit
API (authenticated)	300 requests/min per user
Auth endpoints	120 requests/min per IP
Login	5 attempts/min per IP
Tenant routes	500 requests/min per user
Public endpoints	1000 requests/min per IP