BuildWorkPro Calendar API

openapi: 3.2.0
info:
  title: BuildWorkPro Calendar API
  version: 1.0.0
  description: Construction project management, CRM, and workflows — public REST API.
  contact:
    name: BuildWorkPro Developers
    email: developers@buildworkpro.com
  license:
    name: Proprietary
    url: https://buildworkpro.com/terms
servers:
- url: https://app.buildworkpro.com/api/v1
  description: Production
security:
- bearerAuth: []
tags:
- name: Calendar
  description: Scheduled events derived from project phases, tasks and bid deadlines.
paths:
  /calendar/events:
    get:
      summary: List calendar events
      description: Returns a list of calendar events within the given time window. Aggregates projects, tasks, phases, leads, bids and activities. Max window 366 days.
      security:
      - bearerAuth:
        - projects:read
      tags:
      - Calendar
      parameters:
      - schema:
          type: string
          format: date-time
        required: true
        name: start
        in: query
      - schema:
          type: string
          format: date-time
        required: true
        name: end
        in: query
      - schema:
          type: string
        required: false
        name: types
        in: query
      - schema:
          type:
          - integer
          - 'null'
        required: false
        name: assignedTo
        in: query
      - schema:
          type:
          - integer
          - 'null'
        required: false
        name: projectId
        in: query
      responses:
        '200':
          description: Events
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    type: array
                    items:
                      $ref: '#/components/schemas/CalendarEvent'
                  meta:
                    $ref: '#/components/schemas/ResponseMeta'
                required:
                - data
                - meta
        '400':
          description: Error
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/ProblemDetails'
        '403':
          description: Error
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/ProblemDetails'
      operationId: getCalendarEvents
      x-rate-limit-cost: 1
components:
  schemas:
    ResponseMeta:
      type: object
      properties:
        request_id:
          type: string
          description: Server-generated request identifier
        pagination:
          $ref: '#/components/schemas/PaginationMeta'
    PaginationMeta:
      type: object
      properties:
        cursor:
          type:
          - string
          - 'null'
          description: Opaque cursor for the next page; null when no more results
        has_more:
          type: boolean
          description: Whether more pages are available after this one
        count:
          type: integer
          description: Items in this page
      required:
      - cursor
      - has_more
      - count
    CalendarEvent:
      type: object
      properties:
        id:
          anyOf:
          - type: string
          - type: number
        type:
          type: string
          enum:
          - task
          - phase
          - project
          - lead
          - activity
          - bid
        title:
          type: string
        start:
          anyOf:
          - type: string
            format: date-time
          - type: string
          - type: 'null'
        end:
          anyOf:
          - type: string
            format: date-time
          - type: string
          - type: 'null'
        projectId:
          type:
          - integer
          - 'null'
        assignedTo:
          type:
          - integer
          - 'null'
      required:
      - id
      - type
      - title
      - start
      - end
    ProblemDetails:
      type: object
      properties:
        type:
          type: string
          format: uri
          description: URL identifying the problem type
        title:
          type: string
          description: Short human-readable summary
        status:
          type: integer
          description: HTTP status code
        detail:
          type: string
          description: Human-readable explanation
        request_id:
          type: string
          description: Server-generated request identifier
        errors:
          type: array
          items:
            type: object
            properties:
              field:
                type: string
                description: Field path that failed validation
              code:
                type: string
                description: Validation error code
              message:
                type: string
                description: Human-readable validation message
            required:
            - field
            - code
            - message
          description: Validation error array (422 only)
      required:
      - type
      - title
      - status
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      bearerFormat: bwp_live_... or bwp_test_...
      description: Long-lived tenant-wide API key. Provision in Settings → Developer → API Keys.
    oauth2:
      type: oauth2
      description: OAuth 2.1 per-user token. Available in Phase 4.
      flows:
        authorizationCode:
          authorizationUrl: https://app.buildworkpro.com/api/v1/oauth/authorize
          tokenUrl: https://app.buildworkpro.com/api/v1/oauth/token
          refreshUrl: https://app.buildworkpro.com/api/v1/oauth/token
          scopes: {}