List Customers

A list of all customers may be obtained using this endpoint. For emphasis on specific results, you can add filters based on customer's group id and other variables.

Endpoint

GET https://app.xtrakit.com/api/v1/customers

Headers

Authorization: Bearer API_KEY

Query Parameters

Parameters	Type	Description
customer_group_id int	Optional	Filters customers by the group to which this customer belongs.
created_at datetime	Optional	Start date for filtering customers records. (format: YYYY-MM-DD H:m:s)
updated_at date	Optional	End date for filtering customers records. (format: YYYY-MM-DD)

Sample Requests

PHP

<?php
$curl = curl_init();

curl_setopt_array($curl, array(
  CURLOPT_URL => 'https://app.xtrakit.com/api/v1/customers',
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => '',
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 0,
  CURLOPT_FOLLOWLOCATION => true,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => 'GET',
  CURLOPT_HTTPHEADER => array(
    'Authorization: Bearer API_KEY', // Replace 'API_KEY' with your actual API key
    'Content-Type: application/json'
  ),
));

$response = curl_exec($curl);

curl_close($curl);
echo $response;

?>

NodeJS

const axios = require('axios');

const config = {
    method: 'get',
    url: 'https://app.xtrakit.com/api/v1/customers',
    headers: {
        'Authorization': 'Bearer API_KEY' // Replace 'API_KEY' with your actual API key
    }
};

axios(config).then(function(response) {
    console.log(JSON.stringify(response.data));
}).catch(function(error) {
    console.error(error);
});

Python

import requests

url = "https://app.xtrakit.com/api/v1/customers"
headers = {
    "Authorization": "Bearer API_KEY" # Replace 'API_KEY' with your actual API key
}

response = requests.get(url, headers=headers)
print(response.json())

Sample Response

Success

{
    "status": 200,
    "message": "Customers found: 20",
    "data": {
        "customers": {
            "id": 1,
            "customer_group_id": 1,
            "customer_name": "Jane Doe",
            "customer_email": "[email protected]",
            "customer_phone": "[phone]",
            "customer_whatsapp": "[phone]",
            "customer_country": "Ghana",
            "customer_city": "Accra",
            "customer_state": "Greater Accra",
            "customer_zip": "00233",
            "address1": "123 Main Street",
            "address2": "Apt 4B, Downtown Complex",
            "customer_profile": "https://example.com/profiles/customer123.jpg",
            "created_by": "Edward",
            "created_at": "2024-08-04 08:23:45",
            "updated_at": "2024-08-04 02:00:43"
        },
        ...
    }
}

Error

{
    "status": 401,
    "error": "Unauthorized: Missing Bearer Token"
},

{
    "status": 401,
    "error": "Unauthorized: Invalid API Key"
}