Supplier API

The Supplier API exposes Speci-finder matched project results for a supplier user.

Open the live API reference

List Speci-finder results

GET /api/supplier/v1/companies/{companyId}/speci-finder/results

Required

Requirement	Value
Scope	`speci-finder/read`
Headers	`Authorization: Bearer <access_token>`, `x-e1-client-id: <client_id>`

Path parameters

Name	Type	Description
`companyId`	string	E1 company identifier for the supplier. Must match a registration on your application.

Query parameters

Both are optional. Selection of “currently open” tenders is scoped server-side; these parameters only control paging.

Name	Type	Description
`cursor`	string	Opaque pagination cursor. Pass the `_metadata.nextCursor` value from a previous response to fetch the following page. Omit on the first request. Treat it as opaque — do not construct or parse it.
`limit`	integer	Page size. Defaults to `25`; must be between `1` and `100`. An out-of-range or non-numeric value returns `400`.

Response (`200 OK`)

Returns one page of matched projects, each with one or more matched tenders, plus a _metadata object describing the page. A project appears once per response; if a single project has matched tenders under different builders, those tenders are grouped under the same project entry.

{
  "data": [
    {
      "projectId": "12345",
      "projectName": "Main Street Development",
      "address": "123 Collins St, Melbourne Victoria 3000 Australia",
      "category": "Commercial",
      "budget": { "low": 1000000, "high": 5000000 },
      "status": "Active",
      "consultants": [
        { "name": "Smith Engineers", "website": "https://smith.example" },
        { "name": "Jones Architects", "website": null }
      ],
      "tenders": [
        {
          "id": "67890",
          "name": "Bulk Earthworks",
          "type": "Tender",
          "builder": { "name": "ABC Constructions", "website": "https://abc.example" },
          "tenderOpenAt": "2026-05-01",
          "quotesDueAt": "2026-05-15",
          "status": "Open",
          "matchedKeywords": ["concrete", "formwork"]
        }
      ],
      "tenderingSubcontractors": [
        { "name": "Apex Concrete", "website": "https://apex.example" },
        { "name": "Pour & Set", "website": null }
      ],
      "url": "https://app.estimateone.com/find-tenders?projectId=12345"
    }
  ],
  "_metadata": {
    "nextCursor": "MjAyNi0wNS0xNXwxMjM0NQ",
    "hasNextPage": true
  }
}

Response field reference

Project

Field	Type	Notes
`projectId`	string	E1 project identifier.
`projectName`	string	Human-readable project name.
`address`	string	Full international postal address (street, suburb, state, postcode, country).
`category`	string	Project category (e.g. `Commercial`, `Residential`).
`budget`	`{ low: number, high: number \| null } \| null`	Banded budget range in dollars. `null` when no budget is set; `high` may be `null` for an open-ended top end.
`status`	`"Active"` \| `"Closed"`	Project-level status. `Closed` indicates the project itself is closed (regardless of any individual tender status).
`consultants`	array of Party	Consultants engaged on the project. Empty for partners without the consultant-details add-on. Excludes unverified entries.
`tenders`	array of Tender	One or more matching tenders. Never empty for a returned project.
`tenderingSubcontractors`	array of Party	Subcontractors who have responded affirmatively to the builder on this project (currently quoting / quoted / quoted outside E1, or signalled interest via watchlist). Subject to the E1 SubbieSupplierConnection unlock model — for projects you haven’t unlocked, this lists only previously-viewed subbies. Deduplicated by company.
`url`	string	Deep link into the E1 web app for this project.

Tender

Field	Type	Notes
`id`	string	E1 tender identifier.
`name`	string	Tender name (typically a trade package, e.g. “Bulk Earthworks”).
`type`	`"Tender"` \| `"Procurement"`	Which product surface the tender belongs to.
`builder`	Party	The lead builder running this tender.
`tenderOpenAt`	ISO 8601 date (`YYYY-MM-DD`) or `null`	When the tender opened.
`quotesDueAt`	ISO 8601 date (`YYYY-MM-DD`) or `null`	When quotes close. `null` if no due date is set.
`status`	`"Open"` \| `"Closed"` \| `"Awarded"`	Tender-level status.
`matchedKeywords`	array of string	The subset of the supplier account’s Speci-finder keywords that matched this tender.

Party

Field	Type	Notes
`name`	string	Display name of the company (preferring the linked E1 account’s name when available).
`website`	string \| `null`	Company website URL, normalised to include an `https://` scheme. `null` when no website is on file.

_metadata

Field	Type	Notes
`nextCursor`	string \| `null`	Pass as the `cursor` query parameter to fetch the next page. `null` when there are no more pages.
`hasNextPage`	boolean	`true` when another page is available. Equivalent to `nextCursor !== null`.

Pagination

Results are paged with an opaque cursor, ordered by each project’s earliest tender quotesDueAt (ascending, undated projects last). To walk every page:

Make the first request with no cursor (optionally set limit).
If _metadata.hasNextPage is true, repeat the request with cursor set to _metadata.nextCursor, keeping the same limit.
Stop when hasNextPage is false (nextCursor is null).

The cursor encodes a position in the ordering, so pages never overlap or skip entries even as limit varies between requests. Treat the cursor as opaque — its contents are not part of the contract. Re-requesting the same cursor/limit within a short window is served from cache, so a paged sweep stays cheap and stable.

Matching semantics

Results only include tenders that are currently open — quotes are not past due and fall within the near-term window. The window is server-side; partners do not control it.
Matching is driven by the supplier account’s Speci-finder keywords (account-wide; resolved via the assigned user on the credential). If the account has no keywords configured, the response will be 200 OK with data: [].
See Data freshness for how quickly new data propagates.

Example request

First page (default limit):

curl -X GET \
  "https://api.estimateone.com/api/supplier/v1/companies/{companyId}/speci-finder/results?limit=25" \
  -H "Authorization: Bearer $TOKEN" \
  -H "x-e1-client-id: $CLIENT_ID"

Next page — pass the previous response’s _metadata.nextCursor:

curl -X GET \
  "https://api.estimateone.com/api/supplier/v1/companies/{companyId}/speci-finder/results?limit=25&cursor=MjAyNi0wNS0xNXwxMjM0NQ" \
  -H "Authorization: Bearer $TOKEN" \
  -H "x-e1-client-id: $CLIENT_ID"

Errors

See Errors for the full catalogue. Common failures for this endpoint:

Status	`code`	Cause
400	`CLIENT_ID_HEADER_MISSING`	`x-e1-client-id` header not sent.
401	`CLIENT_ID_HEADER_MISMATCH`	`x-e1-client-id` header does not match the token.
401	`Unauthorised`	Token invalid, company not registered, permission not published, or scope missing.
5xx	`FETCH_FAILED` / `INTERNAL_SERVER_ERROR`	Something failed downstream. Retry with backoff.

OpenAPI spec

The full OpenAPI 3.1 spec is published at https://api.estimateone.com/swagger/doc. Use it to drive client code generation in the language of your choice. You can also browse it interactively.