{
  "opencollection": "1.0.0",
  "info": {
    "name": "Flagsmith Admin Environments Identities API",
    "version": "1.0"
  },
  "request": {
    "auth": {
      "type": "apikey",
      "key": "Authorization",
      "value": "{{Authorization}}",
      "placement": "header"
    }
  },
  "items": [
    {
      "info": {
        "name": "Identities",
        "type": "folder"
      },
      "items": [
        {
          "info": {
            "name": "List identities for an environment",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://api.flagsmith.com/api/v1/environments/:environment_api_key/identities/",
            "params": [
              {
                "name": "environment_api_key",
                "value": "",
                "type": "path",
                "description": "The API key for the environment"
              }
            ]
          },
          "docs": "Retrieves a paginated list of all user identities within a specific environment. Identities represent individual users with their associated traits and flag overrides."
        },
        {
          "info": {
            "name": "Get an identity",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://api.flagsmith.com/api/v1/environments/:environment_api_key/identities/:identity_id/",
            "params": [
              {
                "name": "environment_api_key",
                "value": "",
                "type": "path",
                "description": "The API key for the environment"
              },
              {
                "name": "identity_id",
                "value": "",
                "type": "path",
                "description": "The unique identifier for the identity"
              }
            ]
          },
          "docs": "Retrieves the details of a specific identity by its ID within an environment, including its identifier and associated traits."
        },
        {
          "info": {
            "name": "Delete an identity",
            "type": "http"
          },
          "http": {
            "method": "DELETE",
            "url": "https://api.flagsmith.com/api/v1/environments/:environment_api_key/identities/:identity_id/",
            "params": [
              {
                "name": "environment_api_key",
                "value": "",
                "type": "path",
                "description": "The API key for the environment"
              },
              {
                "name": "identity_id",
                "value": "",
                "type": "path",
                "description": "The unique identifier for the identity"
              }
            ]
          },
          "docs": "Permanently deletes an identity and all associated traits and flag overrides from an environment. This action cannot be undone."
        },
        {
          "info": {
            "name": "Get flags and traits for an identity",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://api.flagsmith.com/api/v1/identities/",
            "params": [
              {
                "name": "identifier",
                "value": "",
                "type": "query",
                "description": "The unique identifier for the user identity. This is typically a user ID, email, or other unique string that identifies the user in your application."
              },
              {
                "name": "transient",
                "value": "",
                "type": "query",
                "description": "When set to true, the identity is treated as transient and will not be persisted. The identity will be used for flag evaluation only."
              }
            ]
          },
          "docs": "Retrieves all feature flags and traits for a specific user identity. The flags returned may differ from the environment defaults based on the identity's traits and segment membership. If the identity does not exist, it will be created. This endpoint also supports transient identities and traits that are used for evaluation but not persisted."
        },
        {
          "info": {
            "name": "Identify a user and get flags with traits",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://api.flagsmith.com/api/v1/identities/",
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Identifies a user by providing an identifier and optional traits in the request body. Returns the evaluated flags for that identity based on the provided traits and any existing traits. Traits provided in the request body are persisted for the identity unless marked as transient. This endpoint performs the entire SDK identity workflow in a single call."
        },
        {
          "info": {
            "name": "Set traits for an identity",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://api.flagsmith.com/api/v1/traits/",
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Sets one or more trait values for a given identity. If the identity does not exist, it will be created. Traits are key-value pairs associated with an identity that can be used for segment evaluation and personalized flag delivery."
        },
        {
          "info": {
            "name": "Set multiple traits for an identity in bulk",
            "type": "http"
          },
          "http": {
            "method": "PUT",
            "url": "https://api.flagsmith.com/api/v1/traits/bulk/",
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Sets multiple trait values for a given identity in a single API call. This is more efficient than making individual trait requests when updating multiple traits at once. If a trait value is set to null, the trait will be deleted."
        }
      ]
    }
  ],
  "bundled": true
}