Sign in

v7

latestOpenAPI 3.0.3raw.githubusercontent.com2026-08-013764062.2 MB
Context

[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.

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

Path parameters

projectIdstring required

Query parameters

includestring
Example:project

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 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"
  }
]