How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Flagsmith SDK API

SDK endpoints for flags, identities, and traits.

Flagsmith SDK API is one of 24 APIs that Flagsmith publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include SDK. The published artifact set on APIs.io includes an OpenAPI specification.

This API exposes 5 operations across 4 paths, and defines 24 schemas. It is described by OpenAPI 3.2.0, at version v1.

Requests are made against the base URL https://edge.api.flagsmith.com.

5 operations 4 paths 24 schemas 4 GET1 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.2.0
API Version
v1
Base URL
https://edge.api.flagsmith.com
Authentication
HTTP Bearer, HTTP Basic, API Key, API Key, HTTP Basic, API Key
License
BSD License
Resource Areas
1

Authentication & Security 6

Flagsmith SDK API declares 6 security schemes for authenticating requests. It accepts HTTP bearer tokens (Cohort_Sync_Key). It accepts HTTP basic authentication (Cohort_Sync_Key__Basic). An API key is passed in the header as X-Environment-Key (Environment_API_Key). An API key is passed in the header as Authorization (Master_API_Key). It accepts HTTP basic authentication (basicAuth). An API key is passed in the header as Authorization (tokenAuth).

  • Cohort_Sync_Key — For cohort sync endpoints called by an external cohort source, such as Amplitude.
  • Cohort_Sync_Key__Basic — For cohort sync endpoints called by an external cohort source that can only send Basic credentials, such as Mixpanel. The key is the password; the username is…
  • Environment_API_Key — For SDK endpoints. Find out more .
  • Master_API_Key — For Management API endpoints. Find out more .
  • tokenAuth — Token-based authentication with required prefix "Token"

Paths & Operations 5

Across 4 paths, the API surfaces 5 operations — 4 GET, 1 POST. Each is listed below with its method, path, parameters, and response codes.

SDK 5

SDK endpoints for flags, identities, and traits.

GET
/api/v1/environment-document/
Sdk v1 environment document
sdk_v1_environment_document → 200
GET
/api/v1/flags/
Sdk v1 flags
sdk_v1_flags 1 param → 200
GET
/api/v1/flags/{identifier}
Sdk v1 flags 2
sdk_v1_flags_2 2 params → 200
GET
/api/v1/identities/
Sdk v1 get identities
sdk_v1_get_identities 2 params → 200
POST
/api/v1/identities/
Sdk v1 post identities
sdk_v1_post_identities body → 200

Schemas 24

The contract defines 24 schemas that model the data the API accepts and returns. The most detailed are V1EnvironmentDocumentResponseFeatureState (7 properties), V1IdentitiesResponseV1Flag (6 properties), V1EnvironmentDocumentResponse (5 properties), V1EnvironmentDocumentResponseSegment (4 properties). Each schema is shown below with its type and property counts.

V1IdentitiesResponseExperimentMetadata
object
Represents the experiment a feature state is part of. Only present while the experiment is running.
3 properties 3 required
V1EnvironmentDocumentResponseExperimentMetadata
object
Represents the experiment a feature state is part of. Only present while the experiment is running.
3 properties 3 required
V1EnvironmentDocumentResponseMultivariateFeatureOption
object
Represents a single multivariate feature option in the Flagsmith UI.
1 property 1 required
V1IdentitiesResponseFeatureStateMetadata
object
Additional, non-evaluation data about a feature state.
1 property
V1EnvironmentDocumentResponseFeatureState
object
Used to define the state of a feature for an environment, segment overrides, and identity overrides.
7 properties 6 required
V1EnvironmentDocumentResponseMultivariateFeatureStateValue
object
Represents a multivariate feature state value.
4 properties 4 required
V1EnvironmentDocumentResponseFeatureStateMetadata
object
Additional, non-evaluation data about a feature state.
1 property
V1EnvironmentDocumentResponseProject
object
Represents a Flagsmith project. For SDKs, this is mainly used to convey segment data.
1 property 1 required
V1EnvironmentDocumentResponseSegmentConditionOperatorEnum
string
V1EnvironmentDocumentResponseFeatureSegment
object
Represents data specific to a segment feature override.
1 property 1 required
V1IdentitiesRequestTraitInput
object
Represents a key-value pair trait provided as input when creating or updating an identity.
3 properties 2 required
V1EnvironmentDocumentResponseFeature
object
Represents a Flagsmith feature, defined at project level.
3 properties 3 required
V1EnvironmentDocumentResponse
object
/api/v1/environment-documents/ response. Powers Flagsmith SDK's local evaluation mode.
5 properties 5 required
V1IdentitiesResponseV1Flag
object
Represents a single flag (feature state) returned by the Flagsmith SDK.
6 properties 3 required
V1EnvironmentDocumentResponseSegmentRule
object
Represents a rule within a segment used by Flagsmith engine. Root rules usually contain nested rules.
3 properties 3 required
V1IdentitiesResponseFeature
object
Represents a Flagsmith feature, defined at project level.
3 properties 3 required
TypeD77Enum
string
STANDARD - STANDARD MULTIVARIATE - MULTIVARIATE
V1IdentitiesResponseTrait
object
Represents a key-value pair associated with an identity.
2 properties 2 required
V1EnvironmentDocumentResponseSegment
object
Represents a Flagsmith segment. Carries rules and feature overrides.
4 properties 3 required
V1IdentitiesRequest
object
/api/v1/identities/ request. Used to retrieve flags for an identity and store its traits.
3 properties 1 required
V1EnvironmentDocumentResponseSegmentRuleTypeEnum
string
V1EnvironmentDocumentResponseSegmentCondition
object
Represents a condition within a segment rule used by Flagsmith engine.
3 properties 3 required
V1IdentitiesResponse
object
/api/v1/identities/ response. Represents the identity created or updated, along with its flags.
3 properties 3 required
V1EnvironmentDocumentResponseIdentityOverride
object
Represents an identity override, defining feature states specific to an identity.
2 properties 2 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

flagsmith-sdk-api-openapi.yml Raw ↑

Other APIs Flagsmith publishes across the network.

Flagsmith Flags API
flagsmith Environments API
flagsmith Features API
flagsmith Identities API
flagsmith Organisations API
flagsmith Projects API
flagsmith Segments API
flagsmith Users API
flagsmith Webhooks API
Flagsmith Admin dashboard API
Flagsmith Analytics API
Flagsmith Audit API
Where this information came from

This is an independent, third-party profile of Flagsmith SDK API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.

The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.

Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.

info@apievangelist.com · Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.