BuildWorkPro

BuildWorkPro Site Logs API

Daily field reports, photos and their review state.

GitHub OpenAPI

Operations 10

POST /site-logs/{id}/move Move a site log to another project #
GET /site-logs List site logs #
POST /site-logs Create site log #
GET /site-logs/{id} Get site log by id #
PATCH /site-logs/{id} Update site log #
DELETE /site-logs/{id} Delete site log #
GET /site-logs/{id}/report.pdf Download a site log as a daily report PDF #
POST /site-logs/exports Start CSV export of site logs #
POST /site-logs/imports Start CSV import of site logs #
POST /site-logs/bulk Start bulk operation on site logs #

Specifications

⚙
OpenAPI
https://artifacts.apis.io/buildworkpro-com/openapi/buildworkpro-com-sitelogs-api-openapi.yml

Schemas & Data

📊
JSONSchema
https://artifacts.apis.io/buildworkpro-com/json-schema/buildworkpro-com-bid-schema.json
📊
JSONSchema
https://artifacts.apis.io/buildworkpro-com/json-schema/buildworkpro-com-bid-line-item-schema.json
📊
JSONSchema
https://artifacts.apis.io/buildworkpro-com/json-schema/buildworkpro-com-update-project-schema.json
📊
JSONSchema
https://artifacts.apis.io/buildworkpro-com/json-schema/buildworkpro-com-create-project-schema.json
📊
JSONSchema
https://artifacts.apis.io/buildworkpro-com/json-schema/buildworkpro-com-project-schema.json
📊
JSONSchema
https://artifacts.apis.io/buildworkpro-com/json-schema/buildworkpro-com-pay-app-schema.json

Work with this as data

Every API here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for apis

7 MCP tools reach this
  • find_apisBrowse and filter every API in the catalog.
  • get_api_artifactsOne API's artifacts, grouped by type.
  • get_openapiThe primary OpenAPI for this API.
  • find_similar_apisAPIs that look like this one.
  • apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
  • resolveTurn a domain, URL or GitHub org into the provider it belongs to.
  • find_cohortsEvery scored population of providers in the catalog.
All 92 tools →

Call it yourself

curl for this page
This API 
curl "https://apis.io/api/v1/apis/buildworkpro-com:buildworkpro-com-sitelogs-api"
All apis 
curl "https://apis.io/api/v1/apis?limit=25"

Calls without X-API-Key need no key. Calls with it need a paid plan — get a key.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have.

OpenAPI Specification

buildworkpro-com-sitelogs-api-openapi.yml Raw ↑ 
openapi: 3.2.0
info:
  title: BuildWorkPro Site Logs 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: SiteLogs
  description: Daily field reports, photos and their review state.
paths:
  /site-logs/{id}/move:
    post:
      summary: Move a site log to another project
      description: Re-points the site log at `targetProjectId`, which must belong to your organization and must not be deleted. Needs `projects:reassign` rather than this resource's own write scope.
      security:
      - bearerAuth:
        - projects:reassign
      tags:
      - SiteLogs
      parameters:
      - $ref: '#/components/parameters/IdempotencyKey'
      - schema:
          type: integer
        required: true
        name: id
        in: path
      requestBody:
        content:
          application/json:
            schema:
              type: object
              properties:
                targetProjectId:
                  type: integer
                  exclusiveMinimum: 0
              required:
              - targetProjectId
      responses:
        '200':
          description: Moved
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    $ref: '#/components/schemas/MoveResult'
                  meta:
                    $ref: '#/components/schemas/ResponseMeta'
                required:
                - data
                - meta
        '404':
          description: Error
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/ProblemDetails'
        '409':
          description: Error
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/ProblemDetails'
        '422':
          description: Error
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/ProblemDetails'
      operationId: postSiteLogsByIdMove
      x-rate-limit-cost: 5
  /site-logs:
    get:
      summary: List site logs
      description: Returns a cursor-paginated list of site logs.
      security:
      - bearerAuth:
        - site_logs:read
      tags:
      - SiteLogs
      parameters:
      - schema:
          type: integer
          minimum: 1
          maximum: 100
        required: false
        name: limit
        in: query
      - schema:
          type: string
        required: false
        name: cursor
        in: query
      - schema:
          type:
          - integer
          - 'null'
        required: false
        name: projectId
        in: query
      - schema:
          type: string
        required: false
        name: dateFrom
        in: query
      - schema:
          type: string
        required: false
        name: dateTo
        in: query
      - schema:
          type: string
        required: false
        name: tag
        in: query
      - schema:
          type: string
          enum:
          - 'true'
          - 'false'
        required: false
        name: reviewed
        in: query
      - schema:
          type: string
        required: false
        name: search
        in: query
      - schema:
          type: boolean
          description: Return compact row projection (id + key fields only).
        required: false
        description: Return compact row projection (id + key fields only).
        name: compact
        in: query
      responses:
        '200':
          description: SiteLogs page
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    type: array
                    items:
                      $ref: '#/components/schemas/SiteLog'
                  meta:
                    $ref: '#/components/schemas/ResponseMeta'
                required:
                - data
                - meta
        '403':
          description: Error
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/ProblemDetails'
      operationId: getSiteLogs
      x-rate-limit-cost: 1
    post:
      summary: Create site log
      security:
      - bearerAuth:
        - site_logs:write
      tags:
      - SiteLogs
      parameters:
      - $ref: '#/components/parameters/IdempotencyKey'
      requestBody:
        content:
          application/json:
            schema:
              type: object
              properties:
                projectId:
                  type: integer
                  minimum: -2147483648
                  maximum: 2147483647
                logDate:
                  type: string
                title:
                  type:
                  - string
                  - 'null'
                notes:
                  type: string
                tags:
                  type: array
                  items:
                    type: string
                    enum:
                    - progress
                    - issue
                    - delay
                    - safety
                    - delivery
                    - inspection
                    - general
                personnelCount:
                  type:
                  - integer
                  - 'null'
                  minimum: -2147483648
                  maximum: 2147483647
                workPerformed:
                  type:
                  - string
                  - 'null'
                materialsReceived:
                  type:
                  - string
                  - 'null'
                visitorsOnSite:
                  type:
                  - string
                  - 'null'
                issues:
                  type:
                  - string
                  - 'null'
                lat:
                  type:
                  - number
                  - 'null'
                  minimum: -90
                  maximum: 90
                lng:
                  type:
                  - number
                  - 'null'
                  minimum: -180
                  maximum: 180
                clientId:
                  type:
                  - string
                  - 'null'
                  format: uuid
                  description: Optional idempotency key (a UUID the client mints once per queued create and repeats on every retry). A repeat with the same key from the same user returns the existing record with 200 instead of creating a duplicate.
              required:
              - projectId
              - logDate
              - notes
      responses:
        '200':
          description: Replay of an earlier create with the same `clientId` — the existing site log, unchanged
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    $ref: '#/components/schemas/SiteLog'
                  meta:
                    $ref: '#/components/schemas/ResponseMeta'
                required:
                - data
                - meta
        '201':
          description: Created
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    $ref: '#/components/schemas/SiteLog'
                  meta:
                    $ref: '#/components/schemas/ResponseMeta'
                required:
                - data
                - meta
        '409':
          description: Error
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/ProblemDetails'
        '422':
          description: Error
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/ProblemDetails'
      operationId: postSiteLogs
      x-rate-limit-cost: 5
  /site-logs/{id}:
    get:
      summary: Get site log by id
      security:
      - bearerAuth:
        - site_logs:read
      tags:
      - SiteLogs
      parameters:
      - schema:
          type: integer
        required: true
        name: id
        in: path
      responses:
        '200':
          description: SiteLog
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    $ref: '#/components/schemas/SiteLog'
                  meta:
                    $ref: '#/components/schemas/ResponseMeta'
                required:
                - data
                - meta
        '404':
          description: Error
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/ProblemDetails'
      operationId: getSiteLogsById
      x-rate-limit-cost: 1
    patch:
      summary: Update site log
      security:
      - bearerAuth:
        - site_logs:write
      tags:
      - SiteLogs
      parameters:
      - $ref: '#/components/parameters/IdempotencyKey'
      - schema:
          type: integer
        required: true
        name: id
        in: path
      requestBody:
        content:
          application/json:
            schema:
              type: object
              properties:
                projectId:
                  type: integer
                  minimum: -2147483648
                  maximum: 2147483647
                logDate:
                  type: string
                title:
                  type:
                  - string
                  - 'null'
                notes:
                  type: string
                tags:
                  type: array
                  items:
                    type: string
                    enum:
                    - progress
                    - issue
                    - delay
                    - safety
                    - delivery
                    - inspection
                    - general
                personnelCount:
                  type:
                  - integer
                  - 'null'
                  minimum: -2147483648
                  maximum: 2147483647
                workPerformed:
                  type:
                  - string
                  - 'null'
                materialsReceived:
                  type:
                  - string
                  - 'null'
                visitorsOnSite:
                  type:
                  - string
                  - 'null'
                issues:
                  type:
                  - string
                  - 'null'
                lat:
                  type:
                  - number
                  - 'null'
                  minimum: -90
                  maximum: 90
                lng:
                  type:
                  - number
                  - 'null'
                  minimum: -180
                  maximum: 180
      responses:
        '200':
          description: Updated
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    $ref: '#/components/schemas/SiteLog'
                  meta:
                    $ref: '#/components/schemas/ResponseMeta'
                required:
                - data
                - meta
        '404':
          description: Error
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/ProblemDetails'
        '422':
          description: Error
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/ProblemDetails'
      operationId: patchSiteLogsById
      x-rate-limit-cost: 5
    delete:
      summary: Delete site log
      security:
      - bearerAuth:
        - site_logs:delete
      tags:
      - SiteLogs
      parameters:
      - $ref: '#/components/parameters/IdempotencyKey'
      - schema:
          type: integer
        required: true
        name: id
        in: path
      responses:
        '204':
          description: Deleted
        '404':
          description: Error
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/ProblemDetails'
      operationId: deleteSiteLogsById
      x-rate-limit-cost: 5
  /site-logs/{id}/report.pdf:
    get:
      summary: Download a site log as a daily report PDF
      description: 'Renders the site log as an `application/pdf` daily report: tenant branding, project and address, date and weather, tags, personnel, notes, work performed / materials / visitors / issues, photo thumbnails, and a filed-by / reviewed-by footer. Same renderer and branding as the session `GET /api/site-logs/:id/report.pdf` route.'
      operationId: getSiteLogsByIdReportPdf
      security:
      - bearerAuth:
        - site_logs:read
      tags:
      - SiteLogs
      parameters:
      - schema:
          type: integer
        required: true
        name: id
        in: path
      responses:
        '200':
          description: Daily report PDF
          content:
            application/pdf:
              schema:
                type: string
                format: binary
        '404':
          description: Error
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/ProblemDetails'
      x-rate-limit-cost: 50
  /site-logs/exports:
    post:
      summary: Start CSV export of site logs
      description: Enqueues a CSV export job for site logs. Poll /api/v1/jobs/{id} for status; GET /api/v1/jobs/{id}/download for the signed URL.
      security:
      - bearerAuth:
        - site_logs:read
        - jobs:write
      tags:
      - SiteLogs
      parameters:
      - $ref: '#/components/parameters/IdempotencyKey'
      requestBody:
        content:
          application/json:
            schema:
              type: object
              properties:
                filters:
                  type: object
                  additionalProperties: {}
      responses:
        '202':
          description: Job enqueued
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    type: object
                    properties:
                      job_id:
                        type: string
                      status_url:
                        type: string
                    required:
                    - job_id
                    - status_url
                  meta:
                    $ref: '#/components/schemas/ResponseMeta'
                required:
                - data
                - meta
        '403':
          description: Error
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/ProblemDetails'
      operationId: postSiteLogsExports
      x-rate-limit-cost: 20
  /site-logs/imports:
    post:
      summary: Start CSV import of site logs
      description: 'Enqueues a CSV import job. sourcePath must be an opaque upload path returned by POST /jobs/uploads. Required CSV columns: projectId, logDate (ISO), notes. Optional: id (triggers update-in-place when updateInPlace=true), title, workPerformed, issues. Review status is not importable — use the review endpoints, which require site_logs:review.'
      security:
      - bearerAuth:
        - site_logs:write
        - jobs:write
      tags:
      - SiteLogs
      parameters:
      - $ref: '#/components/parameters/IdempotencyKey'
      requestBody:
        content:
          application/json:
            schema:
              type: object
              properties:
                sourcePath:
                  type: string
                mapping:
                  type: object
                  additionalProperties:
                    type: string
                updateInPlace:
                  type: boolean
              required:
              - sourcePath
              - mapping
      responses:
        '202':
          description: Job enqueued
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    type: object
                    properties:
                      job_id:
                        type: string
                      status_url:
                        type: string
                    required:
                    - job_id
                    - status_url
                  meta:
                    $ref: '#/components/schemas/ResponseMeta'
                required:
                - data
                - meta
        '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: postSiteLogsImports
      x-rate-limit-cost: 200
  /site-logs/bulk:
    post:
      summary: Start bulk operation on site logs
      description: Enqueues a bulk delete/restore job for up to 500 site log ids.
      security:
      - bearerAuth:
        - site_logs:delete
        - jobs:write
      tags:
      - SiteLogs
      parameters:
      - $ref: '#/components/parameters/IdempotencyKey'
      requestBody:
        content:
          application/json:
            schema:
              type: object
              properties:
                operation:
                  type: string
                  enum:
                  - delete
                  - restore
                ids:
                  type: array
                  items:
                    type: integer
                    exclusiveMinimum: 0
                  minItems: 1
                  maxItems: 500
              required:
              - operation
              - ids
      responses:
        '202':
          description: Job enqueued
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    type: object
                    properties:
                      job_id:
                        type: string
                      status_url:
                        type: string
                    required:
                    - job_id
                    - status_url
                  meta:
                    $ref: '#/components/schemas/ResponseMeta'
                required:
                - data
                - meta
        '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: postSiteLogsBulk
      x-rate-limit-cost: 100
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
    SiteLog:
      type: object
      properties:
        id:
          type: integer
        projectId:
          type: integer
        logDate:
          anyOf:
          - type: string
            format: date-time
          - type: string
        title:
          type:
          - string
          - 'null'
        notes:
          type:
          - string
          - 'null'
        personnelCount:
          type:
          - integer
          - 'null'
        workPerformed:
          type:
          - string
          - 'null'
        materialsReceived:
          type:
          - string
          - 'null'
        visitorsOnSite:
          type:
          - string
          - 'null'
        issues:
          type:
          - string
          - 'null'
        tags:
          type:
          - array
          - 'null'
          items:
            type: string
        lat:
          type:
          - number
          - 'null'
        lng:
          type:
          - number
          - 'null'
        isReviewed:
          type: boolean
        createdAt:
          anyOf:
          - type: string
            format: date-time
          - type: string
        updatedAt:
          anyOf:
          - type: string
            format: date-time
          - type: string
      required:
      - id
      - projectId
      - logDate
      - title
      - notes
      - personnelCount
      - workPerformed
      - materialsReceived
      - visitorsOnSite
      - issues
      - tags
      - lat
      - lng
      - isReviewed
      - createdAt
      - updatedAt
    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'
    MoveResult:
      type: object
      properties:
        fromProjectId:
          type:
          - integer
          - 'null'
        toProjectId:
          type: integer
        cleared:
          type: array
          items:
            type: string
      required:
      - fromProjectId
      - toProjectId
      - cleared
  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: {}