List projects

For the complete documentation index, see llms.txt. For the full documentation snapshot, see llms-full.txt.

Return a list of projects.

By default, this returns the first 20 projects. Page through this list with the limit parameter and by following the first, prev, next, and last links in the _links field that returns. If those links do not appear, 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, because there is no previous page and you cannot return to the first page when you are already on the first page.

Filtering projects

LaunchDarkly supports three fields for filters:

• query is a string that matches against the projects’ names and keys. It is not case sensitive.
• tags is a +-separated list of project tags. It filters the list of projects that have all of the tags in the list.
• keys is a | separated list of project keys. It filters the list to projects that have any of the keys in the list.

For example, the filter filter=query:abc,tags:tag-1+tag-2 matches projects with the string abc in their name or key and also are tagged with tag-1 and tag-2. The filter is not case-sensitive.

The documented values for filter query parameters are prior to URL encoding. For example, the + in filter=tags:tag-1+tag-2 must be encoded to %2B.

Sorting projects

LaunchDarkly supports two fields for sorting:

• name sorts by project name.
• createdOn sorts by the creation date of the project.

For example, sort=name sorts the response by project name in ascending order.

Expanding the projects response

LaunchDarkly supports one field for expanding the “List projects” 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 the environments field.

• environments includes a paginated list of the project environments.

For example, expand=environments includes the environments field for each project in the response.

GET /api/v2/projects

List projects

cURL

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

200

{
  "_links": {
    "self": {
      "href": "/api/v2/projects",
      "type": "application/json"
    }
  },
  "items": [
    {
      "_links": {
        "environments": {
          "href": "/api/v2/projects/my-project/environments",
          "type": "application/json"
        },
        "self": {
          "href": "/api/v2/projects/my-project",
          "type": "application/json"
        }
      },
      "_id": "57be1db38b75bf0772d11383",
      "key": "project-key-123abc",
      "includeInSnippetByDefault": true,
      "name": "My Project",
      "tags": [
        "ops"
      ],
      "defaultClientSideAvailability": {
        "usingMobileKey": true,
        "usingEnvironmentId": true
      },
      "_access": {
        "denied": [
          {
            "action": "<string>",
            "reason": {
              "effect": "allow",
              "resources": [
                "proj/*:env/*;qa_*:/flag/*"
              ],
              "notResources": [
                "<string>"
              ],
              "actions": [
                "*"
              ],
              "notActions": [
                "<string>"
              ],
              "role_name": "<string>"
            }
          }
        ],
        "allowed": [
          {
            "action": "<string>",
            "reason": {
              "effect": "allow",
              "resources": [
                "proj/*:env/*;qa_*:/flag/*"
              ],
              "notResources": [
                "<string>"
              ],
              "actions": [
                "*"
              ],
              "notActions": [
                "<string>"
              ],
              "role_name": "<string>"
            }
          }
        ]
      },
      "defaultReleasePipelineKey": "<string>",
      "environments": {
        "items": [
          {
            "_links": {
              "self": {
                "href": "/api/v2/projects/my-project/environments/my-environment",
                "type": "application/json"
              }
            },
            "_id": "57be1db38b75bf0772d11384",
            "key": "environment-key-123abc",
            "name": "My Environment",
            "apiKey": "sdk-xxx",
            "mobileKey": "mob-xxx",
            "color": "F5A623",
            "defaultTtl": 5,
            "secureMode": true,
            "defaultTrackEvents": false,
            "requireComments": true,
            "confirmChanges": true,
            "tags": [
              "ops"
            ],
            "critical": true,
            "_access": {
              "denied": [
                {
                  "action": "<string>",
                  "reason": {
                    "effect": "allow",
                    "resources": [
                      "proj/*:env/*;qa_*:/flag/*"
                    ],
                    "notResources": [
                      "<string>"
                    ],
                    "actions": [
                      "*"
                    ],
                    "notActions": [
                      "<string>"
                    ],
                    "role_name": "<string>"
                  }
                }
              ],
              "allowed": [
                {
                  "action": "<string>",
                  "reason": {
                    "effect": "allow",
                    "resources": [
                      "proj/*:env/*;qa_*:/flag/*"
                    ],
                    "notResources": [
                      "<string>"
                    ],
                    "actions": [
                      "*"
                    ],
                    "notActions": [
                      "<string>"
                    ],
                    "role_name": "<string>"
                  }
                }
              ]
            },
            "approvalSettings": {
              "required": true,
              "bypassApprovalsForPendingChanges": false,
              "minNumApprovals": 1,
              "canReviewOwnRequest": false,
              "canApplyDeclinedChanges": true,
              "serviceKind": "launchdarkly",
              "serviceConfig": {},
              "requiredApprovalTags": [
                "require-approval"
              ],
              "autoApplyApprovedChanges": true,
              "serviceKindConfigurationId": "1ef45a85-218f-4428-a8b2-a97e5f56c258"
            },
            "resourceApprovalSettings": {}
          }
        ],
        "_links": {},
        "totalCount": 2
      }
    }
  ],
  "totalCount": 123
}

Authorizations

Authorization · string · header · required

Query Parameters

limit · integer<int64>

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

offset · integer<int64>

Where to start in the list. Use this with pagination. For example, an offset of 10 skips the first ten items and returns the next limit items.

filter · string<string>

A comma-separated list of filters. Each filter is constructed as field:value.

sort · string<string>

A comma-separated list of fields to sort by. Fields prefixed by a dash ( - ) sort in descending order.

expand · string<string>

A comma-separated list of properties that can reveal additional information in the response.

Response

200

application/json

Project collection response

_links · object · required

A link to this resource.

Show child attributes

Example:

{
  "self": {
    "href": "/api/v2/projects",
    "type": "application/json"
  }
}

items · object[] · required

List of projects.

Show child attributes

totalCount · integer