> ## Documentation Index
> Fetch the complete documentation index at: https://docs.scrip.dev/llms.txt
> Use this file to discover all available pages before exploring further.

# Get participant state history

> Retrieve a unified timeline of state changes across tags, counters, attributes, and tiers. For authoritative tier transition details, use the tier transitions endpoint.

Returns a unified timeline of state changes for a participant, including tags, counters, attributes, and tiers. Each entry includes:

* **`state_type`**: what changed (`tag`, `attribute`, `counter`, or `tier`)
* **`key`**: the specific key that was modified
* **`operation`**: `set` or `delete`
* **`old_value`** / **`new_value`**: the value before and after the change
* **`event_id`**: present when the change was triggered by a rule during event processing
* **`changed_by_api_key_id`**: present when the change was made via a direct API call

Filter by `state_type` and `key` to narrow results. Use `state_type=tier` with a `program_id` to isolate tier transitions. Filter by `from` / `to` on `changed_at` (when the state change was recorded), or by `event_from` / `event_to` on the originating event's `event_timestamp`. Entries without an event fall back to their `changed_at`. Both pairs can be used simultaneously (AND semantics).

<Note>
  For usage patterns and examples, see the [Participants guide](/guides/participants).
</Note>


## OpenAPI

````yaml GET /v1/participants/{id}/activity/state-history
openapi: 3.0.3
info:
  contact:
    email: support@scrip.dev
    name: Scrip Support
    url: https://scrip.dev/support
  description: >-
    Universal Incentive Infrastructure API for managing loyalty programs,
    rewards, and participant balances.


    Scrip provides a complete backend for building incentive and loyalty
    programs. Core concepts:

    - **Programs**: Containers for incentive logic (e.g., "Q1 Sales Bonus",
    "Customer Loyalty")

    - **Assets**: The currency or points being tracked (e.g., "Bonus Points",
    "Cash Rewards")

    - **Participants**: Users who earn and spend assets (identified by
    external_id)

    - **Groups**: Collections of participants for team-based incentives

    - **Rules**: Automated reward logic triggered by events

    - **Events**: Actions that trigger rule evaluation (e.g., "purchase",
    "referral")


    Response formats:

    - **Collection endpoints** return: {"data": [...], "pagination":
    {"has_more": true, "next_cursor": "..."}}

    - **Single-resource endpoints** return the resource directly

    - **Errors** return: {"code": "...", "message": "...", "details": {...}} —
    `details` is an optional object, present on input errors only
  license:
    name: Proprietary
    url: https://scrip.dev/license
  termsOfService: https://scrip.dev/terms
  title: Scrip API
  version: '1.0'
servers:
  - url: https://api.scrip.dev
security: []
tags:
  - description: >-
      Manage incentive programs. Programs are the top-level container for all
      incentive logic.
    name: Programs
  - description: >-
      Manage asset types (currencies, points). Assets define what participants
      can earn and spend.
    name: Assets
  - description: >-
      Manage participants and their balances. Participants are identified by
      external_id from your system.
    name: Participants
  - description: Manage participant groups for team-based incentives.
    name: Groups
  - description: >-
      Manage automated reward rules. Rules define conditions and actions
      triggered by events.
    name: Rules
  - description: Ingest events that trigger rule evaluation and reward distribution.
    name: Events
  - description: Transfer assets between participants.
    name: Transfers
  - description: Access ledger summaries and program activity reports.
    name: Reporting
  - description: >-
      Redeem participant balances for rewards. Supports raw amount redemptions
      and catalog item redemptions.
    name: Redemptions
  - description: >-
      Manage the reward catalog. Create and manage redeemable items with
      inventory tracking.
    name: Rewards
  - description: >-
      Schedule and manage automated event dispatching. Automations generate
      events on cron schedules, at specific times, or by evaluating participant
      state.
    name: Automations
  - description: >-
      Manage tier types and levels within programs. Tiers define status
      hierarchies that participants progress through based on qualification
      rules.
    name: Tiers
  - description: Inspect double-entry ledger records for auditing and reconciliation.
    name: Journal Entries
  - description: >-
      Manage webhook endpoints and delivery logs. Webhooks notify your
      application of real-time events via HTTP POST with HMAC-SHA256 signatures.
    name: Webhooks
paths:
  /v1/participants/{id}/activity/state-history:
    get:
      tags:
        - Participants
      summary: Get participant state history
      description: >-
        Retrieve a unified timeline of state changes across tags, counters,
        attributes, and tiers. For authoritative tier transition details, use
        the tier transitions endpoint.
      operationId: listParticipantStateHistory
      parameters:
        - description: Participant ID
          in: path
          name: id
          required: true
          schema:
            format: uuid
            type: string
        - description: Filter by state type
          in: query
          name: state_type
          schema:
            enum:
              - tag
              - counter
              - attribute
              - tier
            type: string
        - description: Filter by key
          in: query
          name: key
          schema:
            type: string
        - description: Filter by program ID (for tier entries)
          in: query
          name: program_id
          schema:
            format: uuid
            type: string
        - description: Filter by operation
          in: query
          name: operation
          schema:
            enum:
              - set
              - delete
              - add
              - remove
              - auto_reset
            type: string
        - description: Start of time window (RFC 3339) — filters on system ingestion time
          in: query
          name: from
          schema:
            format: date-time
            type: string
        - description: End of time window (RFC 3339) — filters on system ingestion time
          in: query
          name: to
          schema:
            format: date-time
            type: string
        - description: >-
            Start of event occurrence window (RFC 3339) — filters on
            event_timestamp
          in: query
          name: event_from
          schema:
            format: date-time
            type: string
        - description: >-
            End of event occurrence window (RFC 3339) — filters on
            event_timestamp
          in: query
          name: event_to
          schema:
            format: date-time
            type: string
        - description: Maximum results (default 50, max 100)
          in: query
          name: limit
          schema:
            minimum: 1
            type: integer
        - description: Pagination cursor from previous response
          in: query
          name: cursor
          schema:
            type: string
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: >-
                  #/components/schemas/handlers.ListResponse-store_EntityStateHistoryEntry
          description: State history entries
        '400':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/handlers.ErrBadRequestResponse'
          description: 'Invalid query parameters (code: bad_request)'
        '401':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/handlers.ErrUnauthorizedResponse'
          description: 'Missing or invalid credentials (code: unauthorized)'
        '403':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/handlers.ErrForbiddenResponse'
          description: 'Insufficient permissions (code: forbidden)'
        '404':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/handlers.ErrNotFoundResponse'
          description: 'Participant not found (code: not_found)'
        '500':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/handlers.ErrInternalResponse'
          description: 'Internal server error (code: internal_error)'
      security:
        - ApiKeyAuth: []
        - BearerAuth: []
components:
  schemas:
    handlers.ListResponse-store_EntityStateHistoryEntry:
      properties:
        data:
          description: Data contains the list of items
          items:
            $ref: '#/components/schemas/store.EntityStateHistoryEntry'
          type: array
        pagination:
          allOf:
            - $ref: '#/components/schemas/handlers.PaginationResponse'
          description: Pagination contains cursor information for fetching more results
      type: object
    handlers.ErrBadRequestResponse:
      additionalProperties: false
      properties:
        code:
          description: Code is the machine-readable error code
          example: bad_request
          type: string
        details:
          allOf:
            - $ref: '#/components/schemas/handlers.ErrorDetails'
          description: >-
            Details provides optional structured error context (field errors,
            etc.)
        message:
          description: Message is the human-readable error description
          example: Invalid request parameters
          type: string
      type: object
    handlers.ErrUnauthorizedResponse:
      properties:
        code:
          description: Code is the machine-readable error code
          example: unauthorized
          type: string
        details:
          allOf:
            - $ref: '#/components/schemas/handlers.ErrorDetails'
          description: Details provides optional structured error context
        message:
          description: Message is the human-readable error description
          example: Missing or invalid credentials
          type: string
      type: object
    handlers.ErrForbiddenResponse:
      properties:
        code:
          description: Code is the machine-readable error code
          example: forbidden
          type: string
        details:
          allOf:
            - $ref: '#/components/schemas/handlers.ErrorDetails'
          description: Details provides optional structured error context
        message:
          description: Message is the human-readable error description
          example: Insufficient permissions for this action
          type: string
      type: object
    handlers.ErrNotFoundResponse:
      properties:
        code:
          description: Code is the machine-readable error code
          example: not_found
          type: string
        details:
          allOf:
            - $ref: '#/components/schemas/handlers.ErrorDetails'
          description: Details provides optional structured error context
        message:
          description: Message is the human-readable error description
          example: Resource not found
          type: string
      type: object
    handlers.ErrInternalResponse:
      properties:
        code:
          description: Code is the machine-readable error code
          example: internal_error
          type: string
        message:
          description: Message is the human-readable error description
          example: An internal error occurred
          type: string
      type: object
    store.EntityStateHistoryEntry:
      properties:
        changed_at:
          description: When the change occurred
          example: '2024-01-15T10:30:00Z'
          format: date-time
          type: string
        event_id:
          description: Event that triggered the change (present for rule-driven changes)
          example: 550e8400-e29b-41d4-a716-446655440002
          format: uuid
          type: string
        id:
          description: Unique identifier for this history entry
          example: 550e8400-e29b-41d4-a716-446655440000
          format: uuid
          type: string
        key:
          description: The key that was changed
          example: region
          type: string
        new_value:
          description: New value (null for deletes)
          example: us-east
          type: string
        old_value:
          description: Previous value (null for new keys)
          example: us-west
          type: string
        operation:
          description: 'What happened: set or delete'
          example: set
          type: string
        program_id:
          description: Program ID for tier state changes (null for tag/counter/attribute)
          example: 550e8400-e29b-41d4-a716-446655440003
          format: uuid
          type: string
        rule_id:
          description: >-
            Rule that triggered the change (present for rule-driven tier
            changes)
          example: 550e8400-e29b-41d4-a716-446655440004
          format: uuid
          type: string
        state_type:
          description: 'Type of state that changed: tag, counter, attribute, or tier'
          example: attribute
          type: string
      type: object
    handlers.PaginationResponse:
      properties:
        has_more:
          description: Whether more results are available beyond this page
          example: true
          type: boolean
        next_cursor:
          description: Cursor to fetch the next page. Absent when there are no more results
          example: YWJjMTIz
          type: string
      type: object
    handlers.ErrorDetails:
      description: >-
        Optional structured details about the error. Always a JSON object: a
        `fields` array for validation errors, or flat
        field/reason/expected/received properties for other input errors.
      properties:
        expected:
          description: Expected value or format (non-validation input errors)
          example: uuid
          type: string
        field:
          description: Field name that caused the error (non-validation input errors)
          example: asset_id
          type: string
        fields:
          description: >-
            Fields lists each offending input field on validation_error
            responses.
          items:
            $ref: '#/components/schemas/handlers.ErrorFieldDetail'
          type: array
        reason:
          description: Machine-readable reason code (non-validation input errors)
          example: invalid
          type: string
        received:
          description: Value that was received (non-validation input errors)
          example: not-a-uuid
          type: string
      type: object
    handlers.ErrorFieldDetail:
      description: >-
        A single field-level error: which input field failed, why, and (where
        known) the expected and received values.
      properties:
        expected:
          description: >-
            Expected value or format. Usually a string; for "one of" constraints
            it

            is an array of the allowed values.
        field:
          description: Field name that caused the error
          example: amount
          type: string
        message:
          description: Human-readable explanation (validation errors only)
          example: This field is required
          type: string
        reason:
          description: Machine-readable reason code
          example: required
          type: string
        received:
          description: Value that was received
          example: '-10.00'
          type: string
      type: object
  securitySchemes:
    ApiKeyAuth:
      description: API key passed in the X-API-Key header.
      in: header
      name: X-API-Key
      type: apiKey
    BearerAuth:
      description: Bearer token passed in the Authorization header (e.g. "Bearer sk_...").
      in: header
      name: Authorization
      type: apiKey

````