Gets context field | Unleash Documentation

Returns specific [context field](https://docs.getunleash.io/concepts/unleash-context) identified by the name in the path

Returns specific context field identified by the name in the path

Returns specific [context field](https://docs.getunleash.io/concepts/unleash-context) identified by the name in the path

Authorizationstring

API key needed to access this API

AuthorizationBearer

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

contextFieldstringRequired

contextFieldSchema

namestring

The name of the context field

descriptionstring or null

The description of the context field.

stickinessboolean

Does this context field support being used for stickiness calculations

sortOrderinteger

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

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

projectstring

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

Returns specific context field identified by the name in the path

API key needed to access this API

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

The name of the context field

The description of the context field.

Does this context field support being used for stickiness calculations

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

When this context field was created

Number of projects where this context field is used in

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

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

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

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

$	curl https://app.unleash-instance.example.com/api/admin/context/contextField \
>	-H "Authorization: <apiKey>"