BuildWorkPro

BuildWorkPro Contacts API

Customers, vendors and subcontractors, with their addresses, notes and tags.

GitHub OpenAPI

Operations 11

GET /contacts List contacts #
POST /contacts Create contact #
POST /contacts/get-many Bulk-fetch contacts by ID #
GET /contacts/count Count contacts #
GET /contacts/summary Aggregate contact totals and breakdown by type #
GET /contacts/{id} Get contact by id #
PATCH /contacts/{id} Update contact #
DELETE /contacts/{id} Delete contact #
POST /contacts/exports Start CSV export of contacts #
POST /contacts/imports Start CSV import of contacts #
POST /contacts/bulk Start bulk operation on contacts #

Specifications

⚙
OpenAPI
https://artifacts.apis.io/buildworkpro-com/openapi/buildworkpro-com-contacts-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-contacts-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-contacts-api-openapi.yml Raw ↑ 
openapi: 3.2.0
info:
  title: BuildWorkPro Contacts 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: Contacts
  description: Customers, vendors and subcontractors, with their addresses, notes and tags.
paths:
  /contacts:
    get:
      summary: List contacts
      description: Returns a cursor-paginated list of contacts for the authenticated tenant.
      security:
      - bearerAuth:
        - contacts:read
      tags:
      - Contacts
      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: type
        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: Contacts page
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    type: array
                    items:
                      $ref: '#/components/schemas/Contact'
                  meta:
                    $ref: '#/components/schemas/ResponseMeta'
                required:
                - data
                - meta
        '403':
          description: Scope insufficient
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/ProblemDetails'
      operationId: getContacts
      x-rate-limit-cost: 1
    post:
      summary: Create contact
      description: Creates a new contact.
      security:
      - bearerAuth:
        - contacts:write
      tags:
      - Contacts
      parameters:
      - $ref: '#/components/parameters/IdempotencyKey'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CreateContact'
      responses:
        '201':
          description: Created
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    $ref: '#/components/schemas/Contact'
                  meta:
                    $ref: '#/components/schemas/ResponseMeta'
                required:
                - data
                - meta
        '422':
          description: Validation failed
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/ProblemDetails'
      operationId: postContacts
      x-rate-limit-cost: 5
  /contacts/get-many:
    post:
      summary: Bulk-fetch contacts by ID
      description: Fetch up to 50 contacts by ID in a single round-trip. Returns rows for IDs that exist in the tenant — IDs that don't exist (or belong to another tenant) are silently omitted. Compare `meta.requested` to `meta.returned` to detect missing.
      security:
      - bearerAuth:
        - contacts:read
      tags:
      - Contacts
      requestBody:
        content:
          application/json:
            schema:
              type: object
              properties:
                ids:
                  type: array
                  items:
                    type: integer
                    exclusiveMinimum: 0
                  minItems: 1
                  maxItems: 50
              required:
              - ids
      responses:
        '200':
          description: Contacts
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    type: array
                    items:
                      $ref: '#/components/schemas/Contact'
                  meta:
                    allOf:
                    - $ref: '#/components/schemas/ResponseMeta'
                    - type: object
                      properties:
                        requested:
                          type: integer
                        returned:
                          type: integer
                      required:
                      - requested
                      - returned
                required:
                - data
                - meta
        '403':
          description: Scope insufficient
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/ProblemDetails'
        '422':
          description: Validation failed
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/ProblemDetails'
      operationId: postContactsGetMany
      x-rate-limit-cost: 5
      parameters:
      - $ref: '#/components/parameters/IdempotencyKey'
  /contacts/count:
    get:
      summary: Count contacts
      description: Returns the total number of contacts in the tenant matching the optional `search`, `type`, `dateFrom`/`dateTo` filters. Mirrors the same filters as `GET /contacts` minus pagination — use this when you only need cardinality and don't want to walk every page.
      security:
      - bearerAuth:
        - contacts:read
      tags:
      - Contacts
      parameters:
      - schema:
          type: string
        required: false
        name: type
        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: Scope insufficient
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/ProblemDetails'
      operationId: getContactsCount
      x-rate-limit-cost: 1
  /contacts/summary:
    get:
      summary: Aggregate contact totals and breakdown by type
      description: Returns the total contact count plus a breakdown by type (customer / vendor / subcontractor / ...). Date filter applies to createdAt and is inclusive on both bounds. Use this instead of contacts list + walk-and-count when you only need roll-ups.
      security:
      - bearerAuth:
        - contacts:read
      tags:
      - Contacts
      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
      responses:
        '200':
          description: Contact summary
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    type: object
                    properties:
                      totals:
                        type: object
                        properties:
                          count:
                            type: integer
                        required:
                        - count
                      by_type:
                        type: array
                        items:
                          type: object
                          properties:
                            type:
                              type: string
                            count:
                              type: integer
                          required:
                          - type
                          - count
                    required:
                    - totals
                    - by_type
                  meta:
                    $ref: '#/components/schemas/ResponseMeta'
                required:
                - data
                - meta
        '403':
          description: Scope insufficient
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/ProblemDetails'
        '422':
          description: Validation failed
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/ProblemDetails'
      operationId: getContactsSummary
      x-rate-limit-cost: 1
  /contacts/{id}:
    get:
      summary: Get contact by id
      description: Returns a single contact.
      security:
      - bearerAuth:
        - contacts:read
      tags:
      - Contacts
      parameters:
      - schema:
          type: integer
        required: true
        name: id
        in: path
      responses:
        '200':
          description: Contact
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    $ref: '#/components/schemas/Contact'
                  meta:
                    $ref: '#/components/schemas/ResponseMeta'
                required:
                - data
                - meta
        '404':
          description: Not found
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/ProblemDetails'
      operationId: getContactsById
      x-rate-limit-cost: 1
    patch:
      summary: Update contact
      description: Partially updates a contact.
      security:
      - bearerAuth:
        - contacts:write
      tags:
      - Contacts
      parameters:
      - $ref: '#/components/parameters/IdempotencyKey'
      - schema:
          type: integer
        required: true
        name: id
        in: path
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/UpdateContact'
      responses:
        '200':
          description: Updated
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    $ref: '#/components/schemas/Contact'
                  meta:
                    $ref: '#/components/schemas/ResponseMeta'
                required:
                - data
                - meta
        '404':
          description: Not found
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/ProblemDetails'
        '422':
          description: Validation failed
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/ProblemDetails'
      operationId: patchContactsById
      x-rate-limit-cost: 5
    delete:
      summary: Delete contact
      description: Soft-deletes a contact.
      security:
      - bearerAuth:
        - contacts:delete
      tags:
      - Contacts
      parameters:
      - $ref: '#/components/parameters/IdempotencyKey'
      - schema:
          type: integer
        required: true
        name: id
        in: path
      responses:
        '204':
          description: Deleted
        '404':
          description: Not found
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/ProblemDetails'
      operationId: deleteContactsById
      x-rate-limit-cost: 5
  /contacts/exports:
    post:
      summary: Start CSV export of contacts
      description: Enqueues a CSV export job for contacts. Poll /api/v1/jobs/{id} for status; GET /api/v1/jobs/{id}/download for the signed URL.
      security:
      - bearerAuth:
        - contacts:read
        - jobs:write
      tags:
      - Contacts
      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: postContactsExports
      x-rate-limit-cost: 20
  /contacts/imports:
    post:
      summary: Start CSV import of contacts
      description: Enqueues a CSV import job. sourcePath must be an opaque upload path returned by POST /jobs/uploads.
      security:
      - bearerAuth:
        - contacts:write
        - jobs:write
      tags:
      - Contacts
      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: postContactsImports
      x-rate-limit-cost: 200
  /contacts/bulk:
    post:
      summary: Start bulk operation on contacts
      description: Enqueues a bulk delete/restore job for up to 500 contact ids.
      security:
      - bearerAuth:
        - contacts:delete
        - jobs:write
      tags:
      - Contacts
      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: postContactsBulk
      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
    CreateContact:
      type: object
      properties:
        firstName:
          type: string
          minLength: 1
        lastName:
          type: string
          minLength: 1
        companyName:
          type: string
          minLength: 1
        position:
          type:
          - string
          - 'null'
        parentContactId:
          type:
          - integer
          - 'null'
          exclusiveMinimum: 0
        email:
          type:
          - string
          - 'null'
          format: email
        phone:
          type:
          - string
          - 'null'
        mobile:
          type:
          - string
          - 'null'
        website:
          type:
          - string
          - 'null'
        notes:
          type:
          - string
          - 'null'
        type:
          type: string
          enum:
          - customer
          - general_contractor
          - architect
          - city
          - hoa
          - vendor
          - subcontractor
          - supplier
          - employee
          - partner
          - other
      required:
      - type
    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'
    Contact:
      type: object
      properties:
        id:
          type: integer
        firstName:
          type:
          - string
          - 'null'
        lastName:
          type:
          - string
          - 'null'
        companyName:
          type:
          - string
          - 'null'
        email:
          type:
          - string
          - 'null'
          format: email
        phone:
          type:
          - string
          - 'null'
        type:
          type: string
        createdAt:
          anyOf:
          - type: string
            format: date-time
          - type: string
        updatedAt:
          anyOf:
          - type: string
            format: date-time
          - type: string
      required:
      - id
      - firstName
      - lastName
      - companyName
      - email
      - phone
      - type
      - createdAt
      - updatedAt
    UpdateContact:
      type: object
      properties:
        firstName:
          type: string
          minLength: 1
        lastName:
          type: string
          minLength: 1
        companyName:
          type: string
          minLength: 1
        position:
          type:
          - string
          - 'null'
        parentContactId:
          type:
          - integer
          - 'null'
          exclusiveMinimum: 0
        email:
          type:
          - string
          - 'null'
          format: email
        phone:
          type:
          - string
          - 'null'
        mobile:
          type:
          - string
          - 'null'
        website:
          type:
          - string
          - 'null'
        notes:
          type:
          - string
          - 'null'
        type:
          type: string
          enum:
          - customer
          - general_contractor
          - architect
          - city
          - hoa
          - vendor
          - subcontractor
          - supplier
          - employee
          - partner
          - other
  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: {}