Get user account

Retrieve specific user account associated with specified AccountID

Requirements: Account Admin or 'Loyalty Accounts' privilege

GET /api/UserAccount/

Get user accounts

Requirements: Account Admin or 'Loyalty Accounts' privilege

Retrieve list of user accounts associated with specified AccountID. Numbers of records returned limited to specified 'Limit' parameter with a set max of 1000. Use 'LastID' parameter to resume from previous ID. Use 'Prev' parameter set to True for descending order and set to False for ascending order

Request

Path parameters

The ID of the FasCard account.

The AccountID can be either the database SysConfigID (e.g. '12') or the store ID. (e.g. F0002).

Query parameters

The number of records to return with a set max of 1000.

Use this parameter to resume from the previous ID.

Set to True for retrieving records prior to 'LastID' and set to False for records following 'LastID'. Records will always be returned in descending order.

Set to True for retrieving only UserAccounts with a set email address and set to False for retrieving only UserAccounts without a set email address. Leave 'hasEmail' parameter out to not filter by email and return all UserAccounts based on other parameters.

Use 'lastActivity' parameter for gathering UserAccounts with an activity at or newer than the specified datetime. Leave 'lastActivity' parameter out to not filter by last activity datetime and return all UserAccounts based on other parameters. The datetime is specified in ISO 8601 format
(e.g. YYYY-MM-DDThh:mm:ss for UTC or YYYY-MM-DDThh:mm:ss+/-hh:mm for specifying a local time offset)

Retrieve specific user account associated with specified AccountID and card number.

Retrieve specific user account associated with specified AccountID and email. Note any special characters need to be HTML encoded (e.g. '+' should be sent as %2B)

Response

Field Name	Type	Description	Notes

Field Name	Type	Description	Notes
`ID`	int	UserAccount Rec ID
`UserID`	int	User Rec ID
`EmailAddress`	string	Email address
`Name`	string	User name
`Addr1`	string	Address #1
`Addr2`	string	Address #2
`City`	string	City
`State`	string	State
`ZipCode`	string	Zip code
`MobilePhone`	string	Mobile phone
`Birthday`	DateTime	Birthday	May be NULL if n/a
`Language`	string	User's preferred language	"en" = English "es" = Spanish
`Employee`	bool	User is an employee
`Scheduled`	bool	User is a scheduled employee
`Balance`	Decimal	Account balance ($)
`Bonus`	Decimal	Account bonus ($)
`LoyaltyPoints`	int	Loyalty points	May be NULL if n/a
`FreeStarts`	int	Free start credits	May be NULL if n/a
`Discount`	float	User discount	May be NULL if n/a
`DiscountSource`	string	User discount source
`LastActivityDate`	DateTime	Date/time of last activity (UTC)
`LastLocationID`	int	Location Rec ID of last activity

GET /api/UserAccount/{accountID}