GroupAccountModel

Represents an account for an entire group

Methods

The following API methods use this data model.

• Retrieve Group Account Data
• Update Group Account

Read-Only Fields

These fields are assigned by the API server and cannot be changed.

groupKey

uuid, read-only

The GroupKey uniquely identifies a single Lockstep Platform account. All records for this
account will share the same GroupKey value. GroupKey values cannot be changed once created.

For more information, see Accounts and GroupKeys.

created

date-time, read-only

The date this group account was created

createdUserId

uuid, read-only

The ID of the user who created this group account

modified

date-time, read-only

The date this group account was last modified

modifiedUserId

uuid, read-only

The ID of the user who last modified this group account

Required Fields

primaryUserId

uuid

The primary user for the group

groupCompanyId

uuid

The CompanyId of the Company the group is associated with

isActive

boolean

The active status of the group

onboardingScheduled

boolean

The onboarding session status of the group

Optional Fields

groupName

string, nullable, 0-99 characters

The name of the group