Skip to content
Lightfield Lightfield
API Reference
Member

Retrieve a member

member.retrieve(strid) -> 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: 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.

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.

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": {
    "$email": {
      "value": "value",
      "valueType": "EMAIL"
    },
    "$name": {
      "value": {
        "firstName": "firstName",
        "lastName": "lastName"
      },
      "valueType": "FULL_NAME"
    },
    "$profileImage": {
      "value": "value",
      "valueType": "URL"
    },
    "$role": {
      "value": "value",
      "valueType": "TEXT"
    }
  },
  "httpLink": "httpLink",
  "relationships": {
    "$user": {
      "cardinality": "HAS_ONE",
      "objectType": "user",
      "values": [
        "string"
      ]
    }
  },
  "updatedAt": "updatedAt"
}
Returns Examples
{
  "id": "id",
  "createdAt": "createdAt",
  "fields": {
    "$email": {
      "value": "value",
      "valueType": "EMAIL"
    },
    "$name": {
      "value": {
        "firstName": "firstName",
        "lastName": "lastName"
      },
      "valueType": "FULL_NAME"
    },
    "$profileImage": {
      "value": "value",
      "valueType": "URL"
    },
    "$role": {
      "value": "value",
      "valueType": "TEXT"
    }
  },
  "httpLink": "httpLink",
  "relationships": {
    "$user": {
      "cardinality": "HAS_ONE",
      "objectType": "user",
      "values": [
        "string"
      ]
    }
  },
  "updatedAt": "updatedAt"
}