Common Responses for the object.
Response Parameters
| Property | Description |
|---|---|
| address_line1 | First line of address |
| address_line2 | Second line of address |
| city | Returns city |
| company_name | Returns company name |
| country_code | Returns Country Code (ISO 3166-1 alpha-2) |
| created_at | Datetime formatted as ISO8601 |
| custom_reference | Custom reference set on record |
| Returns email | |
| first_name | Returns the customer first name |
| gift_aid | If the customer has signed up for Gift Aid. Options are: true, false |
| id | Unique identifier beginning with specified prefix followed by 8 digit auto number |
| last_name | Returns the customer last name |
| metadata | Returns optional, custom, metadata, if set |
| postal_code | Returns postal code |
| state_code | Returns US state code, if country code set to “US” |
| status | Returns the status of the customer account |
| title | Returns the customer title. |
Response Sample
{
"Customer_Account": {
"address_line1": "32-36 Prospect Street",
"address_line2": "",
"city": "Hull",
"company_name": "Halestorm",
"country_code": "US",
"state_code": "FL",
"created_at": "2022-05-12T12:24:08Z",
"custom_reference": "Halestorm",
"email": "lhale@gmail.com",
"first_name": "Lizzy",
"id": "FTBCUST00035740",
"last_name": "Hale",
"postal_code": "HU2 8PX",
"status": "active",
"title": "",
"metadata": "",
"gift_aid": false
}
}
Response Sample
{
"Customer_Accounts": [
{
"address_line1": "32-36 Prospect Street",
"address_line2": "",
"city": "Hull",
"company_name": "Halestorm",
"country_code": "US",
"state_code": "FL",
"created_at": "2022-05-12T12:24:08Z",
"custom_reference": "Halestorm",
"email": "lhale@gmail.com",
"first_name": "Lizzy",
"id": "FTBCUST00035740",
"last_name": "Hale",
"postal_code": "HU2 8PX",
"status": "active",
"title": "",
"metadata": "",
"gift_aid": false
},
{
"address_line1": "32-36 Prospect Street",
"address_line2": "",
"city": "Hull",
"company_name": "Metallica",
"country_code": "GB",
"created_at": "2022-05-12T12:26:29Z",
"custom_reference": "Metallica",
"email": "jhetfield@email.com",
"first_name": "James",
"id": "FTBCUST00035741",
"last_name": "Hetfield",
"postal_code": "HU2 8PX",
"status": "active",
"title": "",
"metadata": "",
"gift_aid": false
}
]
}