Customers
Get customers
Returns a paginated list of Customer objects you created with the current status information on the customers.
get/customers/
Request
- Base URLhttps://api.trueaccord.com/api/v1
- Authnone declared
- TypeScriptA function with typed inputs. Its response is checked against the schema.
Query parameters
offsetinteger
Results returned offset from zero, with the 0th result being the first result.
countinteger
Number of results returned.
startTimeinteger
Milliseconds since Jan 1st, 1970 UTC.
Display only results created after the startTime value.
endTimeinteger
Milliseconds since Jan 1st, 1970 UTC.
Display only results created before the endTime value.
Response
Ok
Example response
{
"customers": [
{
"meta": {
"id": "3ef84ff19ddc",
"isActive": true
},
"dateOfBirth": {
"day": 6,
"month": 4,
"year": 2012
},
"addresses": [
{
"streetLine1": "101 N First St",
"streetLine2": "Apt 2",
"city": "San Jose",
"state": "CA",
"zipcode": "55555",
"countryCode": "US"
}
],
"emails": [
{
"email": "example@trueaccord.com"
}
],
"comments": [
{
"comment": "Transaction failed due to insufficient funds."
}
],
"reference": "MyRef",
"debts": [
{
"initialPrincipal": {
"amount": 30000,
"currency": "USD"
},
"initialInterest": {
"amount": 30000,
"currency": "USD"
},
"initialFees": {
"amount": 30000,
"currency": "USD"
},
"postChargeOffInformation": {
"balanceAtChargeOff": {
"amount": 30000,
"currency": "USD"
},
"feesAccruedSinceChargeOff": {
"amount": 30000,
"currency": "USD"
},
"interestAccruedSinceChargeOff": {
"amount": 30000,
"currency": "USD"
},
"totalPaidSinceChargeOff": {
"amount": 30000,
"currency": "USD"
}
}
}
],
"ssn": "123456789"
}
]
}Changes
No recorded changes to this operation across all 1 revision of this API.