---
title: "List members"
method: GET
path: "/v1/members"
---

# List members

`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

## Query parameters

- `offset` integer — Number of records to skip for pagination. Defaults to 0.
- `limit` integer — Maximum number of records to return. Defaults to 25, maximum 25.

## Headers

- `Lightfield-Version` '2026-03-01', required

## Response `200`

OK

- MemberListResponse
  - `object` string, required — The object type, always `"list"`.
  - `data` object[], required — Array of member objects for the current page.
    - `id` string, required — Unique identifier for the member.
    - `createdAt` string, required — ISO 8601 timestamp of when the member was created.
    - `updatedAt` string, nullable, required — ISO 8601 timestamp of when the member was last updated, or null.
    - `httpLink` string, nullable, required — URL to view the member in the Lightfield web app, or null.
    - `fields` object, required — Map of field names to their typed values.
      - `$email` object, required — The member's email address.
        - `value` string, required — The field value.
        - `valueType` 'EMAIL', required — The data type of the field value.
      - `$name` object, required — The member's full name.
        - `value` FullName, required
          - `firstName` string, nullable — The contact's first name.
          - `lastName` string, nullable — The contact's last name.
        - `valueType` 'FULL_NAME', required — The data type of the field value.
      - `$profileImage` object, required — URL of the member's profile image, or null if unset.
        - `value` string, nullable, required — The field value, or null if unset.
        - `valueType` 'URL', required — The data type of the field value.
      - `$role` object, required — The member's workspace role.
        - `value` string, required — The field value.
        - `valueType` 'TEXT', required — The data type of the field value.
    - `relationships` object, required — Map of relationship names to their associated entities.
      - `$user` object, required — The underlying user record for this workspace member.
        - `cardinality` 'HAS_ONE', required — Whether the relationship is has_one or has_many.
        - `objectType` 'user', required — The type of the related object.
        - `values` string[], required — IDs of the related users.
  - `totalCount` integer, required — Total number of members in the workspace.

## Other responses

- `400` — 400
- `401` — 401
- `403` — 403
- `404` — 404
- `409` — 409
- `415` — 415
- `422` — 422
- `429` — 429
- `500` — 500
- `501` — 501
- `503` — 503
- `504` — 504

---

[API](https://skmtc.net/lightfld/apis/api-reference.md) · [All operations](https://skmtc.net/lightfld/apis/api-reference/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/lightfld/api-reference/versions/93b6c5de5463/schema)