Supported operations
| Method | Path | Description |
|---|---|---|
| GET | /api/v1/rfps | List all rfps |
| GET | /api/v1/rfps/:id | Get a rfp by ID |
| POST | /api/v1/rfps | Create a new rfp |
| PATCH | /api/v1/rfps/:id | Update a rfp |
| DELETE | /api/v1/rfps/:id | Delete a rfp |
Example request
Replace YOUR_API_KEY with a private key stored in your environment. Replace path parameters with records from your organization.
curl --request GET "/api/v1/rfps" \
--header "Authorization: Bearer YOUR_API_KEY" \
--header "Accept: application/json"
Field reference
Required means required by the underlying data model, not necessarily caller-supplied. The server derives protected identity and ownership fields; endpoint validation controls which fields are accepted. Sensitive credential fields are omitted here.
| Field | Type | Model requirement | Description |
|---|---|---|---|
id | string | Optional | Unique identifier (auto-generated) |
siteId | uuid | Optional | site Id Related resource: |
title | string | Required | title |
description | string | Optional | description |
category | string | Required | category |
scopeType | enum | Optional | scope Type Values: |
scopeSummary | string | Optional | scope Summary |
requirements | string | Optional | requirements |
issueDate | datetime | Required | issue Date |
responseDeadline | datetime | Required | response Deadline |
budgetTarget | string | Optional | budget Target |
evaluationCriteria | string | Optional | evaluation Criteria |
status | enum | Optional | status Values: |
winningBidId | uuid | Optional | winning Bid Id |
awardedAt | datetime | Optional | awarded At |
generatedDocument | json | Optional | generated Document |
generatedAt | datetime | Optional | generated At |
createdAt | datetime | Optional | Creation timestamp (auto) |
updatedAt | datetime | Optional | Last update timestamp (auto) |