Skip to content
BuildWorkPro Docs

Bulk-fetch bids by ID

POST
/bids/get-many
 
curl --request POST \
  --url https://app.buildworkpro.com/api/v1/bids/get-many \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{ "ids": [ 1 ] }'

Fetch up to 50 bids by ID in a single round-trip. Returns flat bid rows only (no line items / sublines / distributed costs — call GET /bids/{id} per id for the full tree). IDs that don’t exist are silently omitted; compare meta.requested vs meta.returned to detect missing.

Authorizations

Section titled “ Authorizations ”

Parameters

Section titled “ Parameters ”

Header Parameters

Section titled “ Header Parameters ”
Idempotency-Key
string format: uuid
<= 255 characters

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.

Request Body

Section titled “ Request Body ”
Media type application/json
object
ids
required
Array<integer>
>= 1 items <= 50 items
Example generated 
{
  "ids": [
    1
  ]
}

Responses

Section titled “ Responses ”

200

Section titled “ 200 ”

Bids

Media type application/json
object
data
required
Array<object>
object
id
required
integer
bidNumber
required
string
contactId
required
integer | null
leadId
required
integer | null
projectId
required
integer | null
status
required
string
subtotal
required
string | null
taxAmount
required
string | null
total
required
string | null
discountAmount
string | null
taxRate
required
string | null
discount
required
string | null
discountType
required
string | null
validUntil
required
Any of:
string format: date-time
notes
required
string | null
terms
required
string | null
siteAddress
required
string | null
siteCity
string | null
siteState
string | null
siteZipCode
string | null
sentAt
required
Any of:
string format: date-time
acceptedAt
required
Any of:
string format: date-time
acceptedBy
required
string | null
createdAt
required
Any of:
string format: date-time
updatedAt
required
Any of:
string format: date-time
meta
required
object
request_id

Server-generated request identifier

string
pagination
object
cursor
required

Opaque cursor for the next page; null when no more results

string | null
has_more
required

Whether more pages are available after this one

boolean
count
required

Items in this page

integer
requested
required
integer
returned
required
integer
Example generated 
{
  "data": [
    {
      "id": 1,
      "bidNumber": "example",
      "contactId": 1,
      "leadId": 1,
      "projectId": 1,
      "status": "example",
      "subtotal": "example",
      "taxAmount": "example",
      "total": "example",
      "discountAmount": "example",
      "taxRate": "example",
      "discount": "example",
      "discountType": "example",
      "validUntil": "2026-04-15T12:00:00Z",
      "notes": "example",
      "terms": "example",
      "siteAddress": "example",
      "siteCity": "example",
      "siteState": "example",
      "siteZipCode": "example",
      "sentAt": "2026-04-15T12:00:00Z",
      "acceptedAt": "2026-04-15T12:00:00Z",
      "acceptedBy": "example",
      "createdAt": "2026-04-15T12:00:00Z",
      "updatedAt": "2026-04-15T12:00:00Z"
    }
  ],
  "meta": {
    "request_id": "example",
    "pagination": {
      "cursor": "example",
      "has_more": true,
      "count": 1
    },
    "requested": 1,
    "returned": 1
  }
}

403

Section titled “ 403 ”

Error

Media type application/problem+json
object
type
required

URL identifying the problem type

string format: uri
title
required

Short human-readable summary

string
status
required

HTTP status code

integer
detail

Human-readable explanation

string
request_id

Server-generated request identifier

string
errors

Validation error array (422 only)

Array<object>
object
field
required

Field path that failed validation

string
code
required

Validation error code

string
message
required

Human-readable validation message

string
Example generated 
{
  "type": "https://example.com",
  "title": "example",
  "status": 1,
  "detail": "example",
  "request_id": "example",
  "errors": [
    {
      "field": "example",
      "code": "example",
      "message": "example"
    }
  ]
}

422

Section titled “ 422 ”

Error

Media type application/problem+json
object
type
required

URL identifying the problem type

string format: uri
title
required

Short human-readable summary

string
status
required

HTTP status code

integer
detail

Human-readable explanation

string
request_id

Server-generated request identifier

string
errors

Validation error array (422 only)

Array<object>
object
field
required

Field path that failed validation

string
code
required

Validation error code

string
message
required

Human-readable validation message

string
Example generated 
{
  "type": "https://example.com",
  "title": "example",
  "status": 1,
  "detail": "example",
  "request_id": "example",
  "errors": [
    {
      "field": "example",
      "code": "example",
      "message": "example"
    }
  ]
}