API ReferenceCustomers

List Customers

List all customers

Query parameters

fieldsstringOptionalformat: "^([a-zA-Z\.],?)+$"
Specific fields requested in the response. Defaults to all fields.
sortstringOptionalformat: "^([a-zA-Z]+(:(asc|desc)+)?,?)+$"

CSV of sort value pairs by field (eg. date:asc). Sorts descending date fields by default and ascending elsewhere

filterstringOptional

Filter expression as defined by Fortress Query Language (FQL)

pageintegerOptionalDefaults to 0
the page number when used with pagination, defaults to 0
limitintegerOptionalDefaults to 10

How many items to return at one time (default 10)

Response

A paged array of customers
assetslist of objects or null
attachmentslist of objects or null
birthDatestring or nullformat: "date"
createdAtdatetime or null
deletedAtdatetime or null
emailstring or null
firstNamestring or null
genderstring or null
glEntrieslist of objects or null
headOfHouseholdboolean or null
Indicates whether the customer is the head of household
householdobject or null
householdIdstring or nullformat: "uuid"
idstring or nullformat: "uuid"
idempotencyIdstring or nullformat: "uuid"
lastNamestring or null
middleNamestring or null
organizationIdstring or nullformat: "uuid"
phonestring or null
preferredNamestring or null
propertyobject or null
propertyIdstring or nullformat: "uuid"
readableIdstring or null
relationshipenum or null

Relationship of the customer to the head of household (null for head of household)

reversalslist of objects or null
statusenum or null
Allowed values:
suffixstring or null
transactionslist of objects or null
updatedAtdatetime or null
workOrderslist of objects or null