Skip to content
Lightfield Lightfield
API Reference

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: Dict[str, DataFields]

Map of field names to their typed values.

value: Union[str, float, bool, 3 more]

The field value, or null if unset.

Accepts one of the following:
str
float
bool
List[Union[str, float, bool, 3 more]]
Accepts one of the following:
str
float
bool
List[Optional[object]]
Dict[str, object]
Dict[str, Union[str, float, bool, 3 more]]
Accepts one of the following:
str
float
bool
List[Optional[object]]
Dict[str, object]
value_type: Literal["ADDRESS", "CHECKBOX", "CURRENCY", 11 more]

The data type of the field value.

Accepts one of the following:
"ADDRESS"
"CHECKBOX"
"CURRENCY"
"DATETIME"
"EMAIL"
"FULL_NAME"
"MARKDOWN"
"MULTI_SELECT"
"NUMBER"
"SINGLE_SELECT"
"SOCIAL_HANDLE"
"TELEPHONE"
"TEXT"
"URL"
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: Dict[str, Fields]

Map of field names to their typed values.

value: Union[str, float, bool, 3 more]

The field value, or null if unset.

Accepts one of the following:
str
float
bool
List[Union[str, float, bool, 3 more]]
Accepts one of the following:
str
float
bool
List[Optional[object]]
Dict[str, object]
Dict[str, Union[str, float, bool, 3 more]]
Accepts one of the following:
str
float
bool
List[Optional[object]]
Dict[str, object]
value_type: Literal["ADDRESS", "CHECKBOX", "CURRENCY", 11 more]

The data type of the field value.

Accepts one of the following:
"ADDRESS"
"CHECKBOX"
"CURRENCY"
"DATETIME"
"EMAIL"
"FULL_NAME"
"MARKDOWN"
"MULTI_SELECT"
"NUMBER"
"SINGLE_SELECT"
"SOCIAL_HANDLE"
"TELEPHONE"
"TEXT"
"URL"