Sayswitch - Developer Documentation

Get Customer

Use this endpoint to fetch detailed information about a specific customer by providing their unique customer email or code.

Endpoint

GET https://backendapi.sayswitchgroup.com/api/v1/customer/{email_or_code}

Sample cURL Request

curl -X GET https://backendapi.sayswitchgroup.com/api/v1/customer/johndoe@gmail.com 
  -H "Authorization: Bearer YOUR_SECRET_KEY"

Sample Response

{
    "success": true,
    "message": "Customer retrieved",
    "data": {
        "id": 330,
        "first_name": "John",
        "last_name": "Doe",
        "email": "test@email.com",
        "phone": "08159994269",
        "bvn": null,
        "domain": "test",
        "customer_code": "CUS_8n9f689gok7obwg",
        "metadata": "{}",
        "status": "active"
    }
}

Response Fields

Field	Type	Description
`success`	`boolean`	Indicates if the request was successful
`message`	`string`	Message describing the result
`id`	`number`	Unique identifier for the customer
`first_name`	`string`	The customer’s first name
`last_name`	`string`	The customer’s last name
`email`	`string`	The customer’s email address
`phone`	`string`	The customer’s phone number
`bvn`	`string`	The customer’s BVN (may be null)
`domain`	`string`	The domain associated with the customer
`customer_code`	`string`	Unique code assigned to the customer
`metadata`	`string`	Additional data in JSON string format
`status`	`string`	Current status of the customer (`active`, etc.)

Get Customers Overview