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

# Returns a list of scheduled events in the specified space.



## OpenAPI

````yaml /capture/api-spec/openapi.json get /{space_id}/events
openapi: 3.1.3
info:
  title: UP.LiveCapture API Specification
  version: 1.0.0
  description: |
    Telestream UP.LiveCapture API Specification.

    REST surface for the UP.LiveCapture service: space-scoped recording
    channels that consume CHLS streams produced by UP.LiveSources, plus
    the scheduler used to drive cross-application events (recording
    starts/stops, auto-shutdown, etc.) on an RFC-5545 recurrence rule.

    Naming conventions follow the rest of the UP REST surface
    (snake_case path parameters, operation IDs, and JSON properties).
    Pagination is offset-based (`page`, `per_page`) returning a wrapper
    with the resource-named array plus `page_count` and `total_count`.

    > Live sources are managed through the separate **UP.LiveSources**
    > service at `/livesources/v1` and are organisation-scoped. A
    > channel references a source by its `source_id`.
  termsOfService: https://www.telestream.net/telestream-cloud/terms.htm
  contact:
    name: API Support
    url: https://www.telestream.com
    email: up@telestream.net
  license:
    name: Proprietary — Telestream
servers:
  - url: https://app.up.telestream.com/livecapture/v1
    description: Production
security:
  - BearerAuth: []
tags:
  - name: channel
    description: Operations related to recording channels
  - name: recording
    description: Operations related to channel recordings
  - name: event
    description: Operations related to scheduled events
  - name: access
    description: Operations related to access checks
paths:
  /{space_id}/events:
    parameters:
      - $ref: '#/components/parameters/space_id'
    get:
      tags:
        - event
      summary: Returns a list of scheduled events in the specified space.
      operationId: list_events
      parameters:
        - $ref: '#/components/parameters/page'
        - $ref: '#/components/parameters/per_page'
        - name: name_lookup
          description: >-
            Substring or exact match on event name (matches the GraphQL
            StringMatcher).
          schema:
            type: string
          in: query
          required: false
        - name: name_case_sensitive
          description: Whether `name_lookup` is matched case-sensitively.
          schema:
            type: boolean
            default: false
          in: query
          required: false
        - name: name_substring
          description: Whether `name_lookup` is treated as a substring match.
          schema:
            type: boolean
            default: true
          in: query
          required: false
        - name: colors
          description: Filter by event colors.
          schema:
            type: array
            items:
              $ref: '#/components/schemas/Color'
          in: query
          required: false
        - name: tags_any
          description: Match events tagged with any of the given tags.
          schema:
            type: array
            items:
              type: string
          in: query
          required: false
        - name: tags_all
          description: Match events tagged with all of the given tags.
          schema:
            type: array
            items:
              type: string
          in: query
          required: false
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/EventsCollection'
          description: List Events
        '401':
          $ref: '#/components/responses/Unauthorized'
        '500':
          $ref: '#/components/responses/InternalError'
      security:
        - BearerAuth:
            - livecapture:event:access
components:
  parameters:
    space_id:
      name: space_id
      description: UP Space Id
      schema:
        type: string
        format: uuid
      in: path
      required: true
    page:
      name: page
      description: Page
      schema:
        default: 1
        type: integer
      in: query
      required: false
    per_page:
      name: per_page
      description: Number of entries per page
      schema:
        default: 30
        type: integer
      in: query
      required: false
  schemas:
    Color:
      enum:
        - BLUE
        - CYAN
        - GREEN
        - MAGENTA
        - RED
        - YELLOW
      type: string
    EventsCollection:
      type: object
      properties:
        events:
          description: List of Events for the current page.
          type: array
          items:
            $ref: '#/components/schemas/Event'
        page:
          type: integer
          examples:
            - 1
        per_page:
          type: integer
          examples:
            - 30
        page_count:
          type: integer
          examples:
            - 1
        total_count:
          type: integer
          examples:
            - 12
    Event:
      type: object
      required:
        - id
        - name
        - color
        - duration
        - rrule
        - tags
        - tasks
      properties:
        id:
          type: string
          format: uuid
        name:
          type: string
        color:
          $ref: '#/components/schemas/Color'
        duration:
          type: integer
          description: Duration in seconds for each occurrence. May be 0.
        rrule:
          type: string
          description: RFC-5545 §3.8.5.3 recurrence rule, including time zone.
        tags:
          type: array
          items:
            type: string
        tasks:
          type: array
          items:
            $ref: '#/components/schemas/Task'
    Task:
      type: object
      required:
        - id
        - type_id
        - target_object
        - duration
        - time_offset
      properties:
        id:
          type: string
          format: uuid
        type_id:
          type: string
          format: uuid
          description: Identifier of the task type.
        target_object:
          type: string
          format: uuid
          description: ID of the object the task targets in the owning application.
        duration:
          type: integer
          description: Duration in seconds. Must be 0 if the task type has no duration.
        time_offset:
          $ref: '#/components/schemas/TimeOffset'
        payload:
          type:
            - string
            - 'null'
          description: Optional JSON payload passed to every action in the task.
    TimeOffset:
      type: object
      required:
        - amount
        - relative_to
      properties:
        amount:
          type: integer
          description: |
            Offset in seconds. Negative values fall before the
            reference point; positive values fall after.
        relative_to:
          $ref: '#/components/schemas/TimeOffsetReferencePoint'
    TimeOffsetReferencePoint:
      enum:
        - START
        - END
      type: string
  responses:
    Unauthorized:
      content:
        application/json:
          schema:
            type: object
            properties:
              error_message:
                type: string
            examples:
              - error_message: You don't have permission to access this resource
      description: Not authorized
    InternalError:
      content:
        application/json:
          schema:
            type: object
            properties:
              error_message:
                type: string
            examples:
              - error_message: 500 internal error
      description: 500 Internal error
  securitySchemes:
    BearerAuth:
      type: oauth2
      description: OAuth2 bearer token in the Authorization header
      flows:
        clientCredentials:
          tokenUrl: /auth/token
          scopes:
            livecapture:access: Validate that the token has access to LiveCapture in a space
            livecapture:channel:access: Read access to channels
            livecapture:channel:channel-management: Manage (create / update / delete / activate / record) channels
            livecapture:event:access: Read access to scheduled events
            livecapture:event:event-management: Manage (create / update / delete) scheduled events

````