Read free membership and current join terms

GET /v1/developer/guest/me/membership

Operation ID: getDeveloperGuestMembership

Authenticated guest and server-only guest_preferences.write grant required. Returns the current installed collection membership and disclosure to display beside a deliberate join action. TEST membership is installation-isolated; authentication alone does not enroll.

Contract status

Field	Value
Maturity	`preview`
Required capability	`guest_preferences.write`
Freshness class	`authenticated-state`
Quota cost	`1`

All operations require a Kismet Developer Bearer credential. Collection and resource authority is resolved from the credential’s installation grants; identifiers in the URL never grant access.

Request parameters

Name	In	Type	Required	Description
`x-kismet-guest-token`	header	string	yes	Verified guest access token held by your same-origin BFF, never browser JavaScript.
`origin`	header	string	yes

Request body

This operation has no JSON request body.

cURL

Set KISMET_API_ORIGIN=https://api.ksmt.app and configure KISMET_DEVELOPER_API_KEY in your environment. Run server-credential requests from your backend, not browser code.

Guest access tokens come from the signed-in guest session held by your backend. Forward a CSRF proof only after your same-origin backend validates it. If shown, KISMET_SITE_ORIGIN is the authorized origin of your site. Do not substitute a guest ID or an invented token.

curl --request GET \
  "$KISMET_API_ORIGIN/v1/developer/guest/me/membership" \
  --header "Authorization: Bearer $KISMET_DEVELOPER_API_KEY" \
  --header "Accept: application/json" \
  --header "x-kismet-guest-token: $GUEST_ACCESS_TOKEN" \
  --header "origin: $KISMET_SITE_ORIGIN"

Responses

Status	Meaning
200	Success.
400	Invalid request parameters or body.
401	Missing, invalid, expired, or inappropriate credential/session.
403	Credential lacks the required grant/capability, or an origin/CSRF check failed.
404	The authorized resource was not found.
409	Request conflicts with the installation environment or current state.
429	Rate limit or quota exceeded; inspect response metadata before retrying.
503	A required Kismet dependency is temporarily unavailable.

200 response schema

Content type: application/json. Required fields, nullable values, and nested structures are defined below.

View complete response schema

{
  "type": "object",
  "additionalProperties": false,
  "required": [
    "guestId",
    "disclosure",
    "disclosureHash",
    "membership"
  ],
  "properties": {
    "guestId": {
      "type": "string"
    },
    "disclosure": {
      "type": "object",
      "additionalProperties": false,
      "required": [
        "version",
        "collection",
        "environment",
        "membership",
        "text",
        "notice"
      ],
      "properties": {
        "version": {
          "type": "string"
        },
        "collection": {
          "type": "object",
          "additionalProperties": false,
          "required": [
            "id",
            "slug",
            "name"
          ],
          "properties": {
            "id": {
              "type": "string"
            },
            "slug": {
              "type": "string"
            },
            "name": {
              "type": "string"
            }
          }
        },
        "environment": {
          "type": "string",
          "enum": [
            "TEST",
            "LIVE"
          ]
        },
        "membership": {
          "type": "object",
          "additionalProperties": false,
          "required": [
            "available",
            "name",
            "description",
            "termsUrl",
            "termsVersion"
          ],
          "properties": {
            "available": {
              "type": "boolean"
            },
            "name": {
              "type": "string"
            },
            "description": {
              "type": "string"
            },
            "termsUrl": {
              "type": "string",
              "format": "uri"
            },
            "termsVersion": {
              "type": "string"
            }
          }
        },
        "text": {
          "type": "string"
        },
        "notice": {
          "type": [
            "null",
            "string"
          ]
        }
      }
    },
    "disclosureHash": {
      "type": "string"
    },
    "membership": {
      "type": "object",
      "additionalProperties": false,
      "required": [
        "status",
        "joinedAt"
      ],
      "properties": {
        "status": {
          "type": "string",
          "enum": [
            "NOT_JOINED",
            "ACTIVE"
          ]
        },
        "joinedAt": {
          "type": [
            "null",
            "string"
          ],
          "format": "date-time"
        }
      }
    }
  }
}