Skip to main content
The Clients API provides endpoints for managing client accounts in the multi-tenant Fataplus system. Each client can have multiple projects and isolated data access.

​
List Clients

curl -X GET "https://bknd.fata.plus/api/clients" \
  -H "Authorization: Bearer YOUR_TOKEN" \
  -H "Content-Type: application/json"
Retrieves all clients accessible to the authenticated user. Endpoint: GET /api/clients

​
Query Parameters

​
email
string
Filter clients by email address
​
name
string
Search clients by name (partial match)

​
Response

​
data
array
Array of client objects
{
  "data": [
    {
      "id": "client_xyz789",
      "name": "Madagascar Rice Farmers Cooperative",
      "email": "contact@mrfc.mg",
      "projects": ["proj_abc123", "proj_def456"],
      "created_at": "2026-02-15T08:00:00Z",
      "updated_at": "2026-03-01T10:30:00Z"
    },
    {
      "id": "client_abc456",
      "name": "Vanilla Exporters Ltd",
      "email": "admin@vanilla-export.mg",
      "projects": ["proj_ghi789"],
      "created_at": "2026-02-20T14:20:00Z",
      "updated_at": "2026-02-28T09:45:00Z"
    }
  ]
}

​
Create Client

curl -X POST "https://bknd.fata.plus/api/clients" \
  -H "Authorization: Bearer YOUR_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "name": "Madagascar Rice Farmers Cooperative",
    "email": "contact@mrfc.mg",
    "projects": []
  }'
Creates a new client account in the system. Endpoint: POST /api/clients

​
Request Body

​
name
string
required
Client full name or company name
​
email
string
required
Client email address (must be unique)
​
projects
array
default:"[]"
Initial array of project IDs (typically empty on creation)

​
Response

​
data
object
The created client object with all fields including generated id, created_at, and updated_at
{
  "data": {
    "id": "client_xyz789",
    "name": "Madagascar Rice Farmers Cooperative",
    "email": "contact@mrfc.mg",
    "projects": [],
    "created_at": "2026-03-03T09:15:00Z",
    "updated_at": "2026-03-03T09:15:00Z"
  }
}

​
Multi-Tenant Isolation

The Fataplus system ensures strict data isolation between clients:
  • Each client has access only to their own projects and data
  • Tenant routing is handled automatically through authentication
  • Subdomain access pattern: [tenant].fata.plus
  • Admin users can access all client data for management purposes

​
Permissions

Client access is controlled by role-based permissions:
  • Read: admin, client - Both admins and clients can view client information
  • Write: admin - Only admins can create and modify client accounts
Clients can view their own account information but cannot create new client accounts.