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.
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
.
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.
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.
The number of projects to return in the response. Defaults to 20.
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.
A comma-separated list of filters. Each filter is constructed as field:value
.
A comma-separated list of fields to sort by. Fields prefixed by a dash ( - ) sort in descending order.
A comma-separated list of properties that can reveal additional information in the response.
Project collection response
A link to this resource.
List of projects.