👨‍👩‍👧‍👦Get All Customers

Retrieve all the Customer records on your unique Gathr database.

Get All Customers

GET {{baseUrl}}/customers

Path Parameters

Name	Type	Description
tenantId*	String	This is the tenantId that was assigned to you when your tenant was created. You will have received this information via message from a member of the Finch Technologies team. If you can't your tenantId, please email [e-mail].
environmentUrl*	String	Environment URL's uat - https://uat.apply.fincheck.co.za prod - https://apply.fincheck.co.za. *Please note that you need to be set up in each environment by a member of the Finch Technologies team, who will share your bearer token with you for the specific environment in a protected link.

Status Codes

200 - OK

All Customers Found

{
    "data": [
        {
            "id": "{{customerId}}",
            "client_reference": "custom_01223",
            "popi": 1,
            "terms_and_conditions": 1,
            "email": "[e-mail]",
            "id_number": "020101064xxxx",
            "first_name": "Helen",
            "middle_name": "Anne",
            "last_name": "Doe",
            "full_name": "Helen Anne Doe",
            "id_type": "id_number",
            "country": "South Africa",
            "initials": "HA",
            "api_token": "YSb7AlDtxNn17scOXAMr"
        },
        {
            "id": "{{customerId}}",
            "client_reference": "STDStatements+1",
            "popi": 1,
            "terms_and_conditions": 0,
            "email": "[e-mail]",
            "id_number": "AE944908",
            "first_name": "Louis",
            "middle_name": null,
            "last_name": "Van Deventer",
            "full_name": "Louis Van Deventer",
            "id_type": "passport",
            "country": "South Africa",
            "initials": "L",
            "api_token": "1YVgc0n15FLuHGDPDZz4"
        },
        {
            "id": "{{customerId}}",
            "popi": 0,
            "terms_and_conditions": 0,
            "email": "[e-mail]",
            "id_number": "541008018xxxx",
            "first_name": "Master",
            "middle_name": null,
            "last_name": "Master",
            "full_name": "Master Master",
            "id_type": "id_number",
            "country": "South Africa",
            "initials": "M",
            "api_token": "ZAUR7KAl0B3Wc8Q5pYvn"
        },
        {
            "id": "{{customerId}}",
            "popi": 0,
            "terms_and_conditions": 0,
            "email": "[e-mail]",
            "id_number": "11081752xxxx",
            "first_name": "Rajiv",
            "middle_name": "Rajiv Gandhi",
            "last_name": "Gandhi",
            "full_name": "Rajiv Rajiv Gandhi Gandhi",
            "id_type": "id_number",
            "country": "South Africa",
            "initials": "RRG",
            "api_token": "LHMg4gjUM6A4QQvvXq9c"
        }
    ],
    "meta": {
        "total": 4,
        "count": 4,
        "per_page": 4,
        "current_page": 1,
        "total_pages": 1
    }
}