Skip to main content
GET
/
v1
/
customers
/
{id}
Fetch Customer
curl --request GET \
  --url https://carbonapistagingsecure.getcarbon.co/baas/api/v1/customers/{id} \
  --header 'apikey: <api-key>' \
  --header 'x-carbon-key: <x-carbon-key>'
{
  "status": "success",
  "message": "Customer fetched successfully",
  "data": {
    "id": "965c4bf7-e86b-45ca-b286-1ee6f32e991b",
    "first_name": "ola",
    "last_name": "ajayi",
    "email": "ola@yahoo.com",
    "phone": "08071000030",
    "nin": "11111111111",
    "bvn": "11111111111",
    "is_business": false,
    "business_name": null,
    "mode": "sandbox",
    "created_at": "2024-02-27T16:15:38.000Z",
    "updated_at": "2024-02-27T16:15:38.000Z"
  }
}

​
Overview

This endpoint retrieves the details of a specific customer identified by their ID.

​
Request

Method: GET
URL: /v1/customers/{id}

​
Parameters

NameInTypeRequiredDescription
x-carbon-keyHeaderstringYesAPI key for authentication.
idPathstringYesThe unique identifier of the customer.

​
Response

Status Code: 200 OK
Content-Type: application/json

​
Example Response

{
  "status": "success",
  "message": "Customer fetched successfully",
  "data": {
    "id": "965c4bf7-e86b-45ca-b286-1ee6f32e991b",
    "first_name": "Ola",
    "last_name": "Ajayi",
    "email": "ola@yahoo.com",
    "phone": "08071000030",
    "nin": "11111111111",
    "bvn": "11111111111",
    "is_business": false,
    "business_name": null,
    "mode": "sandbox",
    "created_at": "2024-02-27T16:15:38.000Z",
    "updated_at": "2024-02-27T16:15:38.000Z"
  }
}

Authorizations

​
apikey
string
header
required

Provide your API key in the 'apikey' header.

Headers

​
x-carbon-key
string
required

Path Parameters

​
id
string
required

Response

200 - application/json

OK

The response is of type object.