GET /rest/v1.1/projects/{project_id}/bid_packages

Return a list of all Bid Packages for a Project.

Servers

Path parameters

Name Type Required Description
project_id Integer Yes

Unique identifier for the project.

Request headers

Name Type Required Description
Procore-Company-Id Integer Yes

Unique company identifier associated with the Procore User Account.

Query parameters

Name Type Required Description
page Integer No

Page

with_flags[] Array No

Filter bid packages by available features (e.g., flexible_response_types_enabled, bid_form_sections_enabled). For accurate results in the CPBP feature, both flags should be passed, not just one.

filter String No

Filters down list of bid packages for a project.

Possible values:

  • "open"
  • "closed"
  • "hidden"
  • "has_bid_forms"
per_page Integer No

Elements per page

sort String No

Direction (asc/desc) can be controlled by the presence or absence of '-' before the sort parameter. Only applies when view=internal.

Possible values:

  • "submitted_bids_count"
  • "bid_due_date"
  • "title"
  • "status"
  • "bids_will_bid_count"
  • "number"
  • "invited_bids_count"
view String No

When set to all, both open and closed bid packages will be returned. When set to internal, more keys will be made available for each bid package. When set to use_previous_bidders, a key will be made available that will provide information on whether the bid package has bid forms

Possible values:

  • "internal"
  • "use_previous_bid_packages"
  • "use_previous_bidders"
  • "all"

How to start integrating

  1. Add HTTP Task to your workflow definition.
  2. Search for the API you want to integrate with and click on the name.
    • This loads the API reference documentation and prepares the Http request settings.
  3. Click Test request to test run your request to the API and see the API's response.