curl -X POST "https://demoagency.agentcisapp.com/api/v2/clients" \ -H "Authorization: Bearer YOUR_ACCESS_TOKEN" \ -H "Accept: application/json" |
Base URL: https://{tenant-subdomain}.agentcis.com/api/v2/ e.g: https://demoagency.agentcisapp.com/api/v2/ Client Base URL: https://{tenant-subdomain}.agentcis.com/api/v2/clients e.g: https://demoagency.agentcisapp.com/api/v2/clients Application Base URL: https://{tenant-subdomain}.agentcis.com/api/v2/applications |
Note: 🔒 -> Authentication is required to access this API
API Endpoints
Endpoint: {{Client Base URL}}/list
Method: POST
Description: Retrieve the paginated list of all contacts
{ "page": int , //type int (optional, default: 1) "per_page": int , //type int (optional, default: 10) "filters": { "id": { "in": [5] } // type object (optional) } } |
{ "data": [ { "id": 5, "dob": "1990-05-10", "rating": "Hot", "city": "Sydney", "phone": 977987878545, "photo": null, "full_name": "Jhon Sharma", "first_name": "Jhon", "last_name": "Sharma", "source_title": "abhilekh", "assignee_full_name": "Abhilekh Singh", "assignee_id": 38, "email": "[email protected]", "secondary_email": null, "updated_at": { "formatted": "10-02-2025", "actual": "2025-10-02T08:03:25+05:45" }, "created_at": { "formatted": "05-02-2018", "actual": "2018-05-02T07:14:07+05:45" }, "preferred_intake": { "formatted": "May 2025", "actual": "2025-05-15T00:00:00+00:00" }, "application": { "total": 5, "inprogress": 5, "completed": 0, "discontinued": 0 }, "applications": [ { "id": 25, "client_id": 5, "status": { "id": "Open", "label": "In Progress" }, "product_name": "Bachelor of Accounting", "partner_name": "Australian Demo University" }, { "id": 26, "client_id": 5, "status": { "id": "Open", "label": "In Progress" }, "product_name": "Bachelor of Contemporary Communication Design", "partner_name": "Federation University Australia" }, { "id": 117, "client_id": 5, "status": { "id": "Open", "label": "In Progress" }, "product_name": "Bachelor of Business (Accounting)", "partner_name": "King's Own Institute (KOI)" } ], "assignee_office_name": "Head Office {SDF'FSF}", "country_name": "Australia", "internal_id": "agenttest5", "client_identifier": null, "permissions": { "sendEmail": true, "edit": true, "delete": true }, "passport_number": "12345", "status": "Client", "application_status": null, "custom_fields": { "2bd8c1ff-1b39-4acb-9d9f-ec77b520cd13": [ { "id": 447, "name": "2" } ], "4cfe3d8a-4bcc-40d7-9484-3911f3749cd2": "123", "4dd4567d-22c2-412f-8b8f-5f492f7a88a0": [ { "id": 882, "name": "Online" } ], "6661ed1e-ba38-48e8-ae1a-cd4554574948": "ss", "b18759f5-e9be-4691-9457-f3587acf9fe7": [ { "id": 430, "name": "1" }, { "id": 431, "name": "2" } ], "ca5beab9-f886-4e99-a74e-d38fb1c61603": "test", "e65a56b0-077f-4654-a2e2-e831fb609183": "9809000000", "e924e6b8-daf2-4f0a-bf11-5ea7dc8dd658": "1" }, "tag": "system", "branch": { "id": 1, "name": "Head Office {SDF'FSF}" }, "followers": [ { "id": 33, "first_name": "Anushka", "last_name": "Lamichhane", "email": "[email protected]", "name": "Anushka Lamichhane", "pivot": { "client_id": 5, "user_id": 33 } }, ], "permissions": { "add": true, "import": true, "createApplications": true, "manageAssignedOfficeClients": true }, "links": { "first": "http://demoagency.agentcisapp.com/api/v2/clients/list?page=1", "last": "http://demoagency.agentcisapp.com/api/v2/clients/list?page=354", "prev": null, "next": "http://demoagency.agentcisapp.com/api/v2/clients/list?page=2" }, "meta": { "current_page": 1, "from": 1, "last_page": 10, "links": [ { "url": null, "label": "« Previous", "active": false }, { "url": "http://demoagency.agentcisapp.com/api/v2/clients/list?page=1", "label": "1", "active": true }, { "url": "...", "label": "1", "active": false }, { "url": "http://demoagency.agentcisapp.com/api/v2/clients/list?page=10", "label": "10", "active": false }, { "url": "http://demoagency.agentcisapp.com/api/v2/clients/list?page=2", "label": "Next »", "active": false } ], "path": "http://demoagency.agentcisapp.com/api/v2/clients/list", "per_page": 10, "to": 10, "total": 10 } } |
Endpoint: {{Client Base URL}}/archived/list
Method: POST
Description: Retrieve the paginated list of all clients
{ "page": 1, //integer value "per_page": 10, //integer value "filters": [ "archived_on": { "equals": "2025-09-03" } ] // object (optional) } |
{ "data": [ { "id": 145744, "city": null, "photo": null, "full_name": "test testt", "assignee_id": 248, "assignee_full_name": "Prabin Acharya", "assignee_office_name": "Head Office {SDF'FSF}", "archived_by_full_name": "Saurav Munikar", "archived_by_office_name": "Head Office {SDF'FSF}", "archived_by_id": 249, "email": null, "created_at": { "formatted": "09-19-2025", "actual": "2025-09-19T16:32:04+05:45" }, "preferred_intake": { "formatted": "-", "actual": "-" }, "archived_on": { "formatted": "09-23-2025", "actual": "2025-09-23T10:11:42+05:45" }, "country_name": null, "country_of_passport_name": null, "permissions": { "sendEmail": true, "edit": true, "delete": true, "forceDelete": true }, "status": "Prospect", "custom_fields": { "4cfe3d8a-4bcc-40d7-9484-3911f3749cd2": "52", "4dd4567d-22c2-412f-8b8f-5f492f7a88a0": [ { "id": 882, "name": "Online" } ], "6661ed1e-ba38-48e8-ae1a-cd4554574948": "sub aget", "e924e6b8-daf2-4f0a-bf11-5ea7dc8dd658": "54" }, "tag": "system", "client_portal": "De-Activated", "tags": [], "phone": null, "gender": null } ], "links": { "first": "http://demoagency.agentcisapp.com/api/v2/clients/archived/list?page=1", "last": "http://demoagency.agentcisapp.com/api/v2/clients/archived/list?page=4", "prev": null, "next": "http://demoagency.agentcisapp.com/api/v2/clients/archived/list?page=2" }, "meta": { "current_page": 1, "from": 1, "last_page": 4, "links": [ { "url": null, "label": "« Previous", "active": false }, { "url": "http://demoagency.agentcisapp.com/api/v2/clients/archived/list?page=1", "label": "1", "active": true }, { "url": "http://demoagency.agentcisapp.com/api/v2/clients/archived/list?page=...", "label": "2", "active": false }, { "url": "http://demoagency.agentcisapp.com/api/v2/clients/archived/list?page=4", "label": "4", "active": false }, { "url": "http://demoagency.agentcisapp.com/api/v2/clients/archived/list?page=2", "label": "Next »", "active": false } ], "path": "http://demoagency.agentcisapp.com/api/v2/clients/archived/list", "per_page": 10, "to": 10, "total": 40 } } |
Endpoint: {{Client Base URL}}/
Method: POST
Description: Create a new prospect record after starting the application of this prospect turns into a client (here, in this case, email is mandatory), to create a lead, the assignee is not required. Use Form Data as payload
{ first_name: Chandan (required | string) last_name: Sharma (required | string) dob: 1995-10-07 (optional | string) client_identifier: 102 (optional | string) gender: male (optional | “male”, “female”, “others”) email: [email protected] (optional | unique | string) secondary_email: [email protected] (optional | unique | string) phone[number]: 9843232111 (optional | unique | string) phone[country_code]: NP first_point_of_contact: email (required | “email”: default | “phone”) street: Suncity (optional | string) city: Kathmandu (optional | string) state: Bagmati (optional | string) zip_code: 44600 (optional | string) country: 150 (optional | int: countries-> id ) country_of_passport: 150 (optional | int: countries-> id) visa_expiry_date: 2026-10-31 (optional | string) visa_type: Student (optional | string) preferred_intake: 2025-10-08 (optional | string) assignee: 203 (int | user_id) photo: file (binary) passport_number: 125/125 (optional | string) followers[]: 239 (array | user_id) followers[]: 34 (array | user_id) tags[]: 798 (array | tag_id) custom_fields[4dd4567d-22c2-412f-8b8f-5f492f7a88a0][]: 882 custom_fields[6661ed1e-ba38-48e8-ae1a-cd4554574948]: test } |
{ "data": { "id": 1, "name": "John Smith", }, "message": "You\u2019ve successfully added a Prospect." } |
Status: 201
Endpoint: {{Client Base URL}}/{client_id}
Method: GET
Description: Retrieve detailed information about a specific client
{ "data": { "id": 100, "tag": "student-information-form", "first_name": "Bhatta", "last_name": "Rai", "internal_id": "agenttest100", "client_identifier": null, "comment": null, "commented_at": { "formatted": "10-08-2025", "actual": "2025-10-08T11:47:08+05:45" }, "contact_preference": null, "full_name": "Bhatta Rai", "dob": { "formatted": null, "actual": null }, "phone": { "actual": "423514564", "formatted": "+61423514564", "country_dialing_code": 61, "country_code": "AU" }, "portal_enabled": 1, "rating": "-", "visa_type": null, "photo": null, "email": { "primary": "[email protected]", "secondary": null }, "address": { "formatted": "", "street": null, "city": null, "state": null, "zip_code": null, "country": { "id": null, "name": null, "country_dialing_code": null, "country_code": null, "country_code_iso_alpha3": null }, "country_of_passport": { "id": null, "name": null } }, "assignee": { "id": 36, "full_name": "Rupal Test 2 Bha", "avatar": null, "office_name": "Sydney Development Committee Office - Melbourne", "email": "[email protected]" }, "updated_at": { "formatted": "07-29-2025", "actual": "2025-07-29T10:42:36+05:45" }, "created_at": { "formatted": "09-29-2021", "actual": "2021-09-29T06:50:36+05:45" }, "visa_expiry_date": { "formatted": null, "actual": null }, "application": { "total": 1, "inprogress": 1, "completed": 0, "discontinued": 0 }, "added_by": { "full_name": "Megha Pradhan", "avatar": "https://agentcisapp.amazonaws.com/{{db_name}}/uploads/users/photo", "email": "[email protected]", "id": 1 }, "custom_fields": { "ecd2ff07-ecf0-4c07-8dfb-d8c918369aa7": [ { "id": 1, "name": "Phone Call" } ] }, "sources": { "type": "default", "meta": { "id": 14, "name": "Facebook Adv" } }, "branch_id": 2, "office": { "id": 2, "name": "Sydney Development Committee Office - Melbourne" }, "permissions": { "sendEmail": true, "edit": true, "delete": true, "viewInvoice": true, "manageInvoice": true, "createInvoice": true, "clientAssigneeChoose": true, "addApplication": true, "addQuotation": true, "viewReferrers": true, "isPremiumPlan": true, "deleteClientInterestedServices": true, "viewApplicationSalesForecast": true, "viewInterestedServiceSalesForecast": true }, "preferred_intake": { "formatted": "-", "actual": "" }, "is_archived": false, "status": "Client", "passport_number": null, "sales_forecast": { "application": { "AUD": { "currency_code": "AUD", "value": "0.00" } }, "interested_services": { "AUD": { "currency_code": "AUD", "value": "84.75" } } }, "followers": [], "tags": [], "is_field_changes_from_client_portal": false, "reactivate": false, "gender": null } } |
Status: 404, 403, 200
Endpoint: {{Client Base URL}}/{client_id}
Method: PUT
Description: Update an existing client record
{ first_name: Chandan (required | string) last_name: Man Sharma (required | string) dob: 1995-10-07 (optional | string) client_identifier: 102 (optional | string) gender: male (optional | “male”, “female”, “others”) email: [email protected] (optional | unique | string) secondary_email: [email protected] (optional | unique | string) phone[number]: 9843232111 (optional | unique | string) phone[country_code]: NP first_point_of_contact: email (required | “email”: default | “phone”) street: Suncity (optional | string) city: Kathmandu (optional | string) state: Bagmati (optional | string) zip_code: 44600 (optional | string) country: 150 (optional | int: countries-> id ) country_of_passport: 150 (optional | int: countries-> id) visa_expiry_date: 2026-10-31 (optional | string) visa_type: Student (optional | string) preferred_intake: 2025-10-08 (optional | string) assignee: 203 (int | user_id) photo: file (binary) passport_number: 125/125 (optional | string) followers[]: 239 (array | user_id) followers[]: 34 (array | user_id) tags[]: 798 (array | tag_id) custom_fields[4dd4567d-22c2-412f-8b8f-5f492f7a88a0][]: 882 custom_fields[6661ed1e-ba38-48e8-ae1a-cd4554574948]: test _method”: “PUT” } |
{ message: "You’ve successfully updated your client’s information." } |
Status: 400, 403, 200
Endpoint: {{Client Base URL}}/{client_id}/delete
Method: DELETE
Description: Delete an Archived client. Not all the clients are deletable, only those who are archived and do not have a running application are deletable
{ "_method":"DELETE" } |
{ } |
Status: 400, 403, 200
