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-documents-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 Documents 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: Documents
  description: File attachments on any entity, with versioning and signed upload/download URLs.
paths:
  /documents/count:
    get:
      summary: Count documents
      description: Returns the total number of documents in the tenant matching the optional `search`, `entityType`, `entityId`, `category`, `dateFrom`/`dateTo` filters. Mirrors GET /documents minus pagination.
      security:
      - bearerAuth:
        - documents:read
      tags:
      - Documents
      parameters:
      - schema:
          type: string
        required: false
        name: entityType
        in: query
      - schema:
          type:
          - integer
          - 'null'
        required: false
        name: entityId
        in: query
      - schema:
          type: string
        required: false
        name: category
        in: query
      - schema:
          type: string
        required: false
        name: search
        in: query
      - schema:
          type: string
          format: date-time
        required: false
        name: dateFrom
        in: query
      - schema:
          type: string
          format: date-time
        required: false
        name: dateTo
        in: query
      responses:
        '200':
          description: Count
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    type: object
                    properties:
                      total:
                        type: integer
                    required:
                    - total
                  meta:
                    $ref: '#/components/schemas/ResponseMeta'
                required:
                - data
                - meta
        '403':
          description: Error
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/ProblemDetails'
      operationId: getDocumentsCount
      x-rate-limit-cost: 1
  /documents:
    get:
      summary: List documents
      description: Returns a cursor-paginated list of document metadata (not the file bytes).
      security:
      - bearerAuth:
        - documents:read
      tags:
      - Documents
      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: string
        required: false
        name: entityType
        in: query
      - schema:
          type:
          - integer
          - 'null'
        required: false
        name: entityId
        in: query
      - schema:
          type: string
        required: false
        name: category
        in: query
      - schema:
          type: string
        required: false
        name: search
        in: query
      - 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: 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: Documents page
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    type: array
                    items:
                      $ref: '#/components/schemas/Document'
                  meta:
                    $ref: '#/components/schemas/ResponseMeta'
                required:
                - data
                - meta
        '403':
          description: Error
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/ProblemDetails'
      operationId: getDocuments
      x-rate-limit-cost: 1
  /documents/{id}:
    get:
      summary: Get document metadata
      security:
      - bearerAuth:
        - documents:read
      tags:
      - Documents
      parameters:
      - schema:
          type: integer
        required: true
        name: id
        in: path
      responses:
        '200':
          description: Document
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    $ref: '#/components/schemas/Document'
                  meta:
                    $ref: '#/components/schemas/ResponseMeta'
                required:
                - data
                - meta
        '404':
          description: Error
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/ProblemDetails'
      operationId: getDocumentsById
      x-rate-limit-cost: 1
    patch:
      summary: Update document metadata
      security:
      - bearerAuth:
        - documents:write
      tags:
      - Documents
      parameters:
      - $ref: '#/components/parameters/IdempotencyKey'
      - schema:
          type: integer
        required: true
        name: id
        in: path
      requestBody:
        content:
          application/json:
            schema:
              type: object
              properties:
                category:
                  type:
                  - string
                  - 'null'
                  maxLength: 64
                description:
                  type:
                  - string
                  - 'null'
                  maxLength: 2000
      responses:
        '200':
          description: Updated
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    $ref: '#/components/schemas/Document'
                  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: patchDocumentsById
      x-rate-limit-cost: 5
    delete:
      summary: Delete document (soft)
      security:
      - bearerAuth:
        - documents:delete
      tags:
      - Documents
      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: deleteDocumentsById
      x-rate-limit-cost: 5
  /documents/{id}/download:
    get:
      summary: Download document file
      description: Streams the file bytes with appropriate Content-Type / Content-Disposition. Refuses a file that is still being scanned or whose scan failed (409) and a file the malware scan flagged (403).
      security:
      - bearerAuth:
        - documents:read
      tags:
      - Documents
      parameters:
      - schema:
          type: integer
        required: true
        name: id
        in: path
      responses:
        '200':
          description: File bytes
        '403':
          description: Error
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/ProblemDetails'
        '404':
          description: Error
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/ProblemDetails'
        '409':
          description: Error
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/ProblemDetails'
      operationId: getDocumentsByIdDownload
      x-rate-limit-cost: 1
  /documents/exports:
    post:
      summary: Start CSV export of documents
      description: Enqueues a CSV export job for documents. Poll /api/v1/jobs/{id} for status; GET /api/v1/jobs/{id}/download for the signed URL.
      security:
      - bearerAuth:
        - documents:read
        - jobs:write
      tags:
      - Documents
      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: postDocumentsExports
      x-rate-limit-cost: 20
  /documents/bulk:
    post:
      summary: Start bulk operation on documents
      description: Enqueues a bulk delete/restore job for up to 500 document ids.
      security:
      - bearerAuth:
        - documents:delete
        - jobs:write
      tags:
      - Documents
      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: postDocumentsBulk
      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
    Document:
      type: object
      properties:
        id:
          type: integer
        entityType:
          type: string
        entityId:
          type: integer
        originalFilename:
          type: string
        storagePath:
          type: string
        mimeType:
          type: string
        fileSize:
          type: integer
        category:
          type:
          - string
          - 'null'
        description:
          type:
          - string
          - 'null'
        createdAt:
          anyOf:
          - type: string
            format: date-time
          - type: string
        updatedAt:
          anyOf:
          - type: string
            format: date-time
          - type: string
      required:
      - id
      - entityType
      - entityId
      - originalFilename
      - storagePath
      - mimeType
      - fileSize
      - category
      - description
      - 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'
  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: {}