OverviewContexts

Search for context instances

Search for context instances.

You can use either the query parameters or the request body parameters. If both are provided, there is an error.

To learn more about the filter syntax, read Filtering contexts and context instances. To learn more about context instances, read Context instances.

Path parameters

projectKeystringRequired
The project key
environmentKeystringRequired
The environment key

Headers

AuthorizationstringRequired

Query parameters

limitlongOptional

Specifies the maximum number of items in the collection to return (max: 50, default: 20)

continuationTokenstringOptional

Limits results to context instances with sort values after the value specified. You can use this for pagination, however, we recommend using the next link we provide instead.

sortstringOptional

Specifies a field by which to sort. LaunchDarkly supports sorting by timestamp in ascending order by specifying ts for this value, or descending order by specifying -ts.

filterstringOptional

A comma-separated list of context filters. This endpoint only accepts an applicationId filter. To learn more about the filter syntax, read Filtering contexts and context instances.

includeTotalCountbooleanOptional
Specifies whether to include or omit the total count of matching context instances. Defaults to true.

Request

This endpoint expects an object.
filterstringOptional
A collection of context instance filters
sortstringOptional

Specifies a field by which to sort. LaunchDarkly supports sorting by timestamp in ascending order by specifying ts for this value, or descending order by specifying -ts.

limitintegerOptional

Specifies the maximum number of items in the collection to return (max: 50, default: 20)

continuationTokenstringOptional

Limits results to context instances with sort values after the value specified. You can use this for pagination, however, we recommend using the next link instead, because this value is an obfuscated string.

Response

Context instances collection response
_environmentIdstring
The environment ID
itemslist of objects

A collection of context instances. Can include multiple versions of context instances that have the same id, but different applicationIds.

totalCountinteger or null
The number of unique context instances
continuationTokenstring or null

An obfuscated string that references the last context instance on the previous page of results. You can use this for pagination, however, we recommend using the next link instead.

Errors