Retrieve a member

client.member.retrieve(, ?): MemberRetrieveResponse { id, createdAt, fields, 3 more }

GET/v1/members/{id}

Retrieves a single member by their ID.

Required scope: members:read

Rate limit category: Read

ParametersExpand Collapse

id: string

Unique identifier of the member to retrieve.

ReturnsExpand Collapse

MemberRetrieveResponse { id, createdAt, fields, 3 more }

id: string

Unique identifier for the member.

createdAt: string

ISO 8601 timestamp of when the member was created.

fields: Fields { $email, $name, $profileImage, $role }

Map of field names to their typed values.

"$email": Email { value, valueType }

The member's email address.

value: string

The field value.

valueType: "EMAIL"

The data type of the field value.

"$name": Name { value, valueType }

The member's full name.

value: Value { firstName, lastName }

firstName?: string | null

The contact's first name.

lastName?: string | null

The contact's last name.

valueType: "FULL_NAME"

The data type of the field value.

"$profileImage": ProfileImage { value, valueType }

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

value: string | null

The field value, or null if unset.

valueType: "URL"

The data type of the field value.

"$role": Role { value, valueType }

The member's workspace role.

value: string

The field value.

valueType: "TEXT"

The data type of the field value.

httpLink: string | null

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

relationships: unknown

Members do not expose writable or readable relationships in this API.

updatedAt: string | null

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

Retrieve a member

import Lightfield from 'lightfield';

const client = new Lightfield({
  apiKey: 'My API Key',
});

const memberRetrieveResponse = await client.member.retrieve('id');

console.log(memberRetrieveResponse.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": {},
  "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": {},
  "updatedAt": "updatedAt"
}