Skip to content
BuildWorkPro Docs

List bid line items

GET
/bids/{id}/line-items
 
curl --request GET \
  --url https://app.buildworkpro.com/api/v1/bids/1/line-items \
  --header 'Authorization: Bearer <token>'

Authorizations

Section titled “ Authorizations ”

Parameters

Section titled “ Parameters ”

Path Parameters

Section titled “ Path Parameters ”
id
required
integer

Responses

Section titled “ Responses ”

200

Section titled “ 200 ”

Line items

Media type application/json
object
data
required
Array<object>
object
id
required
integer
bidId
required
integer
kind
required

Item = priced line; section = header grouping the rows after it; note = customer-visible text.

string
Allowed values: item section note
isOptional
required

An optional (alternate) priced line, quoted outside the bid total.

boolean
markName
required

Human-friendly mark name, e.g. W-01. Null on section and note rows.

string | null
description
required
string | null
quantity
required
string | null
unitPrice
required
string | null
total
required
string | null
order
required

Sort position within the bid. A section covers every following row until the next section.

integer | null
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
Example 
{
  "data": [
    {
      "kind": "item"
    }
  ]
}

404

Section titled “ 404 ”

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"
    }
  ]
}