Account Lists
Account Lists Documentation
Account List [LIST]
Account List [LIST]
Request
Endpoint
Body
Parameters
Sorts
name
Type Unknown
Description sort by account list name
Required No
Filters
organization_id
Type ID string
Description filter where account list has a designation account belonging to an organization; Accepts IDs separated by comma
Required No
wildcard_search
Type string
Description filter where account list by user's/coach's first name, last name, email, by the account list name, or by the invite recipient email
Required No
Response
Headers
Body
Fields
data
Type
[AccountList]
Description An array of account lists
Account List [GET]
Account List [GET]
Request
Endpoint
Body
Response
Headers
Body
Fields
Attributes
created_at
Type
date
Description The timestamp of when this resource was created
name
Type
string
Description name of the account list
updated_at
Type
date
Description The timestamp of when this resource was last updated
updated_in_db_at
Type
date
Description This is to be used as a reference for the last time the resource was updated in the remote database - specifically for when data is updated while the client is offline.
Relationships
account_list_coaches.data
Type
["AccountListCoach"]
Description collection of account_list_coaches
account_list_invites.data
Type
["AccountListInvite"]
Description collection of account_list_invites that are active and have not already been accepted
account_list_users.data
Type
["AccountListUser"]
Description collection of account_list_users
designation_accounts.data
Type
["AccountListUser"]
Description collection of designation_accounts
Last updated