Operational APIs
Customers
Our API offers a convenient way to manage your customers by providing a comprehensive set of functionalities that enable you to automate the customer management process.
Get All Customers
Fetch a list of all your customers
GET
https://v2.api.mycover.ai/v2/customers
Query Parameters
| Name | Type | Description |
|---|---|---|
| page | number | Page number of response |
| limit | number | Number of data to show per fetch |
| is_active | boolean | Filter customers by active status |
| created_at_start | string | Filter customers by created at start date |
| created_at_end | string | Filter customers by created at end date |
| search | string | Search customers by name or email |
Get one customer details by ID
GET
https://v2.api.mycover.ai/v2/customers/:customerId
Response
200 OK
{
"responseCode": 1,
"responseText": "Customers fetched successfully",
"data": {
"total_result": 4,
"total_count": 4,
"customers": [
{
"id": "5e2bd0d5-5a5e-4933-a3a4-8eb165ff2d2e",
"first_name": "Taiwo",
"last_name": "Suleman",
"email": "[email protected]",
"phone_number": "2349132326212",
"gender": "Male",
"date_of_birth": "1990-04-05",
"home_address": "Lekki Phase 1",
"state_of_residence": "Lagos",
"is_active": true,
"is_returning_customer": true,
"profile": "customer",
"customer_code": "CUS-26088",
"role": "user",
"app_mode": "test",
"country_id": "bb67ae67-53d1-4810-be05-33043115399c",
"created_at": "2025-10-06T12:59:21.377Z",
"updated_at": "2025-10-08T09:40:15.128Z",
},
]
}
}
View Customer's Purchase History
See customer’s purchase details, dates and transaction info
GET
https://v2.api.mycover.ai/v2/customers/:customerId/purchases
| Name | Type | Description |
|---|---|---|
| page | number | Page number of response |
| limit | number | Number of data to show per fetch |
| is_renewal | boolean | Filter purchases by renewal status |
Response
200 OK
{
"responseCode": 1,
"responseText": "Customer purchase fetched successfully",
"data": {
"total_count": 14,
"purchases": [
{
"id": "8f20581f-092b-4746-b02b-62d76520ed56",
"created_at": "2025-10-27T09:55:41.173Z",
"amount": "930.0000",
"product": {
"name": "MediSure",
"category": {
"name": "Health"
}
},
"provider": {
"organization_name": "Bastion"
},
"customer": {
"first_name": "Taiwo",
"last_name": "Suleman",
"email": "[email protected]",
"id": "5e2bd0d5-5a5e-4933-a3a4-8eb165ff2d2e"
}
}
]
}
}
View Customer's Policy History
See customer’s policy details, dates and transaction info
GET
https://v2.api.mycover.ai/v2/customers/:customerId/policies
| Name | Type | Description |
|---|---|---|
| page | number | Page number of response |
| limit | number | Number of data to show per fetch |
Response
200 OK
{
"responseCode": 1,
"responseText": "Customer policies fetched successfully",
"data": {
"total_result": 14,
"policies": [
{
"id": "d314077d-5f0b-42a3-ad95-ec40ee6faabb",
"app_mode": "test",
"is_as_service": false,
"first_name": "Taiwo",
"last_name": "Suleman",
"email": "[email protected]",
"phone_number": "2349132326212",
"date_of_birth": "1990-04-05T00:00:00.000Z",
"activation_date": "2025-10-28T00:00:00.000Z",
"start_date": "2025-10-27T09:55:41.193Z",
"expiration_date": "2025-11-26T00:00:00.000Z",
"amount": "930.0000",
"is_active": true,
"is_submitted_to_provider": true,
"customer_id": "5e2bd0d5-5a5e-4933-a3a4-8eb165ff2d2e",
"insured_id": "832054c7-f9ee-4546-96f0-90a08a82de77",
"insured_policy_relationship": "policy_holder",
"insured_type": "primary_insured",
"distributor_id": "9ea1fa8f-a6b7-4501-a26c-7acaae846212",
"provider_id": "04e7e852-0c80-4c62-8a24-c5f4a5e5c6d6",
"product_id": "d4751c39-8500-4238-881a-fb05b8f18cd4",
"product_category_id": "9d78bc79-3fa8-447d-b688-e42c1c6838a0",
"country_id": "bb67ae67-53d1-4810-be05-33043115399c",
"currency_id": "29dbe1da-218d-4b9d-bd43-8870055471a7",
"purchase_id": "8f20581f-092b-4746-b02b-62d76520ed56",
"policy_number": "100012398",
"certificate_url": "https://s3.eu-west-2.amazonaws.com/staging.mycover.ai/6bb3420a-33b4-49dc-a877-c09e07c502bf-Taiwo",
"created_at": "2025-10-27T09:55:41.194Z",
"updated_at": "2025-10-27T09:55:44.962Z",
"policy_holder": {
"first_name": "Taiwo",
"last_name": "Suleman"
},
"insured": {
"first_name": "Taiwo",
"last_name": "Suleman"
},
"product": {
"name": "MediSure",
"category": {
"name": "Health"
}
}
}
]
}
}