BuildWorkPro Crew Assignments API

openapi: 3.2.0
info:
  title: BuildWorkPro Crew Assignments 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: CrewAssignments
  description: Daily crew assignments of tenant users to jobs (the dispatch board).
paths:
  /crew-assignments:
    get:
      summary: List crew assignments
      description: Returns crew assignments in a date range (inclusive, max 31 days). Callers without dispatch:write only receive their own rows. Paginated via limit/offset.
      security:
      - bearerAuth:
        - dispatch:read
      tags:
      - CrewAssignments
      parameters:
      - schema:
          type: string
          pattern: ^\d{4}-\d{2}-\d{2}$
        required: true
        name: from
        in: query
      - schema:
          type: string
          pattern: ^\d{4}-\d{2}-\d{2}$
        required: true
        name: to
        in: query
      - schema:
          type: integer
          exclusiveMinimum: 0
        required: false
        name: userId
        in: query
      - schema:
          type: integer
          minimum: 1
        required: false
        name: limit
        in: query
      - schema:
          type:
          - integer
          - 'null'
          minimum: 0
        required: false
        name: offset
        in: query
      responses:
        '200':
          description: Crew assignments
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    type: array
                    items:
                      $ref: '#/components/schemas/CrewAssignment'
                  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: getCrewAssignments
      x-rate-limit-cost: 1
  /crew-assignments/{id}:
    get:
      summary: Get a crew assignment
      security:
      - bearerAuth:
        - dispatch:read
      tags:
      - CrewAssignments
      parameters:
      - schema:
          type: integer
        required: true
        name: id
        in: path
      responses:
        '200':
          description: Crew assignment
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    $ref: '#/components/schemas/CrewAssignment'
                  meta:
                    $ref: '#/components/schemas/ResponseMeta'
                required:
                - data
                - meta
        '403':
          description: Error
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/ProblemDetails'
        '404':
          description: Error
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/ProblemDetails'
      operationId: getCrewAssignmentsById
      x-rate-limit-cost: 1
    delete:
      summary: Delete a crew assignment
      description: Soft-deletes a crew assignment.
      security:
      - bearerAuth:
        - dispatch:write
      tags:
      - CrewAssignments
      parameters:
      - $ref: '#/components/parameters/IdempotencyKey'
      - schema:
          type: integer
        required: true
        name: id
        in: path
      responses:
        '200':
          description: Deleted
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    type: object
                    properties:
                      id:
                        type: integer
                      deleted:
                        type: boolean
                    required:
                    - id
                    - deleted
                  meta:
                    $ref: '#/components/schemas/ResponseMeta'
                required:
                - data
                - meta
        '403':
          description: Error
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/ProblemDetails'
        '404':
          description: Error
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/ProblemDetails'
      operationId: deleteCrewAssignmentsById
      x-rate-limit-cost: 5
  /crew-assignments/{date}/{projectId}:
    put:
      summary: Replace a job-day's crew
      description: Sets the crew assigned to a project on a calendar day. Inserts missing users, soft-deletes removed ones, and optionally updates startTime/note for the job-day.
      security:
      - bearerAuth:
        - dispatch:write
      tags:
      - CrewAssignments
      parameters:
      - $ref: '#/components/parameters/IdempotencyKey'
      - schema:
          type: string
          pattern: ^\d{4}-\d{2}-\d{2}$
        required: true
        name: date
        in: path
      - schema:
          type: integer
        required: true
        name: projectId
        in: path
      requestBody:
        content:
          application/json:
            schema:
              type: object
              properties:
                userIds:
                  type: array
                  items:
                    type: integer
                    exclusiveMinimum: 0
                  maxItems: 200
                startTime:
                  type:
                  - string
                  - 'null'
                  pattern: ^([01]\d|2[0-3]):[0-5]\d(?::[0-5]\d)?$
                note:
                  type:
                  - string
                  - 'null'
                  maxLength: 2000
              required:
              - userIds
      responses:
        '200':
          description: Replaced crew
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    type: array
                    items:
                      $ref: '#/components/schemas/CrewAssignment'
                  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'
        '422':
          description: Error
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/ProblemDetails'
      operationId: putCrewAssignmentsByDateByProjectId
      x-rate-limit-cost: 5
components:
  schemas:
    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
    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
    ResponseMeta:
      type: object
      properties:
        request_id:
          type: string
          description: Server-generated request identifier
        pagination:
          $ref: '#/components/schemas/PaginationMeta'
    CrewAssignment:
      type: object
      properties:
        id:
          type: integer
        projectId:
          type: integer
        userId:
          type: integer
        date:
          type: string
        startTime:
          type:
          - string
          - 'null'
        note:
          type:
          - string
          - 'null'
        createdBy:
          type:
          - integer
          - 'null'
        createdAt:
          anyOf:
          - type: string
            format: date-time
          - type: string
        updatedAt:
          anyOf:
          - type: string
            format: date-time
          - type: string
        projectName:
          type:
          - string
          - 'null'
        projectNumber:
          type:
          - string
          - 'null'
        userFirstName:
          type:
          - string
          - 'null'
        userLastName:
          type:
          - string
          - 'null'
      required:
      - id
      - projectId
      - userId
      - date
      - startTime
      - note
      - createdBy
      - createdAt
      - updatedAt
      - projectName
      - projectNumber
      - userFirstName
      - userLastName
  parameters:
    IdempotencyKey:
      name: Idempotency-Key
      in: header
      required: false
      description: 'Idempotent retry key for mutating operations. The first request with a given key executes normally and BuildWorkPro caches the response. Replaying the same key with the same request body (method + path + JSON body, SHA-256 hashed) returns the cached response without re-executing the mutation. Replaying with a DIFFERENT body returns `409 idempotency_key_reused`. The cache TTL is 24 hours; after expiry the key is treated as a new operation. Keys are tenant-scoped. Recommended: a fresh UUID v4 per logical operation.'
      schema:
        type: string
        format: uuid
        maxLength: 255
  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: {}