## List members

`$ lightfield member list`

**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

- `--limit: optional number`

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

- `--offset: optional number`

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

### Returns

- `member_list_response: object { data, object, totalCount }`

  - `data: array of object { id, createdAt, fields, 3 more }`

    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: object { "$email", "$name", "$profileImage", "$role" }`

      Map of field names to their typed values.

      - `$email: object { value, valueType }`

        The member's email address.

        - `value: string`

          The field value.

        - `valueType: "EMAIL"`

          The data type of the field value.

          - `"EMAIL"`

      - `$name: object { value, valueType }`

        The member's full name.

        - `value: object { firstName, lastName }`

          - `firstName: optional string`

            The contact's first name.

          - `lastName: optional string`

            The contact's last name.

        - `valueType: "FULL_NAME"`

          The data type of the field value.

          - `"FULL_NAME"`

      - `$profileImage: object { value, valueType }`

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

        - `value: string`

          The field value, or null if unset.

        - `valueType: "URL"`

          The data type of the field value.

          - `"URL"`

      - `$role: object { value, valueType }`

        The member's workspace role.

        - `value: string`

          The field value.

        - `valueType: "TEXT"`

          The data type of the field value.

          - `"TEXT"`

    - `httpLink: string`

      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`

      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

```cli
lightfield member list \
  --api-key 'My API Key'
```

#### Response

```json
{
  "data": [
    {
      "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"
    }
  ],
  "object": "object",
  "totalCount": 0
}
```