Skip to main content
POST
/
api
/
v1
/
client
/
list
curl --location 'http://fssportal.com/api/v1/client/list' \
--header 'X-API-Token: YOUR_API_TOKEN' \
--header 'Content-Type: application/json' \
--data-raw '{
  "keyword": "test",
  "page": 1,
  "limit": 10
}'
{
  "message": "Client get successfully.",
  "data": {
    "current_page": 1,
    "data": [
      {
        "id": 1475,
        "user_id": 68,
        "lead_source_id": 75,
        "end_client_known": 1,
        "quote_no": "",
        "project_name": null,
        "name": "Test",
        "surname": "Convert Wuick Quote",
        "email": "test@gmail.com",
        "phone_no": "8460008773",
        "location": "Quiuuu",
        "address": "",
        "state": "",
        "city": "",
        "zip_code": "",
        "billing_address": "",
        "billing_city": "",
        "billing_state": "",
        "billing_zip_code": "",
        "created_at": "2025-12-16T05:33:32.000000Z",
        "lead_source_name": "Snv Rtr",
        "lead_source_email": "ddddnv@gmail.com"
      },
      {
        "id": 1472,
        "user_id": 68,
        "lead_source_id": 76,
        "end_client_known": 0,
        "quote_no": "",
        "project_name": "Test2",
        "name": "Sn",
        "surname": "Aa",
        "email": "vjjv@gmail.com",
        "phone_no": "12345678",
        "location": "Hccjkv",
        "address": "",
        "state": "",
        "city": "",
        "zip_code": "",
        "billing_address": "",
        "billing_city": "",
        "billing_state": "",
        "billing_zip_code": "",
        "created_at": "2025-12-16T05:18:22.000000Z",
        "lead_source_name": "Sn Aa",
        "lead_source_email": "ae@gmail.cm"
      },
      {
        "id": 1471,
        "user_id": 68,
        "lead_source_id": null,
        "end_client_known": 1,
        "quote_no": "",
        "project_name": "Test",
        "name": "QuickQuote",
        "surname": "QuickQuote",
        "email": "fss_1765862270@unknown.com",
        "phone_no": "",
        "location": "QuickQuoteLocation",
        "address": "",
        "state": "",
        "city": "",
        "zip_code": "",
        "billing_address": "",
        "billing_city": "",
        "billing_state": "",
        "billing_zip_code": "",
        "created_at": "2025-12-16T05:17:51.000000Z",
        "lead_source_name": null,
        "lead_source_email": null
      }
    ],
    "first_page_url": "http://localhost/fss/public/api/v1/client/list?page=1",
    "from": 1,
    "last_page": 1,
    "last_page_url": "http://localhost/fss/public/api/v1/client/list?page=1",
    "links": [
      {
        "url": null,
        "label": "« Previous",
        "active": false
      },
      {
        "url": "http://localhost/fss/public/api/v1/client/list?page=1",
        "label": "1",
        "active": true
      },
      {
        "url": null,
        "label": "Next »",
        "active": false
      }
    ],
    "next_page_url": null,
    "path": "http://localhost/fss/public/api/v1/client/list",
    "per_page": 20,
    "prev_page_url": null,
    "to": 3,
    "total": 3
  }
}

Endpoint

POST /api/v1/client/list
This endpoint requires authentication

Headers

X-API-Token
string
required
Your API access token. You can also set this globally in the API playground.
platform
string
required
The platform making the request: WEB, IOS, or ANDROID.

Request Body

keyword
string
keyword
page
integer
page
limit
integer
limit

Response

message
string
message
data
object
data
curl --location 'http://fssportal.com/api/v1/client/list' \
--header 'X-API-Token: YOUR_API_TOKEN' \
--header 'Content-Type: application/json' \
--data-raw '{
  "keyword": "test",
  "page": 1,
  "limit": 10
}'
{
  "message": "Client get successfully.",
  "data": {
    "current_page": 1,
    "data": [
      {
        "id": 1475,
        "user_id": 68,
        "lead_source_id": 75,
        "end_client_known": 1,
        "quote_no": "",
        "project_name": null,
        "name": "Test",
        "surname": "Convert Wuick Quote",
        "email": "test@gmail.com",
        "phone_no": "8460008773",
        "location": "Quiuuu",
        "address": "",
        "state": "",
        "city": "",
        "zip_code": "",
        "billing_address": "",
        "billing_city": "",
        "billing_state": "",
        "billing_zip_code": "",
        "created_at": "2025-12-16T05:33:32.000000Z",
        "lead_source_name": "Snv Rtr",
        "lead_source_email": "ddddnv@gmail.com"
      },
      {
        "id": 1472,
        "user_id": 68,
        "lead_source_id": 76,
        "end_client_known": 0,
        "quote_no": "",
        "project_name": "Test2",
        "name": "Sn",
        "surname": "Aa",
        "email": "vjjv@gmail.com",
        "phone_no": "12345678",
        "location": "Hccjkv",
        "address": "",
        "state": "",
        "city": "",
        "zip_code": "",
        "billing_address": "",
        "billing_city": "",
        "billing_state": "",
        "billing_zip_code": "",
        "created_at": "2025-12-16T05:18:22.000000Z",
        "lead_source_name": "Sn Aa",
        "lead_source_email": "ae@gmail.cm"
      },
      {
        "id": 1471,
        "user_id": 68,
        "lead_source_id": null,
        "end_client_known": 1,
        "quote_no": "",
        "project_name": "Test",
        "name": "QuickQuote",
        "surname": "QuickQuote",
        "email": "fss_1765862270@unknown.com",
        "phone_no": "",
        "location": "QuickQuoteLocation",
        "address": "",
        "state": "",
        "city": "",
        "zip_code": "",
        "billing_address": "",
        "billing_city": "",
        "billing_state": "",
        "billing_zip_code": "",
        "created_at": "2025-12-16T05:17:51.000000Z",
        "lead_source_name": null,
        "lead_source_email": null
      }
    ],
    "first_page_url": "http://localhost/fss/public/api/v1/client/list?page=1",
    "from": 1,
    "last_page": 1,
    "last_page_url": "http://localhost/fss/public/api/v1/client/list?page=1",
    "links": [
      {
        "url": null,
        "label": "« Previous",
        "active": false
      },
      {
        "url": "http://localhost/fss/public/api/v1/client/list?page=1",
        "label": "1",
        "active": true
      },
      {
        "url": null,
        "label": "Next »",
        "active": false
      }
    ],
    "next_page_url": null,
    "path": "http://localhost/fss/public/api/v1/client/list",
    "per_page": 20,
    "prev_page_url": null,
    "to": 3,
    "total": 3
  }
}

Notes

  • Authentication is required