Member

Members represent users in your Lightfield workspace. Members can own accounts and opportunities, and are referenced in relationships like $owner and $createdBy.

Retrieve a member

client.member.retrieve(, ?): MemberRetrieveResponse { id, createdAt, fields, 3 more }

GET/v1/members/{id}

List members

client.member.list(?, ?): MemberListResponse { data, object, totalCount }

GET/v1/members

ModelsExpand Collapse

MemberListResponse { data, object, totalCount }

data: Array<Data>

Array of member objects for the current page.

id: string

Unique identifier for the member.

createdAt: string

ISO 8601 timestamp of when the member was created.

fields: Fields { $email, $name, $profileImage, $role }

Map of field names to their typed values.

"$email": Email { value, valueType }

The member’s email address.

value: string

The field value.

valueType: "EMAIL"

The data type of the field value.

"$name": Name { value, valueType }

The member’s full name.

value: Value { firstName, lastName }

firstName?: string | null

The contact’s first name.

lastName?: string | null

The contact’s last name.

valueType: "FULL_NAME"

The data type of the field value.

"$profileImage": ProfileImage { value, valueType }

URL of the member’s profile image, or null if unset.

value: string | null

The field value, or null if unset.

valueType: "URL"

The data type of the field value.

"$role": Role { value, valueType }

The member’s workspace role.

value: string

The field value.

valueType: "TEXT"

The data type of the field value.

httpLink: string | null

URL to view the member in the Lightfield web app, or null.

relationships: Relationships { $user }

Map of relationship names to their associated entities.

"$user": User { cardinality, objectType, values }

The underlying user record for this workspace member.

cardinality: "HAS_ONE"

Whether the relationship is has_one or has_many.

objectType: "user"

The type of the related object.

values: Array<string>

IDs of the related users.

updatedAt: string | null

ISO 8601 timestamp of when the member was last updated, or null.

object: string

The object type, always "list".

totalCount: number

Total number of members in the workspace.

minimum0

maximum9007199254740991

MemberRetrieveResponse { id, createdAt, fields, 3 more }

id: string

Unique identifier for the member.

createdAt: string

ISO 8601 timestamp of when the member was created.

fields: Fields { $email, $name, $profileImage, $role }

Map of field names to their typed values.

"$email": Email { value, valueType }

The member’s email address.

value: string

The field value.

valueType: "EMAIL"

The data type of the field value.

"$name": Name { value, valueType }

The member’s full name.

value: Value { firstName, lastName }

firstName?: string | null

The contact’s first name.

lastName?: string | null

The contact’s last name.

valueType: "FULL_NAME"

The data type of the field value.

"$profileImage": ProfileImage { value, valueType }

URL of the member’s profile image, or null if unset.

value: string | null

The field value, or null if unset.

valueType: "URL"

The data type of the field value.

"$role": Role { value, valueType }

The member’s workspace role.

value: string

The field value.

valueType: "TEXT"

The data type of the field value.

httpLink: string | null

URL to view the member in the Lightfield web app, or null.

relationships: Relationships { $user }

Map of relationship names to their associated entities.

"$user": User { cardinality, objectType, values }

The underlying user record for this workspace member.

cardinality: "HAS_ONE"

Whether the relationship is has_one or has_many.

objectType: "user"

The type of the related object.

values: Array<string>

IDs of the related users.

updatedAt: string | null

ISO 8601 timestamp of when the member was last updated, or null.