Search for contexts
Search for contexts.
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 contexts, read Contexts and context kinds.
Authorization
ApiKey read, writeIn: header
Scope: read, write
Path Parameters
The project key
stringThe environment key
stringQuery Parameters
Specifies the maximum number of items in the collection to return (max: 50, default: 20)
int64Limits results to contexts with sort values after the value specified. You can use this for pagination, however, we recommend using the next link we provide instead.
stringDeprecated. This endpoint does not support sorting. Requests that include this parameter are rejected with a 400 response, so omit it.
stringA comma-separated list of context filters. To learn more about the filter syntax, read Filtering contexts and context instances.
stringSpecifies whether to include or omit the total count of matching contexts. Defaults to true.
Request Body
application/json
A collection of context filters
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.
Specifies the maximum number of items in the collection to return (max: 50, default: 20)
Limits results to contexts 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 Body
application/json
application/json
application/json
application/json
application/json
curl -X POST "https://example.com/api/v2/projects/string/environments/string/contexts/search" \ -H "Content-Type: application/json" \ -d '{}'{ "_links": { "next": { "href": "/app.launchdarkly.com/api/v2/projects/my-project/environments/my-environment/contexts?filter=kind:{\"equals\": [\"organization\"]}&limit=2&continuationToken=QAGFKH1313KUGI2351", "type": "application/json" }, "self": { "href": "/api/v2/projects/my-proj/environments/my-env/contexts?filter=kind:{\"equals\": [\"organization\"]}&limit=2&continuationToken=QAGFKH1313KUGI2351", "type": "application/json" } }, "totalCount": 100, "_environmentId": "57be1db38b75bf0772d11384", "continuationToken": "QAGFKH1313KUGI2351", "items": [ { "lastSeen": "2022-04-15T15:00:57.526470334Z", "applicationId": "GoSDK/1.2", "context": "{\"kind\": \"user\", \"key\": \"context-key-123abc\", \"name\": \"Sandy Smith\", \"email\": \"sandy@example.com\"}", "_links": { "parent": { "href": "/api/v2/projects/my-project/environments/my-environment", "type": "application/json" }, "self": { "href": "/api/v2/projects/my-project/environments/my-env/contexts/organization:launch-darkly:user:henry?filter=applicationid+equals+%22GoSDK%2F1.2%22", "type": "application/json" }, "site": { "href": "/my-project/my-environment/context/organization:launch-darkly:user:henry", "type": "text/html" } }, "_access": { "denied": [ { "action": "string", "reason": { "resources": [ "proj/*:env/*;qa_*:/flag/*" ], "notResources": [ "string" ], "actions": [ "*" ], "notActions": [ "string" ], "effect": "allow", "role_name": "string" } } ], "allowed": [ { "action": "string", "reason": { "resources": [ "proj/*:env/*;qa_*:/flag/*" ], "notResources": [ "string" ], "actions": [ "*" ], "notActions": [ "string" ], "effect": "allow", "role_name": "string" } } ] }, "associatedContexts": 0 } ]}