Skip to content

Get an RFP

GET
/api/v1/rfps/{id}

Returns the RFP’s metadata, owner, context and item counts. Items are not embedded; list them with GET /api/v1/rfps/{id}/rfp_items.

NameType
id
required
string

The record’s prefixed ID

200

The RFP

Response body
Media typeapplication/json
object
id
string
web_link
string format: uri

The RFP’s page in the web app

title
string
description
string | null
deadline
string | null format: date
state
string
Allowed values: new items_generated processing_items needs_input approved

Processing and review state

framework
string | null
Allowed values: nist-csf-2.0 hecvat-3.06 hecvat-4.1 rh-1.0 cjis-5 cjis-6
portal_url
string | null format: uri
context
string | null

Background about the bid given to the model. Returned by GET /api/v1/rfps/{id} only, not in lists.

created_at
string format: date-time
updated_at
string format: date-time
owner
One of:

The member who owns or answered a record. id is the numeric database ID.

object
id
integer
name
string
email
string format: email
stats

Item counts. Discarded items are excluded.

object
total_items
integer
needs_input_items
integer

Items the AI could not answer confidently

auto_answered_items
integer
approved_items
integer
overall_completion_percentage
integer
<= 100

Approved items as a percentage of total

404

No such record in this account

Response body
Media typeapplication/json
object
error
object
code
string

A stable machine-readable code

message
string
details
Array<string>

Present on validation errors; one entry per failed validation