Retrieve a member

member.retrieve() -> MemberRetrieveResponse

GET/v1/members/{id}

Retrieves a single member by their ID.

Required scope: members:read

Rate limit category: Read

ParametersExpand Collapse

id: str

Unique identifier of the member to retrieve.

ReturnsExpand Collapse

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"

http_link: Optional[str]

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

Retrieve a member

from lightfield import Lightfield

client = Lightfield(
    api_key="My API Key",
)
member_retrieve_response = client.member.retrieve(
    "id",
)
print(member_retrieve_response.id)

{
  "id": "id",
  "createdAt": "createdAt",
  "fields": {
    "foo": {
      "value": "string",
      "valueType": "ADDRESS"
    }
  },
  "httpLink": "httpLink"
}

Returns Examples

{
  "id": "id",
  "createdAt": "createdAt",
  "fields": {
    "foo": {
      "value": "string",
      "valueType": "ADDRESS"
    }
  },
  "httpLink": "httpLink"
}