# Member ## Retrieve `member.retrieve(strid) -> MemberRetrieveResponse` **get** `/v1/members/{id}` Retrieves a single member by their ID. **[Required scope](/using-the-api/scopes/):** `members:read` **[Rate limit category](/using-the-api/rate-limits/):** Read ### Parameters - `id: str` Unique identifier of the member to retrieve. ### Returns - `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. - `str` - `float` - `bool` - `List[Union[str, float, bool, 3 more]]` - `str` - `float` - `bool` - `List[Optional[object]]` - `Dict[str, object]` - `Dict[str, Union[str, float, bool, 3 more]]` - `str` - `float` - `bool` - `List[Optional[object]]` - `Dict[str, object]` - `value_type: Literal["ADDRESS", "CHECKBOX", "CURRENCY", 11 more]` The data type of the field value. - `"ADDRESS"` - `"CHECKBOX"` - `"CURRENCY"` - `"DATETIME"` - `"EMAIL"` - `"FULL_NAME"` - `"MARKDOWN"` - `"MULTI_SELECT"` - `"NUMBER"` - `"SINGLE_SELECT"` - `"SOCIAL_HANDLE"` - `"TELEPHONE"` - `"TEXT"` - `"URL"` - `http_link: Optional[str]` URL to view the member in the Lightfield web app, or null. ### Example ```python from lightfield import Lightfield client = Lightfield( api_key="My API Key", ) member_retrieve_response = client.member.retrieve( "id", ) print(member_retrieve_response.id) ``` ## List `member.list(MemberListParams**kwargs) -> MemberListResponse` **get** `/v1/members` Returns a paginated list of members in your workspace. Use `offset` and `limit` to paginate through results. See [List endpoints](/using-the-api/list-endpoints/) for more information about pagination. **[Required scope](/using-the-api/scopes/):** `members:read` **[Rate limit category](/using-the-api/rate-limits/):** Search ### Parameters - `limit: Optional[int]` Maximum number of records to return. Defaults to 25, maximum 25. - `offset: Optional[int]` Number of records to skip for pagination. Defaults to 0. ### Returns - `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. - `str` - `float` - `bool` - `List[Union[str, float, bool, 3 more]]` - `str` - `float` - `bool` - `List[Optional[object]]` - `Dict[str, object]` - `Dict[str, Union[str, float, bool, 3 more]]` - `str` - `float` - `bool` - `List[Optional[object]]` - `Dict[str, object]` - `value_type: Literal["ADDRESS", "CHECKBOX", "CURRENCY", 11 more]` The data type of the field value. - `"ADDRESS"` - `"CHECKBOX"` - `"CURRENCY"` - `"DATETIME"` - `"EMAIL"` - `"FULL_NAME"` - `"MARKDOWN"` - `"MULTI_SELECT"` - `"NUMBER"` - `"SINGLE_SELECT"` - `"SOCIAL_HANDLE"` - `"TELEPHONE"` - `"TEXT"` - `"URL"` - `http_link: Optional[str]` URL to view the member in the Lightfield web app, or null. - `object: str` The object type, always `"list"`. - `total_count: int` Total number of members in the workspace. ### Example ```python from lightfield import Lightfield client = Lightfield( api_key="My API Key", ) member_list_response = client.member.list() print(member_list_response.data) ``` ## Domain Types ### Member List Response - `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. - `str` - `float` - `bool` - `List[Union[str, float, bool, 3 more]]` - `str` - `float` - `bool` - `List[Optional[object]]` - `Dict[str, object]` - `Dict[str, Union[str, float, bool, 3 more]]` - `str` - `float` - `bool` - `List[Optional[object]]` - `Dict[str, object]` - `value_type: Literal["ADDRESS", "CHECKBOX", "CURRENCY", 11 more]` The data type of the field value. - `"ADDRESS"` - `"CHECKBOX"` - `"CURRENCY"` - `"DATETIME"` - `"EMAIL"` - `"FULL_NAME"` - `"MARKDOWN"` - `"MULTI_SELECT"` - `"NUMBER"` - `"SINGLE_SELECT"` - `"SOCIAL_HANDLE"` - `"TELEPHONE"` - `"TEXT"` - `"URL"` - `http_link: Optional[str]` URL to view the member in the Lightfield web app, or null. - `object: str` The object type, always `"list"`. - `total_count: int` Total number of members in the workspace. ### Member Retrieve Response - `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. - `str` - `float` - `bool` - `List[Union[str, float, bool, 3 more]]` - `str` - `float` - `bool` - `List[Optional[object]]` - `Dict[str, object]` - `Dict[str, Union[str, float, bool, 3 more]]` - `str` - `float` - `bool` - `List[Optional[object]]` - `Dict[str, object]` - `value_type: Literal["ADDRESS", "CHECKBOX", "CURRENCY", 11 more]` The data type of the field value. - `"ADDRESS"` - `"CHECKBOX"` - `"CURRENCY"` - `"DATETIME"` - `"EMAIL"` - `"FULL_NAME"` - `"MARKDOWN"` - `"MULTI_SELECT"` - `"NUMBER"` - `"SINGLE_SELECT"` - `"SOCIAL_HANDLE"` - `"TELEPHONE"` - `"TEXT"` - `"URL"` - `http_link: Optional[str]` URL to view the member in the Lightfield web app, or null.