Projects
List, read and update the projects a builder runs. Projects →
Builder API
The Builder API covers the work a builder does on E1: the projects they run, the packages they break that work into, and the drawings and specifications they issue to the market.
Where the Supplier API answers “what work is out there for me?”, the Builder API answers “what am I putting to market, and what have I issued?”. They are separate surfaces with separate scopes — an integration usually needs one or the other, not both.
Open the live API reference
Base path
Section titled “Base path”https://api.dev.ascension.estimateone.com/api/tender/builder/v1/companies/{companyId}Every endpoint is scoped to a company you are registered against. companyId is
the E1 company account number, the same identifier the Supplier API uses. See
Environments for the host in each environment
and Versioning for what tender means in that path.
The examples throughout these pages refer to that host as $E1_API_BASE,
alongside the E1_* variables from
Make your first call. For this
environment:
export E1_API_BASE="https://api.dev.ascension.estimateone.com"Scopes
Section titled “Scopes”Every request needs the external-api/access scope, a bearer token, and the
x-e1-client-id header. Beyond that, each endpoint requires one capability
scope:
| Scope | Grants |
|---|---|
companies/read | List the companies your application is registered against. |
projects/read | Read projects. |
projects/write | Update project details. |
packages/read | Read the packages on a project. |
packages/write | Create, update and delete packages. |
documents/read | Read project documents and addenda. |
documents/write | Add, replace and remove documents, run upload jobs, and start, rename and cancel addenda. |
trade-disciplines/read | Read the trade discipline list used to classify packages. |
invitations/read | Read the invitations sent for a package and the responses to them. |
invitations/write | Send and manage the invitations for a package. |
quotes/read | Read the quotes received for a package. |
quotes/write | Create and update quotes. |
address-book/read | Read the companies and contacts in your address book. |
address-book/write | Add and update the companies and contacts in your address book. |
Scopes imply the ones they depend on — packages/read also grants
projects/read and trade-disciplines/read, for instance — so you only need to
request the most specific scope for what you do. See
Authorization for how scopes are granted.
Where to next
Section titled “Where to next”Packages
Break a project into packages of work. Packages →
Documents
The drawings and specifications issued on a project. Documents →
Addenda
Group document changes into one issue. Addenda →
Invitations
Who you invited to quote, and how they responded. Invitations →
Quotes
The quotes you received, with their files, notes and revisions. Quotes →
Address book
The companies and contacts you work with. Address book →
Upload jobs
How files get onto a project. Upload jobs →