[BETA] Gets configured context fields

[BETA] This API is in beta state, which means it may change or be removed in the future.

Returns all configured Context fields that have been created.

Authentication

Authorizationstring

API key needed to access this API

AuthorizationBearer

API key needed to access this API, in Bearer token format

Path parameters

projectIdstringRequired

Query parameters

includestringOptional

Whether the response should include project-specific or root context fields in addition to the fields in the default response. When querying the root context API, include=project will yield a response that includes all project-specific context fields in addition to all root context fields. Conversely, when querying a project-specific context API, using include=root will yield a response that includes all root context fields in addition to the project-specific context fields. The other combinations have no effect, because the responses already include those fields. When including project-specific context fields via the root-level API, context fields in private projects the user does not have access to will be omitted.

Whether the response should include project-specific or root context fields in addition to the fields in the default response. When querying the root context API, `include=project` will yield a response that includes all project-specific context fields in addition to all root context fields. Conversely, when querying a project-specific context API, using `include=root` will yield a response that includes all root context fields in addition to the project-specific context fields. The other combinations have no effect, because the responses already include those fields. When including project-specific context fields via the root-level API, context fields in private projects the user does not have access to will be omitted.

Response

contextFieldsSchema

namestring

The name of the context field

descriptionstring or null

The description of the context field.

stickinessboolean or null

Does this context field support being used for stickiness calculations

sortOrderinteger or null

Used when sorting a list of context fields. Is also used as a tiebreaker if a list of context fields is sorted alphabetically.

createdAtstring or nullformat: "date-time"

When this context field was created

usedInFeaturesinteger or null>=0

Number of projects where this context field is used in

usedInProjectsinteger or null>=0

Number of projects where this context field is used in

legalValueslist of objects or null

Allowed values for this context field schema. Can be used to narrow down accepted input

projectstring or null

The project this context field belongs to (if it is project-specific)

1	import requests
2
3	url = "https://app.unleash-instance.example.com/api/admin/projects/projectId/context"
4
5	headers = {"Authorization": "<apiKey>"}
6
7	response = requests.get(url, headers=headers)
8
9	print(response.json())

1	[
2	{
3	"name": "userId",
4	"description": "Used to uniquely identify users",
5	"stickiness": true,
6	"sortOrder": 900,
7	"createdAt": "2023-06-29T10:19:00.000Z",
8	"usedInFeatures": 3,
9	"usedInProjects": 2,
10	"legalValues": [
11	{
12	"value": "#c154c1",
13	"description": "Deep fuchsia"
14	}
15	],
16	"project": "my-project"
17	}
18	]