Runn Activity Log API

openapi: 3.2.0
info:
  title: Runn Activity Log API
  version: 1.0.0
  description: 'See the full documentation and guide to using the Runn API.


    The domain for your API endpoint can be found in Accounts > Settings > API in your Runn application'
servers:
- url: https://api.runn.io
  description: EU Server
- url: https://api.us.runn.io
  description: US Server
security:
- bearerAuth: []
tags:
- name: Activity Log
paths:
  /activity-log/:
    get:
      operationId: listActivityLog
      summary: List events
      description: Get a list of events that have occurred. Expand the RESPONSES (200) panel below to see supported events. Test accounts are not supported. More events will be added in the future.
      parameters:
      - schema:
          type: string
        in: query
        name: cursor
        required: false
        description: Cursor for paginated requests
      - schema:
          default: 50
          minimum: 1
          maximum: 200
          type: integer
        in: query
        name: limit
        required: false
        description: The number of results per page
      - schema:
          type: array
          items:
            type: string
            enum:
            - project_deleted
            - person_deleted
            - contract_deleted
            - actual_deleted
            - time_off_deleted
            - assignment_deleted
        in: query
        name: eventType
        required: false
        description: Filter by event type, e.g. project_deleted. If not provided, all event types are returned.
      - schema:
          format: date-time
          type: string
        in: query
        name: occurredAfter
        required: false
        description: Only return events that occurred after this time. ISO 8601 format.
      - schema:
          type: string
          enum:
          - asc
          - desc
          default: desc
        in: query
        name: orderBy
        required: false
        description: Order the events by when they occurred.
      - schema:
          default: 1.0.0
          enum:
          - 1.0.0
        in: header
        name: accept-version
        required: true
      responses:
        '200':
          description: Default Response
          content:
            application/json:
              schema:
                type: object
                properties:
                  values:
                    type: array
                    items:
                      $ref: '#/components/schemas/Event'
                  nextCursor:
                    type: string
                    nullable: true
                required:
                - values
                - nextCursor
        '400':
          description: Default Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BadRequest'
        '401':
          description: Default Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Unauthorized'
        '422':
          description: Default Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UnprocessableEntity'
      tags:
      - Activity Log
components:
  schemas:
    ActorCsv:
      title: CSV Actor
      description: The csv actor represents an action performed by a csv file upload.
      type: object
      properties:
        type:
          type: string
          enum:
          - csv
        userId:
          description: The id of the user who uploaded the csv file.
          type: number
        userEmail:
          description: The email of the user who uploaded the csv file.
          type: string
      required:
      - type
    Event.PersonDeleted:
      title: Person Deleted Event
      description: A person was deleted.
      type: object
      properties:
        eventId:
          type: string
        type:
          description: The unique type of the event
          type: string
          enum:
          - person_deleted
        actor:
          $ref: '#/components/schemas/Actor'
        timestamp:
          type: string
          format: date-time
          description: The time the event occurred in ISO8601 format.
        person:
          description: Details about the person that was deleted.
          type: object
          properties:
            id:
              description: The id of the person at the time they were deleted.
              type: integer
            email:
              description: The email of the person at the time they were deleted.
              type: string
              nullable: true
            firstName:
              description: The first name of the person at the time they were deleted.
              type: string
            lastName:
              description: The last name of the person at the time they were deleted.
              type: string
          required:
          - id
          - email
          - firstName
          - lastName
      required:
      - eventId
      - type
      - actor
      - timestamp
      - person
    Event.Subresource.Workstream:
      title: Workstream Event Subresource
      description: A subset of details about the workstream used on an event
      type: object
      properties:
        id:
          description: The unique identifier of the workstream
          type: integer
        name:
          description: The name of the workstream
          type: string
      required:
      - id
      - name
    Unauthorized:
      type: object
      properties:
        error:
          type: string
          enum:
          - Unauthorized
        message:
          type: string
          enum:
          - Unauthorized
        statusCode:
          type: number
          enum:
          - 401
      required:
      - error
      - message
      - statusCode
    BadRequest:
      type: object
      properties:
        error:
          type: string
          enum:
          - Bad Request
        message:
          type: string
        statusCode:
          type: number
          enum:
          - 400
      required:
      - error
      - message
      - statusCode
    Actor:
      discriminator:
        propertyName: type
        mapping:
          runn_support: '#/components/schemas/ActorRunnSupport'
          user: '#/components/schemas/ActorUser'
          api: '#/components/schemas/ActorApi'
          csv: '#/components/schemas/ActorCsv'
          integration: '#/components/schemas/ActorIntegration'
          system: '#/components/schemas/ActorSystem'
      title: Actor
      description: An actor represents an entity that can perform actions such as a user, api key, or system process. Each actor type has a unique set of properties. The `type` property is used to determine the actor type.
      anyOf:
      - $ref: '#/components/schemas/ActorRunnSupport'
      - $ref: '#/components/schemas/ActorUser'
      - $ref: '#/components/schemas/ActorApi'
      - $ref: '#/components/schemas/ActorCsv'
      - $ref: '#/components/schemas/ActorIntegration'
      - $ref: '#/components/schemas/ActorSystem'
    Event.ProjectDeleted:
      title: Project Deleted Event
      description: A project was deleted.
      type: object
      properties:
        eventId:
          type: string
        type:
          description: The unique type of the event
          type: string
          enum:
          - project_deleted
        actor:
          $ref: '#/components/schemas/Actor'
        timestamp:
          type: string
          format: date-time
          description: The time the event occurred in ISO8601 format.
        project:
          description: Details about the project that was deleted.
          type: object
          properties:
            id:
              description: The id of the project at the time it was deleted.
              type: integer
            name:
              description: The name of the project at the time it was deleted.
              type: string
          required:
          - id
          - name
      required:
      - eventId
      - type
      - actor
      - timestamp
      - project
    Event.ContractDeleted:
      title: Contract Deleted Event
      description: A contract was deleted.
      type: object
      properties:
        eventId:
          type: string
        type:
          description: The unique type of the event
          type: string
          enum:
          - contract_deleted
        actor:
          $ref: '#/components/schemas/Actor'
        timestamp:
          type: string
          format: date-time
          description: The time the event occurred in ISO8601 format.
        contract:
          type: object
          properties:
            id:
              description: The unique identifier of the contract.
              type: integer
            personId:
              description: The unique identifier of the person associated with the contract.
              type: integer
            roleId:
              description: The unique identifier of the role associated with the contract.
              type: integer
            startDate:
              description: The start date of the contract.
              format: date
              type: string
            endDate:
              format: date
              description: The end date of the contract. If the contract was ongoing, this field will be null.
              type: string
              nullable: true
            person:
              $ref: '#/components/schemas/Event.Subresource.Person'
              nullable: true
            role:
              $ref: '#/components/schemas/Event.Subresource.Role'
              nullable: true
          required:
          - id
          - personId
          - roleId
          - startDate
          - endDate
          - person
          - role
      required:
      - eventId
      - type
      - actor
      - timestamp
      - contract
    Event.ActualDeleted:
      title: Actual Deleted Event
      description: An actual was deleted.
      type: object
      properties:
        eventId:
          type: string
        type:
          description: The unique type of the event
          type: string
          enum:
          - actual_deleted
        actor:
          $ref: '#/components/schemas/Actor'
        timestamp:
          type: string
          format: date-time
          description: The time the event occurred in ISO8601 format.
        actual:
          description: Details about the actual that was deleted.
          type: object
          properties:
            id:
              description: The id of the actual at the time it was deleted.
              type: integer
            date:
              description: The date of the actual at the time it was deleted.
              type: string
            personId:
              description: The id of the person associated with the actual.
              type: integer
            roleId:
              description: The id of the role associated with the actual.
              type: integer
            projectId:
              description: The id of the project associated with the actual.
              type: integer
            phaseId:
              description: The id referencing the phase of the actual, if applicable.
              type: number
              nullable: true
            workstreamId:
              description: The id of the workstream associated with the actual.
              type: integer
              nullable: true
            billableMinutes:
              description: The number of billable minutes for the actual
              type: number
            nonbillableMinutes:
              description: The number of nonbillable minutes for the actual
              type: number
            billableNote:
              description: A note or comment related to the billable minutes, if any.
              type: string
              nullable: true
            nonbillableNote:
              description: A note or comment related to the nonbillable minutes, if any.
              type: string
              nullable: true
            person:
              $ref: '#/components/schemas/Event.Subresource.Person'
              nullable: true
            role:
              $ref: '#/components/schemas/Event.Subresource.Role'
              nullable: true
            project:
              $ref: '#/components/schemas/Event.Subresource.Project'
              nullable: true
            workstream:
              $ref: '#/components/schemas/Event.Subresource.Workstream'
              nullable: true
          required:
          - id
          - date
          - personId
          - roleId
          - projectId
          - phaseId
          - workstreamId
          - billableMinutes
          - nonbillableMinutes
          - billableNote
          - nonbillableNote
          - person
          - role
          - project
          - workstream
      required:
      - eventId
      - type
      - actor
      - timestamp
      - actual
    Event.Subresource.Role:
      title: Role Event Subresource
      description: A subset of details about the role used on an event
      type: object
      properties:
        id:
          description: The unique identifier of the role
          type: integer
        name:
          description: The name of the role
          type: string
        active:
          description: Whether the role is active
          type: boolean
      required:
      - id
      - name
      - active
    ActorIntegration:
      title: Integration Actor
      description: The integration actor represents an action performed by an integration with a third-party service.
      type: object
      properties:
        type:
          type: string
          enum:
          - integration
        id:
          description: The id of the integration.
          type: number
        name:
          description: The name of the integration.
          type: string
      required:
      - type
      - id
      - name
    Event.Subresource.Phase:
      title: Phase Event Subresource
      description: A subset of details about the phase used on an event
      type: object
      properties:
        id:
          description: The unique identifier of the phase
          type: integer
        name:
          description: The name of the phase
          type: string
      required:
      - id
      - name
    Event.AssignmentDeleted:
      title: Assignment Deleted Event
      description: An assignment was deleted.
      type: object
      properties:
        eventId:
          type: string
        type:
          description: The unique type of the event
          type: string
          enum:
          - assignment_deleted
        actor:
          $ref: '#/components/schemas/Actor'
        timestamp:
          type: string
          format: date-time
          description: The time the event occurred in ISO8601 format.
        assignment:
          description: Details about the assignment that was deleted.
          type: object
          properties:
            id:
              description: The unique identifier of the assignment.
              type: integer
            personId:
              description: The unique identifier of the person associated with the assignment.
              type: integer
            startDate:
              format: date
              description: 'The start date of the assignment. Format: YYYY-MM-DD'
              type: string
            endDate:
              format: date
              description: 'The end date of the assignment. Format: YYYY-MM-DD'
              type: string
            projectId:
              description: The ID referencing the project to which the assignment belongs.
              type: integer
            minutesPerDay:
              description: The number of minutes allocated to the assignment per day.
              type: integer
            roleId:
              description: The unique identifier of the role associated with the assignment.
              type: integer
            isActive:
              description: A flag indicating whether the assignment is currently active.
              type: boolean
            note:
              type: string
              nullable: true
            isBillable:
              description: A flag indicating whether the assignment is billable.
              type: boolean
            phaseId:
              type: integer
              nullable: true
            isNonWorkingDay:
              description: A flag indicating if the assignment falls on a non-working day.
              type: boolean
            isTemplate:
              description: A flag indicating if the assignment is a template.
              type: boolean
            workstreamId:
              type: number
              nullable: true
            project:
              $ref: '#/components/schemas/Event.Subresource.Project'
              nullable: true
            person:
              $ref: '#/components/schemas/Event.Subresource.Person'
              nullable: true
            role:
              $ref: '#/components/schemas/Event.Subresource.Role'
              nullable: true
            phase:
              $ref: '#/components/schemas/Event.Subresource.Phase'
              nullable: true
            workstream:
              $ref: '#/components/schemas/Event.Subresource.Workstream'
              nullable: true
          required:
          - id
          - personId
          - startDate
          - endDate
          - projectId
          - minutesPerDay
          - roleId
          - isActive
          - note
          - isBillable
          - phaseId
          - isNonWorkingDay
          - isTemplate
          - workstreamId
          - project
          - person
          - role
          - phase
          - workstream
      required:
      - eventId
      - type
      - actor
      - timestamp
      - assignment
    ActorApi:
      title: API Actor
      description: The api actor represents an action performed by an api key.
      type: object
      properties:
        type:
          type: string
          enum:
          - api
        tokenId:
          description: The id of the api key.
          type: number
        tokenName:
          description: The name of the api key.
          type: string
        apiVersion:
          description: The api version.
          type: string
      required:
      - type
      - tokenId
      - tokenName
      - apiVersion
    ActorRunnSupport:
      title: Runn Support Actor
      description: The Runn Support actor represents an action performed by the Runn supprt team. If you have questions about actions performed by the Runn support team, please contact the Runn team.
      type: object
      properties:
        type:
          type: string
          enum:
          - runn_support
      required:
      - type
    ActorSystem:
      title: System Actor
      description: The system actor represents an action performed by the system, such as a scheduled task, migration, or other automated process. Some actions may not have a specific actor and will default to the system actor.
      type: object
      properties:
        type:
          type: string
          enum:
          - system
      required:
      - type
    UnprocessableEntity:
      type: object
      properties:
        error:
          type: string
          enum:
          - Unprocessable Entity
        message:
          type: string
        statusCode:
          type: number
          enum:
          - 422
      required:
      - error
      - message
      - statusCode
    Event.Subresource.Person:
      title: Person Event Subresource
      description: A subset of details about the person used on an event
      type: object
      properties:
        id:
          description: The unique identifier of the person
          type: integer
        firstName:
          description: The first name of the person
          type: string
        lastName:
          description: The last name of the person
          type: string
        email:
          description: The email address of the person
          type: string
          nullable: true
          example: user@example.com
        isPlaceholder:
          description: A flag indicating if the person is a placeholder
          type: boolean
      required:
      - id
      - firstName
      - lastName
      - email
      - isPlaceholder
    Event.TimeOffDeleted:
      title: Time Off Deleted Event
      description: A time off was deleted.
      type: object
      properties:
        eventId:
          type: string
        type:
          description: The unique type of the event
          type: string
          enum:
          - time_off_deleted
        actor:
          $ref: '#/components/schemas/Actor'
        timestamp:
          type: string
          format: date-time
          description: The time the event occurred in ISO8601 format.
        timeOff:
          type: object
          properties:
            id:
              description: The unique identifier for the time-off.
              type: integer
            personId:
              description: The identifier referencing the person associated with the time-off.
              type: integer
            startDate:
              format: date
              description: The start date of the time-off.
              type: string
            endDate:
              format: date
              description: The end date of the time-off.
              type: string
            note:
              type: string
              nullable: true
            minutesPerDay:
              type: integer
              nullable: true
            person:
              $ref: '#/components/schemas/Event.Subresource.Person'
              nullable: true
          required:
          - id
          - personId
          - startDate
          - endDate
          - note
          - minutesPerDay
          - person
      required:
      - eventId
      - type
      - actor
      - timestamp
      - timeOff
    Event.Subresource.Project:
      title: Project Event Subresource
      description: A subset of details about the project used on an event
      type: object
      properties:
        id:
          description: The unique identifier of the project
          type: integer
        name:
          description: The name of the project
          type: string
      required:
      - id
      - name
    Event:
      discriminator:
        propertyName: type
        mapping:
          project_deleted: '#/components/schemas/Event.ProjectDeleted'
          person_deleted: '#/components/schemas/Event.PersonDeleted'
          contract_deleted: '#/components/schemas/Event.ContractDeleted'
          actual_deleted: '#/components/schemas/Event.ActualDeleted'
          time_off_deleted: '#/components/schemas/Event.TimeOffDeleted'
          assignment_deleted: '#/components/schemas/Event.AssignmentDeleted'
      title: Event
      description: An event represents an action that occurred.       Every event has a `type`, `actor`, and `timestamp` property.       Use the `type` property to determine which event occurred.
      anyOf:
      - $ref: '#/components/schemas/Event.ProjectDeleted'
      - $ref: '#/components/schemas/Event.PersonDeleted'
      - $ref: '#/components/schemas/Event.ContractDeleted'
      - $ref: '#/components/schemas/Event.ActualDeleted'
      - $ref: '#/components/schemas/Event.TimeOffDeleted'
      - $ref: '#/components/schemas/Event.AssignmentDeleted'
    ActorUser:
      title: User Actor
      description: The user actor represents a user. This usually means a user who interacted with the web application.
      type: object
      properties:
        type:
          type: string
          enum:
          - user
        userId:
          type: number
        userEmail:
          type: string
      required:
      - type
      - userId
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
x-readme:
  proxy-enabled: false