ProfitFlow
  1. Investors
ProfitFlow
  • Authentication
    • Login
      POST
    • Logout
      POST
  • Categories
    • List categories
      GET
    • Get category
      GET
  • Units
    • List available units
      GET
    • Get unit details
      GET
  • Investors
    • List investors
      GET
    • Get investor details
      GET
    • Get investor portfolio
      GET
  • Schemas
    • User
    • Category
    • Error
    • Unit
    • Investor
    • ValidationError
    • Portfolio
    • PaginationLinks
    • PaginationMeta
  1. Investors

List investors

GET
/investors
Get a paginated list of investors with optional filters.

Request

Authorization
Bearer Token
Provide your bearer token in the
Authorization
header when making requests to protected resources.
Example:
Authorization: Bearer ********************
or
Query Params

Header Params

Responses

🟢200
application/json
List of investors
Body

Example
{
    "data": [
        {
            "id": 1,
            "investor_code": "INV-123456",
            "investor_type": "individual",
            "name": "Ahmed Al-Rashid",
            "email": "ahmed@profitflow.com",
            "phone": "+201234567890",
            "kyc_status": "pending_documents",
            "is_active": true,
            "address": "123 Main Street",
            "city": "Cairo",
            "country": "Egypt",
            "nationality": "Egyptian",
            "total_invested": 250000,
            "total_earnings": 15000,
            "available_balance": 5000,
            "units_count": 3,
            "created_at": "2024-01-15T10:30:00+00:00",
            "updated_at": "2024-01-20T14:45:00+00:00"
        }
    ],
    "links": {
        "first": "http://localhost:8000/api/v1/categories?page=1",
        "last": "http://localhost:8000/api/v1/categories?page=3",
        "prev": null,
        "next": "http://localhost:8000/api/v1/categories?page=2"
    },
    "meta": {
        "current_page": 1,
        "from": 1,
        "last_page": 3,
        "links": [
            {
                "url": "string",
                "label": "string",
                "active": true
            }
        ],
        "path": "http://localhost:8000/api/v1/categories",
        "per_page": 15,
        "to": 15,
        "total": 42
    }
}
🟠401
Modified at 2026-01-31 12:19:15
Previous
Get unit details
Next
Get investor details
Built with