# Member

## Retrieve

`client.member.retrieve(stringid, RequestOptionsoptions?): 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: string`

  Unique identifier of the member to retrieve.

### Returns

- `MemberRetrieveResponse`

  - `id: string`

    Unique identifier for the member.

  - `createdAt: string`

    ISO 8601 timestamp of when the member was created.

  - `fields: Fields`

    Map of field names to their typed values.

    - `"$email": Email`

      The member's email address.

      - `value: string`

        The field value.

      - `valueType: "EMAIL"`

        The data type of the field value.

        - `"EMAIL"`

    - `"$name": Name`

      The member's full name.

      - `value: Value`

        - `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.

        - `"FULL_NAME"`

    - `"$profileImage": ProfileImage`

      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.

        - `"URL"`

    - `"$role": Role`

      The member's workspace role.

      - `value: string`

        The field value.

      - `valueType: "TEXT"`

        The data type of the field value.

        - `"TEXT"`

  - `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.

### Example

```typescript
import Lightfield from 'lightfield';

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

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

console.log(memberRetrieveResponse.id);
```

## List

`client.member.list(MemberListParamsquery?, RequestOptionsoptions?): MemberListResponse`

**get** `/v1/members`

Returns a paginated list of members in your workspace. Use `offset` and `limit` to paginate through results. See <u>[List endpoints](/using-the-api/list-endpoints/)</u> for more information about pagination.

**[Required scope](/using-the-api/scopes/):** `members:read`

**[Rate limit category](/using-the-api/rate-limits/):** Search

### Parameters

- `query: MemberListParams`

  - `limit?: number`

    Maximum number of records to return. Defaults to 25, maximum 25.

  - `offset?: number`

    Number of records to skip for pagination. Defaults to 0.

### Returns

- `MemberListResponse`

  - `data: Array<Data>`

    Array of member objects for the current page.

    - `id: string`

      Unique identifier for the member.

    - `createdAt: string`

      ISO 8601 timestamp of when the member was created.

    - `fields: Fields`

      Map of field names to their typed values.

      - `"$email": Email`

        The member's email address.

        - `value: string`

          The field value.

        - `valueType: "EMAIL"`

          The data type of the field value.

          - `"EMAIL"`

      - `"$name": Name`

        The member's full name.

        - `value: Value`

          - `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.

          - `"FULL_NAME"`

      - `"$profileImage": ProfileImage`

        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.

          - `"URL"`

      - `"$role": Role`

        The member's workspace role.

        - `value: string`

          The field value.

        - `valueType: "TEXT"`

          The data type of the field value.

          - `"TEXT"`

    - `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.

  - `object: string`

    The object type, always `"list"`.

  - `totalCount: number`

    Total number of members in the workspace.

### Example

```typescript
import Lightfield from 'lightfield';

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

const memberListResponse = await client.member.list();

console.log(memberListResponse.data);
```

## Domain Types

### Member List Response

- `MemberListResponse`

  - `data: Array<Data>`

    Array of member objects for the current page.

    - `id: string`

      Unique identifier for the member.

    - `createdAt: string`

      ISO 8601 timestamp of when the member was created.

    - `fields: Fields`

      Map of field names to their typed values.

      - `"$email": Email`

        The member's email address.

        - `value: string`

          The field value.

        - `valueType: "EMAIL"`

          The data type of the field value.

          - `"EMAIL"`

      - `"$name": Name`

        The member's full name.

        - `value: Value`

          - `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.

          - `"FULL_NAME"`

      - `"$profileImage": ProfileImage`

        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.

          - `"URL"`

      - `"$role": Role`

        The member's workspace role.

        - `value: string`

          The field value.

        - `valueType: "TEXT"`

          The data type of the field value.

          - `"TEXT"`

    - `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.

  - `object: string`

    The object type, always `"list"`.

  - `totalCount: number`

    Total number of members in the workspace.

### Member Retrieve Response

- `MemberRetrieveResponse`

  - `id: string`

    Unique identifier for the member.

  - `createdAt: string`

    ISO 8601 timestamp of when the member was created.

  - `fields: Fields`

    Map of field names to their typed values.

    - `"$email": Email`

      The member's email address.

      - `value: string`

        The field value.

      - `valueType: "EMAIL"`

        The data type of the field value.

        - `"EMAIL"`

    - `"$name": Name`

      The member's full name.

      - `value: Value`

        - `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.

        - `"FULL_NAME"`

    - `"$profileImage": ProfileImage`

      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.

        - `"URL"`

    - `"$role": Role`

      The member's workspace role.

      - `value: string`

        The field value.

      - `valueType: "TEXT"`

        The data type of the field value.

        - `"TEXT"`

  - `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.