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

# Get Custom Events

> Get custom events associated with a user for tracking and triggering downstream processes. Events are stored with optional categorization and custom data payload. Results can be filtered by category and name.



## OpenAPI

````yaml /openapi.yaml get /events
openapi: 3.0.0
info:
  title: claimr API
  version: 1.0.0
  description: >-
    Advanced features of claimr for business partners. This API provides a
    seamless integration with claimr services
  termsOfService: https://claimr.io/terms-of-service/
  contact:
    name: claimr support team
    email: support@claimr.io
servers:
  - url: https://prod.claimr.io/api/v1
    description: Production server
  - url: https://prod.claimr.io/api/v1
    description: Development server
security: []
tags: []
paths:
  /events:
    get:
      tags:
        - Events
      summary: Get Custom Events
      description: >-
        Get custom events associated with a user for tracking and triggering
        downstream processes. Events are stored with optional categorization and
        custom data payload. Results can be filtered by category and name.
      parameters:
        - in: query
          name: account
          required: true
          schema:
            type: string
          description: User account identifier
          example: user123
        - in: query
          name: platform
          required: true
          schema:
            type: string
          description: Platform identifier where the user account exists
          example: steam
        - in: query
          name: pid
          required: true
          schema:
            type: string
          description: Campaign ID associated with this event
          example: campaign_abc123
        - in: query
          name: name
          required: true
          schema:
            type: string
          description: Event name identifier for filtering
          example: level_completed
        - in: query
          name: category
          required: true
          schema:
            type: string
          description: Event category for filtering/grouping
          example: gameplay
      responses:
        '200':
          description: Events retrieved successfully
          content:
            application/json:
              schema:
                type: object
                properties:
                  success:
                    type: boolean
                    example: true
                  events:
                    type: array
                    description: Array of matching events
                    items:
                      type: object
                      properties:
                        id:
                          type: string
                          description: Unique event identifier
                          example: evt_xyz789
                        account:
                          type: string
                          description: User account identifier
                          example: user123
                        platform:
                          type: string
                          description: Platform identifier
                          example: steam
                        pid:
                          type: string
                          description: Campaign ID
                          example: campaign_abc123
                        name:
                          type: string
                          description: Event name
                          example: level_completed
                        category:
                          type: string
                          description: Event category
                          example: gameplay
                        data:
                          type: object
                          description: Custom data payload
                          additionalProperties: true
                          example:
                            level: 5
                            score: 1250
                            completion_time: 180
                        ts:
                          type: number
                          description: Event timestamp (Unix timestamp)
                          example: 1672531200
                        oid:
                          type: string
                          description: Organization/app identifier
                          example: org_123
        '400':
          description: Bad request
          content:
            application/json:
              schema:
                type: object
                properties:
                  success:
                    type: boolean
                  error:
                    type: object
                    properties:
                      code:
                        type: integer
                        format: int32
                        default: 400
                      message:
                        type: string
                        default: bad request
              examples:
                missing_fields:
                  summary: Missing required fields
                  value:
                    error: >-
                      Missing required parameters: pid, account, platform, name,
                      or category
        '401':
          $ref: '#/components/responses/unauthorized'
        '403':
          $ref: '#/components/responses/access_denied'
        '500':
          $ref: '#/components/responses/internal_error'
      security:
        - bearer: []
components:
  responses:
    unauthorized:
      description: Unauthorized request
      content:
        application/json:
          schema:
            type: object
            properties:
              success:
                type: boolean
              error:
                type: object
                properties:
                  code:
                    type: integer
                    format: int32
                    default: 401
                  message:
                    type: string
                    default: unauthorized
    access_denied:
      description: Access denied
      content:
        application/json:
          schema:
            type: object
            properties:
              success:
                type: boolean
              error:
                type: object
                properties:
                  code:
                    type: integer
                    format: int32
                    default: 403
                  message:
                    type: string
                    default: access denied
    internal_error:
      description: Internal server error
      content:
        application/json:
          schema:
            type: object
            properties:
              success:
                type: boolean
              error:
                type: object
                properties:
                  code:
                    type: integer
                    format: int32
                    default: 500
                  message:
                    type: string
                    default: internal error
  securitySchemes:
    bearer:
      type: http
      scheme: bearer
      bearerFormat: JWT

````