Search customers

Search customers

POST /customers/search

Search customers

cURL

curl --request POST \
  --url https://developersandbox-api.flutterwave.com/customers/search \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "email": "[e-mail]"
}
'

import requests

url = "https://developersandbox-api.flutterwave.com/customers/search"

payload = { "email": "[e-mail]" }
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({email: '[e-mail]'})
};

fetch('https://developersandbox-api.flutterwave.com/customers/search', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://developersandbox-api.flutterwave.com/customers/search",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'email' => '[e-mail]'
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://developersandbox-api.flutterwave.com/customers/search"

	payload := strings.NewReader("{\n  \"email\": \"[e-mail]\"\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://developersandbox-api.flutterwave.com/customers/search")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"email\": \"[e-mail]\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://developersandbox-api.flutterwave.com/customers/search")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"email\": \"[e-mail]\"\n}"

response = http.request(request)
puts response.read_body

200

{
  "message": "<string>",
  "meta": {
    "page_info": {
      "total": 123,
      "current_page": 123,
      "total_pages": 123
    }
  },
  "data": [
    {
      "id": "cus_3XarBILKQS",
      "address": {
        "city": "New York",
        "country": "US",
        "line1": "123 Main Street",
        "postal_code": "10001",
        "state": "New York",
        "line2": "Apt 4B"
      },
      "email": "[e-mail]",
      "name": {
        "first": "King",
        "middle": "Leo",
        "last": "LeBron"
      },
      "phone": {
        "country_code": "234",
        "number": "08012345678"
      },
      "meta": {},
      "created_datetime": "2023-11-07T05:31:56Z"
    }
  ]
}

{
  "status": "failed",
  "error": {
    "type": "REQUEST_NOT_VALID",
    "code": "10400",
    "message": "Request is not valid",
    "validation_errors": [
      {
        "field_name": "amount",
        "message": "must not be null"
      }
    ]
  }
}

{
  "status": "failed",
  "message": "UNAUTHORIZED",
  "error": {
    "type": "UNAUTHORIZED",
    "code": "10401",
    "message": "unauthorized"
  }
}

{
  "status": "failed",
  "message": "<string>",
  "error": {
    "type": "FORBIDDEN",
    "code": "10403",
    "message": "Forbidden"
  }
}

{
  "status": "failed",
  "message": "<string>",
  "error": {
    "type": "RESOURCE_CONFLICT",
    "code": "10409",
    "message": "Resource conflict"
  }
}

Authorizations

Authorization · string · header · required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Headers

X-Trace-Id · string

A unique identifier to track this operation. It must be between 12 and 255 characters in length.

Required string length: 12 - 255

Query Parameters

page · integer · default: 1

The page of the data to retrieve. The most recent data entry is on page 1.

Required range: x >= 1

size · integer · default: 10

Length of data returned. Defaults to 10.

Required range: 10 <= x <= 50

Body

application/json

email · string · required

The Customer's email address.

Pattern: ^[a-zA-Z0-9_+&*-]+(?:\.[a-zA-Z0-9_+&*-]+)*@(?:[a-zA-Z0-9-]+\.)+[a-zA-Z]{2,}$

Example:

"[e-mail]"

Response

200

application/json

OK

status · enum<string>

Available options: success, failed

message · string

meta · object

Show child attributes

data · object[]

Maximum array length: 10

Show child attributes