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.Get(ctx, id) (*MemberRetrieveResponse, error)

GET/v1/members/{id}

List members

client.Member.List(ctx, query) (*MemberListResponse, error)

GET/v1/members

ModelsExpand Collapse

type MemberListResponse struct{…}

Data []MemberListResponseData

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 MemberListResponseDataFields

Map of field names to their typed values.

Email MemberListResponseDataFieldsEmail

The member’s email address.

Value string

The field value.

ValueType string

The data type of the field value.

Name MemberListResponseDataFieldsName

The member’s full name.

Value MemberListResponseDataFieldsNameValue

FirstName stringOptional

The contact’s first name.

LastName stringOptional

The contact’s last name.

ValueType string

The data type of the field value.

ProfileImage MemberListResponseDataFieldsProfileImage

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

Value string

The field value, or null if unset.

ValueType string

The data type of the field value.

Role MemberListResponseDataFieldsRole

The member’s workspace role.

Value string

The field value.

ValueType string

The data type of the field value.

HTTPLink string

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

Relationships any

Members do not expose writable or readable relationships in this API.

UpdatedAt string

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

Object string

The object type, always "list".

TotalCount int64

Total number of members in the workspace.

minimum0

maximum9007199254740991

type MemberRetrieveResponse struct{…}

ID string

Unique identifier for the member.

CreatedAt string

ISO 8601 timestamp of when the member was created.

Fields MemberRetrieveResponseFields

Map of field names to their typed values.

Email MemberRetrieveResponseFieldsEmail

The member’s email address.

Value string

The field value.

ValueType string

The data type of the field value.

Name MemberRetrieveResponseFieldsName

The member’s full name.

Value MemberRetrieveResponseFieldsNameValue

FirstName stringOptional

The contact’s first name.

LastName stringOptional

The contact’s last name.

ValueType string

The data type of the field value.

ProfileImage MemberRetrieveResponseFieldsProfileImage

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

Value string

The field value, or null if unset.

ValueType string

The data type of the field value.

Role MemberRetrieveResponseFieldsRole

The member’s workspace role.

Value string

The field value.

ValueType string

The data type of the field value.

HTTPLink string

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

Relationships any

Members do not expose writable or readable relationships in this API.

UpdatedAt string

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