---
title: "List account members"
method: GET
path: "/api/v2/members"
tags: ["Account members"]
---

# List account members

`GET /api/v2/members`

Return a list of account members.

By default, this returns the first 20 members. Page through this list with the `limit` parameter and by following the `first`, `prev`, `next`, and `last` links in the returned `_links` field. These links are not present if the pages they refer to don't exist. For example, the `first` and `prev` links will be missing from the response on the first page.

### Filtering members

LaunchDarkly supports the following fields for filters:

- `query` is a string that matches against the members' emails and names. It is not case sensitive.
- `role` is a `|` separated list of roles and custom roles. It filters the list to members who have any of the roles in the list. For the purposes of this filtering, `Owner` counts as `Admin`.
- `id` is a `|` separated list of member IDs. It filters the list to members who match any of the IDs in the list.
- `email` is a `|` separated list of member emails. It filters the list to members who match any of the emails in the list.
- `team` is a string that matches against the key of the teams the members belong to. It is not case sensitive.
- `noteam` is a boolean that filters the list of members who are not on a team if true and members on a team if false.
- `lastSeen` is a JSON object in one of the following formats:
  - `{"never": true}` - Members that have never been active, such as those who have not accepted their invitation to LaunchDarkly, or have not logged in after being provisioned via SCIM.
  - `{"noData": true}` - Members that have not been active since LaunchDarkly began recording last seen timestamps.
  - `{"before": 1608672063611}` - Members that have not been active since the provided value, which should be a timestamp in Unix epoch milliseconds.
- `accessCheck` is a string that represents a specific action on a specific resource and is in the format `<ActionSpecifier>:<ResourceSpecifier>`. It filters the list to members who have the ability to perform that action on that resource. Note: `accessCheck` is only supported in API version `20220603` and earlier. To learn more, read [Versioning](https://launchdarkly.com/docs/api#versioning).
  - For example, the filter `accessCheck:createApprovalRequest:proj/default:env/test:flag/alternate-page` matches members with the ability to create an approval request for the `alternate-page` flag in the `test` environment of the `default` project.
  - Wildcard and tag filters are not supported when filtering for access.

For example, the filter `query:abc,role:admin|customrole` matches members with the string `abc` in their email or name, ignoring case, who also are either an `Owner` or `Admin` or have the custom role `customrole`.

### Sorting members

LaunchDarkly supports two fields for sorting: `displayName` and `lastSeen`:

- `displayName` sorts by first + last name, using the member's email if no name is set.
- `lastSeen` sorts by the `_lastSeen` property. LaunchDarkly considers members that have never been seen or have no data the oldest.

### Expanding the members response
LaunchDarkly supports two fields for expanding the "List members" response. By default, these fields are **not** included in the response.

To expand the response, append the `expand` query parameter and add a comma-separated list with any of the following fields:

* `customRoles` includes a list of the roles that you have assigned to the member.
* `roleAttributes` includes a list of the role attributes that you have assigned to the member.

For example, `expand=roleAttributes` includes `roleAttributes` field in the response.

## Query parameters

- `limit` integer — The number of members to return in the response. Defaults to 20.
- `offset` integer — Where to start in the list. This is for use with pagination. For example, an offset of 10 skips the first ten items and then returns the next items in the list, up to the query `limit`.
- `filter` string, string — A comma-separated list of filters. Each filter is of the form `field:value`. Supported fields are explained above.
- `expand` string, string — A comma-separated list of properties that can reveal additional information in the response.
- `sort` string, string — A comma-separated list of fields to sort by. Fields prefixed by a dash ( - ) sort in descending order.

## Response `200`

Members collection response

- Members
  - `items` Member[], required — An array of members
    - `_links` object, required — The location and content type of related resources
    - `_id` string, required — The member's ID
    - `firstName` string — The member's first name
    - `lastName` string — The member's last name
    - `role` string, required — The member's base role. If the member has no additional roles, this role will be in effect.
    - `email` string, required — The member's email address
    - `_pendingInvite` boolean, required — Whether the member has a pending invitation
    - `_verified` boolean, required — Whether the member's email address has been verified
    - `_pendingEmail` string — The member's email address before it has been verified, for accounts where email verification is required
    - `customRoles` string[], required — The set of additional roles, besides the base role, assigned to the member
    - `mfa` string, required — Whether multi-factor authentication is enabled for this member
    - `excludedDashboards` string[] — Default dashboards that the member has chosen to ignore
    - `_lastSeen` integer, required
    - `_lastSeenMetadata` LastSeenMetadata
      - `tokenId` string — The ID of the token used in the member's last session
    - `_integrationMetadata` IntegrationMetadata
      - `externalId` string, required
      - `externalStatus` IntegrationStatus, required
        - `display` string, required
        - `value` string, required
      - `externalUrl` string, required
      - `lastChecked` integer, required
    - `teams` MemberTeamSummaryRep[] — Details on the teams this member is assigned to
      - `customRoleKeys` string[], required — A list of keys of the custom roles this team has access to
      - `key` string, required — The team key
      - `_links` object
      - `name` string, required — The team name
    - `permissionGrants` MemberPermissionGrantSummaryRep[] — A list of permission grants. Permission grants allow a member to have access to a specific action, without having to create or update a custom role.
      - `actionSet` string — The name of the group of related actions to allow. A permission grant may have either an <code>actionSet</code> or a list of <code>actions</code> but not both at the same time.
      - `actions` string[] — A list of actions to allow. A permission grant may have either an <code>actionSet</code> or a list of <code>actions</code> but not both at the same time.
      - `resource` string, required — The resource for which the actions are allowed
    - `creationDate` integer, required
    - `oauthProviders` OAuthProviderKind[] — A list of OAuth providers
    - `version` integer — Version of the current configuration
    - `roleAttributes` RoleAttributeMap
  - `_links` object, required — The location and content type of related resources
  - `totalCount` integer — The number of members returned

## Other responses

- `401` — Invalid access token
- `403` — Forbidden
- `404` — Invalid resource identifier
- `429` — Rate limited

---

[API](https://skmtc.dev/launchdarkly/apis/launchdarkly-rest-api.md) · [All operations](https://skmtc.dev/launchdarkly/apis/launchdarkly-rest-api/llms.txt) · [OpenAPI document](https://skmtc-service-production.skmtc.workers.dev/v1/apis/launchdarkly/launchdarkly-rest-api/revisions/69c5c9aafe78/schema)