API Reference

Copy Markdown

Open in Claude

Open in ChatGPT

Open in Cursor

---

Copy Markdown

View as Markdown

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

member.retrieve(strid) -> MemberRetrieveResponse

GET/v1/members/{id}

List members

member.list(MemberListParams**kwargs) -> MemberListResponse

GET/v1/members

ModelsExpand Collapse

class MemberListResponse: …

data: List[Data]

Array of member objects for the current page.

id: str

Unique identifier for the member.

created_at: str

ISO 8601 timestamp of when the member was created.

fields: DataFields

Map of field names to their typed values.

email: DataFieldsEmail

The member’s email address.

value: str

The field value.

value_type: Literal["EMAIL"]

The data type of the field value.

name: DataFieldsName

The member’s full name.

value: DataFieldsNameValue

first_name: Optional[str]

The contact’s first name.

last_name: Optional[str]

The contact’s last name.

value_type: Literal["FULL_NAME"]

The data type of the field value.

profile_image: DataFieldsProfileImage

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

value: Optional[str]

The field value, or null if unset.

value_type: Literal["URL"]

The data type of the field value.

role: DataFieldsRole

The member’s workspace role.

value: str

The field value.

value_type: Literal["TEXT"]

The data type of the field value.

http_link: Optional[str]

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

relationships: DataRelationships

Map of relationship names to their associated entities.

user: DataRelationshipsUser

The underlying user record for this workspace member.

cardinality: Literal["HAS_ONE"]

Whether the relationship is has_one or has_many.

object_type: Literal["user"]

The type of the related object.

values: List[str]

IDs of the related users.

updated_at: Optional[str]

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

object: str

The object type, always "list".

total_count: int

Total number of members in the workspace.

minimum0

maximum9007199254740991

class MemberRetrieveResponse: …

id: str

Unique identifier for the member.

created_at: str

ISO 8601 timestamp of when the member was created.

fields: Fields

Map of field names to their typed values.

email: FieldsEmail

The member’s email address.

value: str

The field value.

value_type: Literal["EMAIL"]

The data type of the field value.

name: FieldsName

The member’s full name.

value: FieldsNameValue

first_name: Optional[str]

The contact’s first name.

last_name: Optional[str]

The contact’s last name.

value_type: Literal["FULL_NAME"]

The data type of the field value.

profile_image: FieldsProfileImage

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

value: Optional[str]

The field value, or null if unset.

value_type: Literal["URL"]

The data type of the field value.

role: FieldsRole

The member’s workspace role.

value: str

The field value.

value_type: Literal["TEXT"]

The data type of the field value.

http_link: Optional[str]

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

relationships: Relationships

Map of relationship names to their associated entities.

user: RelationshipsUser

The underlying user record for this workspace member.

cardinality: Literal["HAS_ONE"]

Whether the relationship is has_one or has_many.

object_type: Literal["user"]

The type of the related object.

values: List[str]

IDs of the related users.

updated_at: Optional[str]

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