Solar Proof API Documentation - Get Customer

 

 

API > Customers > Get Customer

GET https://solarproof.com.au/apidata.php?action=getcustomerByemail&customer_email=hakjsfd@solarproof.com.au&api_key=xyzxyzxyzxyzxyzxyzxyz

Get details of a customer.

Parameters
api_key (string) Your API key.
action (string) "getcustomerByemail".
customer_email (string) The email of the customer you want to get.
200 (Success) Returns

Details of the customer:

customer_id (string) The identifier of the customer.
gst_status (string) The GSTstatus of the customer (GST Registered / Not GST Registered).
customer_first_name (string) The first name of the customer.
customer_last_name (string) The last name of the customer.
customer_phone_1 (string) The primary phone number of the customer.
customer_phone_2 (string) The secondary phone number of the customer.
customer_email (string) The email address of the customer.
customer_type (string) The customer type identifier (Residential / Commercial).
company_name (string) The customer's company name.
company_phone (string) The phone number of customer's company.
owner_user_info (array)

The user who created the customer:

user_id (string) The id of the user who created the customer.
first_name (string) The first name of the user who created the customer.
last_name (string) The last name of the user who created the customer.
email (string) The email of the user who created the customer.
work_title (string) The work title of the user who created the customer.
username (string) The username of the user who created the customer.
creation_date (string) When the customer was created as a datetime, (E.g. 2025-03-09 21:47:48).
customer_notes (array)

An array of notes entered about the customer:

datetime (string) The datetime when the note was created (E.g. 2025-03-09 21:47:48).
note (string) The note made by the owner user.
creation_status (string) Attempts to return the status of the customer as indicated by the status index.
projects (array)

An array of projects created for the customer:

project_id (string) The identifier for the project.
project_title (string) The title given to the project.
site_address (array)

An array of address components for the project:

streetnum (string) Site street number.
Street (string) Site street name.
suburb (string) Site suburb.
state (string) Site state.
postcode (string) Site postcode.
country (string) Site country.
solar_panel_quantity (string) The quantity of solar panels for the given project.
solar_panel_type (string) The type of solar panels for the given project.
inverter_quantity (string) The quantity of inverters for the given project.
inverter_type (string) The type of inverter for the given project.
system_size (string) The size of the given project in kW.
proposal_link (string) The link to the Solar Proof PDF proposal of the project (if published).
Non-200 (Error) Returns

Details of the error:

code (string) The error code.
message (string) A description of the error.
Example Request
/apidata.php?action=getcustomerByemail&customer_email=hakjsfd@solarproof.com.au&api_key=xyzxyzxyzxyzxyzxyzxyz
Example Response 
{
    {
    "customer_id": "71705",
    "gst_status": "Not GST Registered",
    "customer_first_name": "Herka",
    "customer_last_name": "Jerman",
    "customer_phone_1": "0499399399",
    "customer_phone_2": "",
    "customer_email": "hakjsfd@solarproof.com.au",
    "customer_type": "Residential",
    "company_name": "",
    "company_phone": "",
    "owner_user_info": {
        "user_id": "221",
        "first_name": "John",
        "last_name": "User",
        "phone_number": "0415 644 644",
        "email": "user@bigsolarcity.com.au",
        "work_title": "Director",
        "username": "user1"
    },
    "creation_date": "2020-11-19",
    "customer_notes": "",
    "customer_status": "0",
    "projects": [
        {
            "project_id": "849",
            "project_title": "Project #849",
            "site_address": {
                "streetnum": "418",
                "street": "Murray Street",
                "suburb": "Perth",
                "state": "WA",
                "postcode": "6000",
                "country": "Australia"
            },
            "solar_panel_quantity": "56",
            "solar_panel_type": "320W - SUNPOWER CORPORATION - (SPR-E19-320)",
            "inverter_type": "SMA Australia Pty Ltd 20kW (STP20000TL-30)",
            "inverter_quantity": "1",
            "system_size": "17.92kW",
            "proposal_link": ""
        },
        {
            "project_id": "851",
            "project_title": "Project #851",
            "site_address": {
                "streetnum": "15",
                "street": "Aberdeen Street",
                "suburb": "Perth",
                "state": "WA",
                "postcode": "6000",
                "country": "Australia"
            },
            "solar_panel_quantity": "240",
            "solar_panel_type": "320W - SUNPOWER CORPORATION - (SPR-E19-320)",
            "inverter_type": "SMA Australia Pty Ltd 20kW (STP20000TL-30)",
            "inverter_quantity": "1",
            "system_size": "17.92kW",
            "proposal_link": "\/uploads\/fa00dfba91388ede4483011b455d93\/pdfs\/851\/proposal_851.pdf?58ef4da1d82612f7feabf0f2f16ba162"
        }
    ]
}
Book Demo