Context

[BETA] Gets context field

Changed on

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

Returns specific context field identified by the name in the path

get/api/admin/projects/{projectId}/context/{contextField}

Request

  • Base URL
    https://app.unleash-instance.example.com
  • URL
    https://app.unleash-instance.example.com/api/admin/projects/{projectId}/context/{contextField}
  • Auth
    • API key in header Authorization
    • or HTTP bearer

Path parameters

projectIdstring required
contextFieldstring required

Response

contextFieldSchema

namestring required

The name of the context field

descriptionstring nullable

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 date-time nullable

When this context field was created

usedInFeaturesinteger nullable

Number of projects where this context field is used in

usedInProjectsinteger nullable

Number of projects where this context field is used in

projectstring

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

Example response

{
  "name": "userId",
  "description": "Used to uniquely identify users",
  "stickiness": true,
  "sortOrder": 900,
  "createdAt": "2023-06-29T10:19:00.000Z",
  "usedInFeatures": 3,
  "usedInProjects": 2,
  "legalValues": [
    {
      "value": "#c154c1",
      "description": "Deep fuchsia"
    }
  ],
  "project": "my-project"
}

Changes