The following APIs are available:
The Customers API returns customer detail information for specified customers.
Path: `/customers`
Verb: `GET`
The following table describes the query parameters used for the GET method.
| Parameter | Type | Required | Description |
| firstName | string | Requested customer first name | |
| lastName | string | Requested customer last name | |
| modified_date_to | datetime | Customers last updated on or before the specified date and time are returned (HH:MM is optional). |
|
| customerId | int | Requested customer ID | |
| pageSize | int | Number of records per page
default: 100 |
|
| page | int | Index page
default: 1 (the first page) |
|
| modified_date_from | datetime | Customers last updated on or after the specified date and time are returned (HH:MM is optional). |
The response body of the GET method is formatted in JSON:
| Key | Type | Description |
| page | int | Requested page number |
| pageSize | int | Number of records per page |
| pageRowCount | int | Number of records on the Index page |
| filteredRowCount | int | Number of filter results by query parameters |
| data | array | List of customer records |
The following table describes the data returned by the API:
| Key | Description | |
| customer_id | Customer's ID | |
| customertype | Customer type description (For example: General Public, Employee, Individual, Non-profit) | |
| geographic_area | Geographic Area description | |
| lastpayee_id | The ID of the user for whom the customer last made a payment | |
| site | The site to which the customer belongs | |
| firstname | Customer's first name | |
| lastname | Customer's last name | |
| address1 | Customer's address 1 | |
| address2 | Customer's address 2 | |
| city | Customer's residential address city | |
| state | Customer's residential address province | |
| zipcode | Customer's zip code | |
| homephone | Customer's home phone | |
| workphone | Customer's work phone | |
| cellphone | Customer's cell phone | |
| faxphone | Customer's fax phone | |
| pagerphone | Customer's pager phone | |
| otherphone | Customer's other phone | |
| Customer’s email address | ||
| age | Age of the customer | |
| age_category | Customer’s age category | |
| entrydate | The customer record creation date | |
| gender | Customer Gender (Male, Female, Other) | |
| headofhousehold | Whether the customer is the head of household (“Yes” or “No”) | |
| mailingaddress1 | Customer’s mailing address line 1 | |
| mailingaddress2 | Customer’s mailing address line 2 | |
| mailingcity | The city of the customer's mailing address | |
| mailingstate | The state of the customer's mailing address | |
| mailingzipcode | The zip code of the customer's mailing address | |
| mailingcountry | The country of the customer's mailing address | |
| mailing_name | The mailing name used on mail-outs and statements | |
| resident_status | Customer's resident status ("Resident" or "Non-resident") | |
| occupation | Customer’s occupation | |
| special_handling | Whether the customer needs special handling (“Yes” or “No”) | |
| emergency_contact1_first_name | The first name of the customer’s emergency contact 1 | |
| emergency_contact1_last_name | The last name of the customer’s emergency contact 1 | |
| emergency_contact1_phone_no | The phone number of the customer’s emergency contact 1 | |
| emergency_contact1_relation | The customer’s relation to their emergency contact 1 | |
| emergency_other_phone1 | The other phone number of the customer’s emergency contact 1 | |
| emergency_contact2_first_name | The first name of the customer’s emergency contact 2 | |
| emergency_contact2_last_name | The last name of the customer’s emergency contact 2 | |
| emergency_contact2_phone_no | The phone number of the customer’s emergency contact 2 | |
| emergency_contact2_relation | The customer’s relation to their emergency contact 2 | |
| emergency_other_phone2 | The other phone number of the customer’s emergency contact 2 | |
| date_modified | The date and time of the last modification to the customer information | |
| retired_status | Customer's retired status ("Retired" or "Active") | |
| not_online_activated | Whether the customer is activated on the CUI (“Yes” or “No”) | |
| login_created | Customer’s CUI account creation time and date | |
| login_used | Customer’s most recent CUI login time and date | |
| interest_date | The date on which the customer’s interest charge is calculated | |
| county | Customer’s county | |
| can_be_scheduled | Displays "Yes" or "No" | |
| residency_expires_date | Customer’s residency expiration date | |
| legal_name | Customer’s legal name | |
| late_fee_date | The date on which the customer’s late fee is calculated. | |
| additional_email | Customer’s additional email address | |
| agree_receive_text_message | Whether the customer agreed to receive text messages (“Yes” or “No”) | |
| created_on | Where the customer account was created ("Staff side" or "Online") | |
| birth_date | Customer's date and time of birth | |
| agree_receive_email | Whether the customer agreed to receive emails (true or false) | |
| agree_receive_postal_mail | Whether the customer agreed to receive postal mail (true or false) | |
| preferred_language | The customer's preferred language ("English", "Français" or "Español") | |
| families | Array of families to which the customer belongs | |
family_id |
Family's ID |
|
household_size |
Number of members in the household | |
| head_of_household | Is the customer the head of this household? (“Yes” or “No”) | |
head_of_household_customer_id |
Customer ID of the head of the household. | |
| head_of_household_customer_first_name | Head of household's first name | |
| head_of_household_customer_last_name | Head of household's last name | |
| head_of_household_customer_email | Head of household's email address | |
external_id |
External ID of the family | |
family_role |
The customer's role in the family (for example: "Adult / Guardian") | |
| lat | The customer's latitude | |
| lon | The customer's longitude | |
This API will retrieve multiple records per API call depending on the specified request parameters.
One record will contain all information of a matching customer.
**GET**
https://api.amp.active.com/ANETGateway/rest/anet-insightsapi/customers?customerId=9128&api_key=xxx
{
"page": 1,
"pageSize": 100,
"pageRowCount": 1,
"filteredRowCount": 1,
"totalRowCount": 3936,
"data": [
{
"customer_id": 9128,
"customertype": "General Public",
"geographic_area": "Façons de trouver les activités qui",
"lastpayee_id": 0,
"site": "aaa Roshow Site for Facility Reserve by DateRange",
"firstname": "RoshowLanguage222",
"lastname": "Zhao",
"address1": "Vdsg",
"address2": "Gfd",
"city": "Default City",
"state": "VA",
"zipcode": "85748",
"homephone": "+1US3458547123333",
"workphone": "+1US5645632541854",
"cellphone": "+1US4549685325635",
"faxphone": "+1US3333333443777",
"pagerphone": "+1US3338574454333",
"otherphone": "+1US3333333447777",
"email": "444@222.com",
"age": "64.11",
"entrydate": "2021-09-14 19:21:05.0",
"gender": "Male",
"headofhousehold": "Yes",
"mailingaddress1": "Bvdfxc",
"mailingaddress2": "Bvcx",
"mailingcity": "Bgdfs",
"mailingstate": "bgf",
"mailingzipcode": "96584",
"mailingcountry": "AZ",
"mailing_name": "33@3333.com",
"resident_status": "Non-resident",
"occupation": "22222",
"specialhandling": "Yes",
"emergency_contact1_first_name": "Dsvgfd",
"emergency_contact1_last_name": "Sda",
"emergency_contact1_phone_no": "+1US33354125411",
"emergency_contact1_relation": "Vdfsa",
"emergency_other_phone1": "+1US33857254662",
"emergency_contact2_first_name": "Vdfsg",
"emergency_contact2_last_name": "Dsf",
"emergency_contact2_phone_no": "+1US33385478543",
"emergency_contact2_relation": "Cds",
"emergency_other_phone2": "+1US22163524174",
"date_modified": "2021-09-14 23:53:19.0",
"retired_status": "Retired",
"not_online_activated": "No",
"login_created": "2021-09-14 23:52:34.0",
"login_used": "2021-09-13 12:47:29.0",
"county": "Alameda",
"can_be_scheduled": "No",
"additional_email": "123@321.com",
"agree_receive_text_message": "Yes",
"created_on": "Staff side",
"birth_date": "1956-09-15 00:00:00.0",
"agree_receive_email": true,
"agree_receive_postal_mail": true,
"preferred_language": "Espaol",
"lat": 37.741474,
"lon": -122.473973
"families": [
{
"family_id": 7990,
"household_size": 1,
"head_of_household": "Yes",
"head_of_household_customer_id": 9128,
"head_of_household_customer_first_name": "RoshowLanguage222",
"head_of_household_customer_last_name": "RoshowLanguage222",
"head_of_household_customer_email": "444@222.com",
"external_id": 0,
"family_role": "Adult / Guardian"
}
],
"lat": 37.687655,
"lon": -122.090259
}
]
}
Retrieving data from ACTIVE Net Insights