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-reports-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

openapi: 3.2.0
info:
  title: BuildWorkPro Reports 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: Reports
  description: Reports v2 — the business review and the report catalog (AR aging, billed vs collected, bid performance, pipeline, WIP).
paths:
  /reports/catalog:
    get:
      summary: List the reports available to the caller
      description: Reports v2 catalog, filtered to the entity permissions the caller's role holds.
      security:
      - bearerAuth:
        - reports:read
      tags:
      - Reports
      responses:
        '200':
          description: Catalog
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    type: array
                    items:
                      type: object
                      properties:
                        slug:
                          type: string
                        title:
                          type: string
                        group:
                          type: string
                        description:
                          type: string
                        kind:
                          type: string
                        groupBys:
                          type: array
                          items:
                            type: string
                      required:
                      - slug
                      - title
                      - group
                      - description
                      - kind
                      - groupBys
                  meta:
                    $ref: '#/components/schemas/ResponseMeta'
                required:
                - data
                - meta
        '403':
          description: Error
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/ProblemDetails'
      operationId: getReportsCatalog
      x-rate-limit-cost: 1
  /reports/review:
    get:
      summary: Business review — Sold, Billed, Collected, Owed vs the prior period
      description: 'The weekly business review: four scorecard tiles with definitions and honest deltas, plus Money / Sales / Work sections. Role-shaped. Balances are as of `date` (the caller''s calendar day); flows cover dateFrom–dateTo.'
      security:
      - bearerAuth:
        - reports:read
      tags:
      - Reports
      parameters:
      - schema:
          type: string
          format: date-time
        required: false
        name: dateFrom
        in: query
      - schema:
          type: string
          format: date-time
        required: false
        name: dateTo
        in: query
      - schema:
          type: string
          pattern: ^\d{4}-\d{2}-\d{2}$
        required: false
        name: date
        in: query
      - schema:
          type: string
          maxLength: 64
        required: false
        name: tz
        in: query
      - schema:
          type: string
          maxLength: 32
        required: false
        name: preset
        in: query
      - schema:
          type: boolean
          default: false
        required: false
        name: compare
        in: query
      - schema:
          type: integer
          exclusiveMinimum: 0
        required: false
        name: customerId
        in: query
      - schema:
          type: integer
          exclusiveMinimum: 0
        required: false
        name: projectId
        in: query
      - schema:
          type: integer
          exclusiveMinimum: 0
        required: false
        name: estimatorId
        in: query
      - schema:
          type: string
          maxLength: 64
        required: false
        name: source
        in: query
      - schema:
          type: string
          maxLength: 32
        required: false
        name: status
        in: query
      - schema:
          type: string
          maxLength: 32
        required: false
        name: projectType
        in: query
      - schema:
          type: boolean
        required: false
        name: includeCompleted
        in: query
      responses:
        '200':
          description: Business review
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    type: object
                    properties:
                      window:
                        type: object
                        properties:
                          from:
                            type: string
                          to:
                            type: string
                          label:
                            type: string
                        required:
                        - from
                        - to
                        - label
                      scorecard:
                        type: array
                        items:
                          type: object
                          properties:
                            key:
                              type: string
                            label:
                              type: string
                            definition:
                              type: string
                            value:
                              type: string
                            kind:
                              type: string
                              enum:
                              - money
                              - count
                              - percent
                              - days
                            detail:
                              type: string
                            linkTo:
                              type: string
                            delta:
                              type: object
                              properties:
                                kind:
                                  type: string
                                  enum:
                                  - percent
                                  - money
                                value:
                                  type: string
                                direction:
                                  type: string
                                  enum:
                                  - up
                                  - down
                                  - flat
                                goodWhen:
                                  type: string
                                  enum:
                                  - up
                                  - down
                              required:
                              - kind
                              - value
                              - direction
                              - goodWhen
                          required:
                          - key
                          - label
                          - definition
                          - value
                          - kind
                      sections:
                        type: object
                        additionalProperties: {}
                    required:
                    - window
                    - scorecard
                    - sections
                  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: getReportsReview
      x-rate-limit-cost: 1
  /reports/{slug}:
    get:
      summary: Run a catalog report
      description: KPIs, series and up to 500 rows for one report. Money values are decimal strings. `groupBy` must be one of the catalog entry's groupBys.
      security:
      - bearerAuth:
        - reports:read
      tags:
      - Reports
      parameters:
      - schema:
          type: string
          enum:
          - ar-aging
          - billed-vs-collected
          - bid-performance
          - pipeline
          - wip
        required: true
        name: slug
        in: path
      - schema:
          type: string
          format: date-time
        required: false
        name: dateFrom
        in: query
      - schema:
          type: string
          format: date-time
        required: false
        name: dateTo
        in: query
      - schema:
          type: string
          pattern: ^\d{4}-\d{2}-\d{2}$
        required: false
        name: date
        in: query
      - schema:
          type: string
          maxLength: 64
        required: false
        name: tz
        in: query
      - schema:
          type: string
          maxLength: 32
        required: false
        name: preset
        in: query
      - schema:
          type: boolean
          default: false
        required: false
        name: compare
        in: query
      - schema:
          type: string
          maxLength: 32
        required: false
        name: groupBy
        in: query
      - schema:
          type: integer
          exclusiveMinimum: 0
        required: false
        name: customerId
        in: query
      - schema:
          type: integer
          exclusiveMinimum: 0
        required: false
        name: projectId
        in: query
      - schema:
          type: integer
          exclusiveMinimum: 0
        required: false
        name: estimatorId
        in: query
      - schema:
          type: string
          maxLength: 64
        required: false
        name: source
        in: query
      - schema:
          type: string
          maxLength: 32
        required: false
        name: status
        in: query
      - schema:
          type: string
          maxLength: 32
        required: false
        name: projectType
        in: query
      - schema:
          type: boolean
        required: false
        name: includeCompleted
        in: query
      - schema:
          type: integer
          minimum: 1
          maximum: 500
          default: 500
        required: false
        name: limit
        in: query
      - schema:
          type: string
          maxLength: 64
        required: false
        name: sort
        in: query
      responses:
        '200':
          description: Report payload
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    type: object
                    properties:
                      slug:
                        type: string
                        enum:
                        - ar-aging
                        - billed-vs-collected
                        - bid-performance
                        - pipeline
                        - wip
                      window:
                        type: object
                        properties:
                          from:
                            type: string
                          to:
                            type: string
                          label:
                            type: string
                        required:
                        - from
                        - to
                        - label
                      compareWindow:
                        type: object
                        properties:
                          from:
                            type: string
                          to:
                            type: string
                          label:
                            type: string
                        required:
                        - from
                        - to
                        - label
                      kpis:
                        type: array
                        items:
                          type: object
                          properties:
                            key:
                              type: string
                            label:
                              type: string
                            definition:
                              type: string
                            value:
                              type: string
                            kind:
                              type: string
                              enum:
                              - money
                              - count
                              - percent
                              - days
                            detail:
                              type: string
                            linkTo:
                              type: string
                            delta:
                              type: object
                              properties:
                                kind:
                                  type: string
                                  enum:
                                  - percent
                                  - money
                                value:
                                  type: string
                                direction:
                                  type: string
                                  enum:
                                  - up
                                  - down
                                  - flat
                                goodWhen:
                                  type: string
                                  enum:
                                  - up
                                  - down
                              required:
                              - kind
                              - value
                              - direction
                              - goodWhen
                          required:
                          - key
                          - label
                          - definition
                          - value
                          - kind
                      series:
                        type: array
                        items:
                          type: object
                          properties:
                            bucket:
                              type: string
                            label:
                              type: string
                            values:
                              type: object
                              additionalProperties:
                                type: string
                            compareValues:
                              type: object
                              additionalProperties:
                                type: string
                          required:
                          - bucket
                          - label
                          - values
                      rows:
                        type: array
                        items:
                          type: object
                          additionalProperties: {}
                      totals:
                        type: object
                        additionalProperties: {}
                      hasMore:
                        type: boolean
                      meta:
                        type: object
                        properties:
                          scope:
                            type: string
                            enum:
                            - tenant
                            - own
                            - assigned
                          definitions:
                            type: object
                            additionalProperties:
                              type: string
                          groupBy:
                            type: string
                        required:
                        - scope
                        - definitions
                        - groupBy
                    required:
                    - slug
                    - window
                    - kpis
                    - rows
                    - hasMore
                    - meta
                  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'
        '422':
          description: Error
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/ProblemDetails'
      operationId: getReportsBySlug
      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
    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: {}