1. Categories
ProfitFlow
  • Account
    • Authentication
      • Login
      • Register new user
      • Get current user
      • Logout
      • Refresh token
    • Password
      • Request password reset
      • Reset password
      • Change password
    • Profile
      • Update current user
    • Delete account
      DELETE
  • 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
  • Investment Requests
    • Create investment request
      POST
    • List investment requests
      GET
  • Portfolio
    • Get portfolio performance
      GET
    • Get transaction details
      GET
    • List transactions
      GET
  • KYC
    • List uploaded documents
      GET
    • Upload identity document
      POST
    • Get KYC status
      GET
  • Dashboard
    • Get investment marketplace
      GET
  • Distributions
    • List distributions
      GET
    • Get distribution details
      GET
    • List payouts
      GET
    • Get payout details
      GET
  • Statements
    • Download profit statement
    • Download tax records
    • Download portfolio summary
  • Notifications
    • List notifications
    • Get notification
    • Mark notification as read
    • Mark all as read
    • Register FCM token
    • Clear FCM token
  • Settings
    • Get app settings
    • Update app settings
  • Legal
    • Get privacy policy
    • Get terms of service
    • Get investment disclaimer
  • Marketplace
    • Get app configuration
  • Withdrawal Requests
    • Create withdrawal request
    • List withdrawal requests
  • Category Memberships
    • List memberships
    • Create membership
    • Available categories for enrollment
    • Get membership details
  • Public
    • Browse investment units (guest)
    • View unit details (guest)
    • Browse investment categories (guest)
    • View category details (guest)
  • Schemas
    • User
    • Category
    • Error
    • Unit
    • Investor
    • ValidationError
    • Portfolio
    • PaginationLinks
    • PaginationMeta
    • UnitDetail
    • InvestmentRequest
    • PublicUnit
    • InvestmentRequestWithUnit
    • Notification
    • WithdrawalRequest
    • CategoryMembership
    • Transaction
    • NotificationDataPayloads
    • WithdrawalRequestWithUnit
    • TransactionDetail
    • RegisterFcmTokenRequest
    • PortfolioPerformance
    • KycDocument
    • KycStatus
    • Dashboard
    • DashboardTrend
    • DashboardActivity
    • Marketplace
    • Distribution
    • FeaturedCategory
    • Payout
    • SimpleCategory
    • Settings
    • TopGainerUnit
    • NotificationSettings
    • NewListingUnit
    • LegalContent
    • AppConfig
    • IconOption
    • BadgeOption
    • ColorOption
    • PublicCategory
  1. Categories

List categories

GET
/categories
Get a paginated list of active investment categories.
Only categories marked as active are returned.

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 categories
Body

Example
{
    "data": [
        {
            "id": 1,
            "slug": "commercial-real-estate",
            "name": "Commercial Real Estate",
            "description": "Investment opportunities in commercial properties",
            "icon": "building",
            "color": "#3B82F6",
            "is_active": true,
            "requires_membership": false,
            "membership_type": "elite",
            "membership_fee": 5000,
            "max_seats": 50,
            "occupied_seats": 12,
            "available_seats": 38,
            "is_seats_full": false,
            "units_count": 5,
            "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-03-12 00:48:26
Previous
Delete account
Next
Get category
Built with