#Get Client API.

The following endpoint allows merchant to get client from their Fatora Platform account.

curl --location --request GET 'https://api.fatora.io/v1/clients/1024' \
--header 'api_key: E4B73FEE-F492-4607-A38D-852B0EBC91C9' \
--header 'Content-Type: application/json' \
$curl = curl_init();

curl_setopt_array($curl, array(
  CURLOPT_URL => 'https://api.fatora.io/v1/clients/1024',
    'api_key: E4B73FEE-F492-4607-A38D-852B0EBC91C9',
    'Content-Type: application/json'

$response = curl_exec($curl);

echo $response;
// Define the API endpoint URL.
string apiUrl = "https://api.fatora.io/v1/clients/1024";

// Define the API key.
string apiKey = "E4B73FEE-F492-4607-A38D-852B0EBC91C9";

// Create a WebRequest.
HttpWebRequest request = (HttpWebRequest)WebRequest.Create(apiUrl);

// Set the request method to GET.
request.Method = "GET";

// Set the API key header.
request.Headers.Add("api_key", apiKey);

// Set the request content type.
request.ContentType = "application/json";

    // Get the response.
    using (HttpWebResponse response = (HttpWebResponse)request.GetResponse())
        if (response.StatusCode == HttpStatusCode.OK)
            // Read the response data.
            using (var responseStream = response.GetResponseStream())
            using (var reader = new StreamReader(responseStream))
                string responseContent = reader.ReadToEnd();
                Console.WriteLine("API Response: " + responseContent);
            Console.WriteLine("API Request failed with status code: " + response.StatusCode);
catch (WebException ex)
    Console.WriteLine("API Request failed with an exception: " + ex.Message);
"status": "SUCCESS",
 "name":"Client Name",
 "address":"Client Address",
 "phone":"Client Phone",
 "email":"[email protected]",
 "notes":"Additional notes"

Try it now: Get Client API

Header Parameters

Header Value
api_key REQUIRED Use the valid API key of your Fatora account. Read more information about Authentication.
Content-Type REQUIRED application/json

Query Parameters

Parameter Description
client_id REQUIRED intUnique identifier of the client to retrieved.


HTTP Status Code: 200 OK - The client information has been successfully retrieved.

Response Schema: application/json
status string the status of response.
client object:
  • id: int the id of client
  • name: string the full name of client
  • address: string the address of client
  • phone: string the phone of client
  • email: string the email of client
  • note: string the addational note of client

Otherwise if there was a problem with your request, you'll receive an error response such as 400 status code, and the response will include an error object describing why this request failed.

Response Schema: application/json
status string The status of response.
error object:
  • error_code string, the naumber of error: e.g: 400, For more information
    see Response Code
  • description string, the description of error: e.g: bad request

🛠️ Technical Support