List account members

curl --request GET \
  --url https://app.launchdarkly.com/api/v2/members \
  --header 'Authorization: <api-key>'

const options = {method: 'GET', headers: {Authorization: '<api-key>'}};

fetch('https://app.launchdarkly.com/api/v2/members', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://app.launchdarkly.com/api/v2/members",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: <api-key>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://app.launchdarkly.com/api/v2/members"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Authorization", "<api-key>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://app.launchdarkly.com/api/v2/members")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["Authorization"] = '<api-key>'

response = http.request(request)
puts response.read_body

{
  "items": [
    {
      "_links": {},
      "_id": "507f1f77bcf86cd799439011",
      "role": "reader",
      "email": "ariel@acme.com",
      "_pendingInvite": false,
      "_verified": true,
      "customRoles": [
        "devOps",
        "backend-devs"
      ],
      "mfa": "<string>",
      "_lastSeen": "1608260796147",
      "creationDate": "1628001602644",
      "firstName": "Ariel",
      "lastName": "Flores",
      "_pendingEmail": "<string>",
      "excludedDashboards": [
        "<string>"
      ],
      "_lastSeenMetadata": {
        "tokenId": "5b52207f8ca8e631d31fdb2b"
      },
      "_integrationMetadata": {
        "externalId": "<string>",
        "externalStatus": {
          "display": "<string>",
          "value": "<string>"
        },
        "externalUrl": "<string>",
        "lastChecked": 123
      },
      "teams": [
        {
          "customRoleKeys": [
            "access-to-test-projects"
          ],
          "key": "team-key-123abc",
          "name": "QA Team",
          "_links": {}
        }
      ],
      "permissionGrants": [
        {
          "resource": "team/qa-team",
          "actionSet": "<string>",
          "actions": [
            "maintainTeam"
          ]
        }
      ],
      "oauthProviders": [
        "<string>"
      ],
      "hasPassword": true,
      "version": 1,
      "roleAttributes": {},
      "mfaEnforced": true,
      "mfaGracePeriodExpiresAt": 123
    }
  ],
  "_links": {},
  "totalCount": 123
}

{
  "code": "unauthorized",
  "message": "Invalid access token"
}

{
  "code": "forbidden",
  "message": "Forbidden. Access to the requested resource was denied."
}

{
  "code": "not_found",
  "message": "Invalid resource identifier"
}

{
  "code": "rate_limited",
  "message": "You've exceeded the API rate limit. Try again later."
}

List account 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.
- 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.

GET

api

members

List account members

curl --request GET \
  --url https://app.launchdarkly.com/api/v2/members \
  --header 'Authorization: <api-key>'

const options = {method: 'GET', headers: {Authorization: '<api-key>'}};

fetch('https://app.launchdarkly.com/api/v2/members', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://app.launchdarkly.com/api/v2/members",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: <api-key>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://app.launchdarkly.com/api/v2/members"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Authorization", "<api-key>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://app.launchdarkly.com/api/v2/members")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["Authorization"] = '<api-key>'

response = http.request(request)
puts response.read_body

{
  "items": [
    {
      "_links": {},
      "_id": "507f1f77bcf86cd799439011",
      "role": "reader",
      "email": "ariel@acme.com",
      "_pendingInvite": false,
      "_verified": true,
      "customRoles": [
        "devOps",
        "backend-devs"
      ],
      "mfa": "<string>",
      "_lastSeen": "1608260796147",
      "creationDate": "1628001602644",
      "firstName": "Ariel",
      "lastName": "Flores",
      "_pendingEmail": "<string>",
      "excludedDashboards": [
        "<string>"
      ],
      "_lastSeenMetadata": {
        "tokenId": "5b52207f8ca8e631d31fdb2b"
      },
      "_integrationMetadata": {
        "externalId": "<string>",
        "externalStatus": {
          "display": "<string>",
          "value": "<string>"
        },
        "externalUrl": "<string>",
        "lastChecked": 123
      },
      "teams": [
        {
          "customRoleKeys": [
            "access-to-test-projects"
          ],
          "key": "team-key-123abc",
          "name": "QA Team",
          "_links": {}
        }
      ],
      "permissionGrants": [
        {
          "resource": "team/qa-team",
          "actionSet": "<string>",
          "actions": [
            "maintainTeam"
          ]
        }
      ],
      "oauthProviders": [
        "<string>"
      ],
      "hasPassword": true,
      "version": 1,
      "roleAttributes": {},
      "mfaEnforced": true,
      "mfaGracePeriodExpiresAt": 123
    }
  ],
  "_links": {},
  "totalCount": 123
}

{
  "code": "unauthorized",
  "message": "Invalid access token"
}

{
  "code": "forbidden",
  "message": "Forbidden. Access to the requested resource was denied."
}

{
  "code": "not_found",
  "message": "Invalid resource identifier"
}

{
  "code": "rate_limited",
  "message": "You've exceeded the API rate limit. Try again later."
}

Authorizations

Authorization

string

header

required

Query Parameters

limit

integer<int64>

The number of members to return in the response. Defaults to 20.

offset

integer<int64>

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

Members collection response

items

object[]

required

An array of members

Show child attributes

_links

object

required

The location and content type of related resources

Show child attributes

totalCount

integer

The number of members returned