openapi: 3.2.0
info:
title: Opengov Datasets API
version: '1.0'
description: 'Operations tagged Datasets across 2 of this provider''s published API definitions: opengov-procurement-v1-openapi.yml, opengov-procurement-v2-openapi.yml. Each path carries the servers of the definition it was published in.'
servers:
- url: https://api.procurement.opengov.com
description: Production
tags:
- name: Datasets
description: "**Datasets** are collections of data that can be retrieved using the API.\n\nDatasets can be retrieved by using `GET` requests. The base url for datasets is `https://api.procurement.opengov.com/gateway/datasets/v1/`\n\nNote: All dates and times returned by this API are in the time zone selected by the agency.\n## Datasets Legacy Authentication Methods\nIn addition to the OpenGov standard Authorization header, for historic purposes we support two additional ways for the Datasets APIs.\n### 1. HTTP Basic Auth\n\nUse your OpenGov account email as the username and your API key as the password.\n\n```bash curl -u \"alice@example.com:YOUR_API_KEY\" \\ https://api.procurement.opengov.com/gateway/datasets/v1/solicitations ```\n### 2. X-api-key header\n\nYou may also authenticate using the `x-api-key` request header:\n```bash curl -H \"x-api-key: YOUR_API_KEY\" \\ https://api.procurement.opengov.com/gateway/datasets/v1/solicitations ```\n> **Security note:** Some third-party systems may log or store custom headers in plaintext. \n\nTo obtain an API key, please follow the steps outlined in this guide [OpenGov Procurement API Reference](https://opengov.my.site.com/support/s/article/87a452ae-254c-4b62-8336-d475c2e30723) or contact OpenGov support.\n\nThe API will return a 401 error if the key is invalid.\n"
x-displayName: Datasets
paths:
/gateway/datasets/v1/contracts:
servers:
- url: https://api.procurement.opengov.com
description: Production
get:
tags:
- Datasets
summary: Contracts
operationId: getContractsDataset
security:
- basicAuth: []
- apiKeyAuth: []
- xApiKeyHeaderAuth: []
parameters:
- name: utcTime
description: 'If true, all dates and times will be returned in UTC.
If false or not provided, all dates and times will be returned in the time zone selected by the agency.
'
in: query
required: false
schema:
type: boolean
description: "Generates a csv of contracts data. \n\nExample:\n| Column name | Example value |\n| --- | --- |\n| vendor_name | Acme Corp |\n| vendor_email | contact@acme.nil |\n| vendor_city | New York |\n| vendor_state | NY |\n| vendor_country | USA |\n| vendor_zip_code | 10001 |\n| external_vendor_id | VENDOR-001 |\n| vendor_number | ACME-001 |\n| internal_contract_id | 456 |\n| contract_title | Office Supplies Contract |\n| contract_id | CON-789 |\n| external_reference_id | EXT-CON-001 |\n| requisition_id | REQ-101 |\n| term_type | Continuos |\n| status | Active |\n| start_date | 2024-01-01 |\n| end_date | 2024-12-31 |\n| initial_term_length | 12 |\n| initial_term_unit | Months |\n| has_renewal_option | 1 |\n| renewals | 2 |\n| renewals_remaining | 1 |\n| contract_amount | 10000.00 |\n| amount_spent | 5000.00 |\n| department | Finance |\n| project_contact | John Doe |\n| procurement_contact | Jane Smith |\n| contract_type | General |\n| procurement_classification | Goods |\n| category_codes | 1234 |\n| notes | Notes about the contract |\n| is_active_for_financial_transactions | 1 |\n| is_public | 1 |\n| allows_cooperative | 1 |\n| will_rebid | 0 |\n| is_emergency | 0 |\n| assembled_contract_document_count | 5 |\n| contract_document_count | 10 |\n| created_at | 2024-01-01 09:00:00 |\n| updated_at | 2023-01-25 09:00:00 |\n"
responses:
'200':
description: Successfully retrieved Contracts dataset.
content:
text/csv:
schema:
type: string
format: binary
items:
$ref: '#/components/schemas/Contract'
'401':
description: Unauthorized, invalid or missing API token.
'404':
description: Government not found or resource does not exist.
'500':
description: Internal server error.
/gateway/datasets/v1/contract-documents:
servers:
- url: https://api.procurement.opengov.com
description: Production
get:
tags:
- Datasets
summary: Contract Documents
operationId: getContractDocumentsDataset
security:
- basicAuth: []
- apiKeyAuth: []
- xApiKeyHeaderAuth: []
parameters:
- name: utcTime
description: 'If true, all dates and times will be returned in UTC.
If false or not provided, all dates and times will be returned in the time zone selected by the agency.
'
in: query
required: false
schema:
type: boolean
description: "Generates a csv of contract document projects. \n\n\nExample:\n| Column name | Example value |\n| --- | --- |\n| internal_project_id | 12345 |\n| title | Carroll Bog Boardwalk Construction |\n| project_id | P-2024-001 |\n| template | Standard Construction Template |\n| template_abbreviation | SCT |\n| requisition_id | REQ-45678 |\n| department | Facilities Management |\n| project_contact | John Doe |\n| procurement_contact | Jane Smith |\n| status | Review |\n| status_sort | 2 |\n| workload_points_remaining | 50.5 |\n| created_by | admin_user |\n| created_at | 2024-03-01 22:20:31 |\n| last_updated_at | 2024-03-03 23:29:00 |\n| procurement_classification | Invitation to Bid |\n| category_codes | 05500, 06006, 06516, 06523 |\n| is_emergency | 0 |\n| internal_contract_id | 12345 |\n"
responses:
'200':
description: Successfully retrieved Contract Documents dataset.
content:
text/csv:
schema:
type: string
format: binary
items:
$ref: '#/components/schemas/ContractDocument'
'401':
description: Unauthorized, invalid or missing API token.
'404':
description: Government not found or resource does not exist.
'500':
description: Internal server error.
/gateway/datasets/v1/contracts-with-spend:
servers:
- url: https://api.procurement.opengov.com
description: Production
get:
tags:
- Datasets
summary: Contracts with Spend
operationId: getContractsWithSpendDataset
security:
- basicAuth: []
- apiKeyAuth: []
- xApiKeyHeaderAuth: []
parameters:
- name: utcTime
description: 'If true, all dates and times will be returned in UTC.
If false or not provided, all dates and times will be returned in the time zone selected by the agency.
'
in: query
required: false
schema:
type: boolean
description: "Generates a csv of contracts with spend data. \n\n\nExample:\n| Column name | Example value |\n| --- | --- |\n| vendor_name | Acme Corp |\n| vendor_email | contact@acme.nil |\n| vendor_city | New York |\n| vendor_state | NY |\n| vendor_country | USA |\n| vendor_zip_code | 10001 |\n| external_vendor_id | VENDOR-001 |\n| vendor_number | ACME-001 |\n| internal_contract_id | 456 |\n| contract_title | Office Supplies Contract |\n| contract_id | CON-789 |\n| external_reference_id | EXT-CON-001 |\n| requisition_id | REQ-101 |\n| term_type | Continuos |\n| status | Active |\n| start_date | 2024-01-01 |\n| end_date | 2024-12-31 |\n| initial_term_length | 12 |\n| initial_term_unit | Months |\n| has_renewal_option | 1 |\n| renewals | 2 |\n| renewals_remaining | 1 |\n| contract_amount | 10000.00 |\n| amount_spent | 5000.00 |\n| department | Finance |\n| project_contact | John Doe |\n| procurement_contact | Jane Smith |\n| contract_type | General |\n| procurement_classification | Goods |\n| category_codes | 1234 |\n| notes | Notes about the contract |\n| is_active_for_financial_transactions | 1 |\n| is_public | 1 |\n| allows_cooperative | 1 |\n| will_rebid | 0 |\n| is_emergency | 0 |\n| assembled_contract_document_count | 5 |\n| contract_document_count | 10 |\n| internal_po_id | 12345 |\n| po_issue_date | 2024-01-15 |\n| po_fiscal_year | FY2024 |\n| po_department | Finance |\n| po_created_by | John Doe |\n| po_order_status | Approved |\n| po_order_amount | 5000.75 |\n| po_amount_paid | 3000.50 |\n| po_number | PO-67890 |\n| po_description | Purchase of office furniture |\n| po_comments | Urgent request due to office expansion. |\n| po_created_at | 2024-01-01 09:00:00 |\n| po_updated_at | 2024-01-02 09:00:00 |\n"
responses:
'200':
description: Successfully retrieved Contracts with Spend dataset.
content:
text/csv:
schema:
type: string
format: binary
items:
$ref: '#/components/schemas/ContractWithSpend'
'401':
description: Unauthorized, invalid or missing API token.
'404':
description: Government not found or resource does not exist.
'500':
description: Internal server error.
/gateway/datasets/v1/intakes:
servers:
- url: https://api.procurement.opengov.com
description: Production
get:
tags:
- Datasets
summary: Intakes
operationId: getIntakesDataset
security:
- basicAuth: []
- apiKeyAuth: []
- xApiKeyHeaderAuth: []
parameters:
- name: utcTime
description: 'If true, all dates and times will be returned in UTC.
If false or not provided, all dates and times will be returned in the time zone selected by the agency.
'
in: query
required: false
schema:
type: boolean
description: "Generates a csv of intake projects. \n\nExample:\n| Column name | Example value |\n| --- | --- |\n| internal_project_id | 12345 |\n| title | New Office Building Construction |\n| project_id | FIN-2024-001 |\n| type | Construction |\n| requisition_id | REQ-78910 |\n| department | Public Works |\n| project_contact | John Doe |\n| procurement_contact | Jane Smith |\n| release_project_date | 2024-03-01 00:00:00 |\n| pre_proposal_date | 2024-03-15 10:00:00 |\n| question_submission_deadline | 2024-03-20 00:00:00 |\n| question_response_deadline | 2024-03-25 00:00:00 |\n| proposal_submission_deadline | 2024-04-01 00:00:00 |\n| reverse_auction_start_date | 2024-04-05 14:00:00 |\n| reverse_auction_end_date | 2024-04-05 16:00:00 |\n| contractor_selection_date | 2024-04-10 00:00:00 |\n| status | Draft |\n| workload_points_remaining | 50 |\n| created_by | alice_admin |\n| created_at | 2024-02-15 08:30:00 |\n| last_updated_at | 2024-02-20 12:00:00 |\n| assigned_to | Bob Approver |\n| assigned_at | 2024-02-21 09:00:00 |\n| budget_amount | 500000.00 |\n| budget_account | ACC-123456 |\n| budget_description | Office construction fund |\n| procurement_classification | Construction |\n| category_codes | 05500, 06006, 06516, 06523 |\n| is_emergency | false |\n"
responses:
'200':
description: Successfully retrieved Intakes dataset.
content:
text/csv:
schema:
type: string
format: binary
items:
$ref: '#/components/schemas/Intake'
'401':
description: Unauthorized, invalid or missing API token.
'404':
description: Government not found or resource does not exist.
'500':
description: Internal server error.
/gateway/datasets/v1/solicitations:
servers:
- url: https://api.procurement.opengov.com
description: Production
get:
tags:
- Datasets
summary: Solicitations
operationId: getSolicitationDataset
security:
- basicAuth: []
- apiKeyAuth: []
- xApiKeyHeaderAuth: []
parameters:
- name: utcTime
description: 'If true, all dates and times will be returned in UTC.
If false or not provided, all dates and times will be returned in the time zone selected by the agency.
'
in: query
required: false
schema:
type: boolean
description: "Generates a csv of solicitation projects. \n\nExample:\n| Column name | Example value |\n| --- | --- |\n| internal_project_id | 12345 |\n| title | New Office Building Construction |\n| project_id | RFP-2024-001 |\n| template | Standard RFP Template |\n| template_abbreviation | RFP-T |\n| requisition_id | REQ-78910 |\n| department | Public Works |\n| project_contact | John Doe |\n| procurement_contact | Jane Smith |\n| release_project_date | 2024-03-01 00:00:00 |\n| pre-proposal_meeting | 2024-03-15 10:00:00 |\n| question_submission_deadline | 2024-03-20 00:00:00 |\n| question_response_deadline | 2024-03-25 00:00:00 |\n| proposal_submission_deadline | 2024-04-01 00:00:00 |\n| reverse_auction_starting_date | 2024-04-05 14:00:00 |\n| reverse_auction_ending_date | 2024-04-05 16:00:00 |\n| contractor_selection_date | 2024-04-10 00:00:00 |\n| contract_end_date | 2025-04-01 00:00:00 |\n| status | Open |\n| status_sort | 1 |\n| workload_points_remaining | 50 |\n| created_by | alice_admin |\n| created_at | 2024-02-15 08:30:00 |\n| last_updated_at | 2024-02-20 12:00:00 |\n| budget_amount | 500000.00 |\n| budget_account | ACC-123456 |\n| budget_description | Office construction fund |\n| procurement_classification | Construction |\n| category_codes | 05500, 06006, 06516, 06523 |\n| is_emergency | false |\n| notified | 152 |\n| viewed | 0 |\n| followers | 34 |\n| downloaders | 30 |\n| applicants | 10 |\n| no_bids | 2 |\n| submissions | 8 |\n"
responses:
'200':
description: Successfully retrieved Solicitations dataset.
content:
text/csv:
schema:
type: string
format: binary
items:
$ref: '#/components/schemas/Solicitation'
'401':
description: Unauthorized, invalid or missing API token.
'404':
description: Government not found or resource does not exist.
'500':
description: Internal server error.
/gateway/datasets/v1/vendor-companies:
servers:
- url: https://api.procurement.opengov.com
description: Production
get:
tags:
- Datasets
summary: Vendor Companies
operationId: getVendorCompaniesDataset
security:
- basicAuth: []
- apiKeyAuth: []
- xApiKeyHeaderAuth: []
parameters:
- name: utcTime
description: 'If true, all dates and times will be returned in UTC.
If false or not provided, all dates and times will be returned in the time zone selected by the agency.
'
in: query
required: false
schema:
type: boolean
description: 'Generates a csv of vendor companies.
Example:
| Column name | Example value |
| --- | --- |
| internal_vendor_id | 9876 |
| date_added | 2024-03-01 |
| vendor_name | Acme Supplies, Inc. |
| doing_business_as | Acme |
| uei | UEI-ABC123 |
| duns | 123456789 |
| nigp_categories | 05500, 06006 |
| naics_categories | 541330 |
| unspsc_categories | 80141600 |
| state_of_incorporation | CA |
| business_type | LLC |
| languages | English, Spanish |
| no_dbe | WBE |
| self_reported_certifications | MBE, WBE |
| verified_certifications | WBE |
| primary_address_line_1 | 123 Main St |
| primary_address_line_2 | Suite 200 |
| primary_city | San Francisco |
| primary_state | CA |
| primary_postal_code | 94105 |
| primary_country | US |
| billing_address_line_1 | 456 Market St |
| billing_address_line_2 | Floor 3 |
| billing_city | San Francisco |
| billing_state | CA |
| billing_postal_code | 94105 |
| billing_country | US |
| website | https://acme.nil |
| phone | +1 (415) 555-9876 |
| fax_phone | +1 (415) 555-0000 |
'
responses:
'200':
description: Successfully retrieved Vendor Companies dataset.
content:
text/csv:
schema:
type: string
format: binary
items:
$ref: '#/components/schemas/VendorCompany'
'401':
description: Unauthorized, invalid or missing API token.
'404':
description: Government not found or resource does not exist.
'500':
description: Internal server error.
/gateway/datasets/v1/vendor-subscribers:
servers:
- url: https://api.procurement.opengov.com
description: Production
get:
tags:
- Datasets
summary: Vendor Subscribers
operationId: getVendorSubscribersDataset
security:
- basicAuth: []
- apiKeyAuth: []
- xApiKeyHeaderAuth: []
parameters:
- name: utcTime
description: 'If true, all dates and times will be returned in UTC.
If false or not provided, all dates and times will be returned in the time zone selected by the agency.
'
in: query
required: false
schema:
type: boolean
description: 'Generates a csv of vendor subscribers joined with vendor company profile data.
Example:
| Column name | Example value |
| --- | --- |
| subscriber_id | u_12345 |
| subscriber_name | Alice Johnson |
| subscriber_title | Purchasing Manager |
| subscriber_email | alice@example.nil |
| subscriber_phone | +1 (415) 555-1234 x22 |
| subscriber_status | Active |
| internal_vendor_id | 9876 |
| date_added | 2024-03-01 |
| vendor_name | Acme Supplies, Inc. |
| doing_business_as | Acme |
| uei | UEI-ABC123 |
| duns | 123456789 |
| nigp_categories | 05500, 06006 |
| naics_categories | 541330 |
| unspsc_categories | 80141600 |
| state_of_incorporation | CA |
| business_type | LLC |
| languages | English, Spanish |
| no_dbe | WBE |
| self_reported_certifications | MBE, WBE |
| verified_certifications | WBE |
| primary_address_line_1 | 123 Main St |
| primary_address_line_2 | Suite 200 |
| primary_city | San Francisco |
| primary_state | CA |
| primary_postal_code | 94105 |
| primary_country | US |
| billing_address_line_1 | 456 Market St |
| billing_address_line_2 | Floor 3 |
| billing_city | San Francisco |
| billing_state | CA |
| billing_postal_code | 94105 |
| billing_country | US |
| website | https://acme.nil |
| phone | +1 (415) 555-9876 |
| fax_phone | +1 (415) 555-0000 |
'
responses:
'200':
description: Successfully retrieved Vendor Subscribers dataset.
content:
text/csv:
schema:
type: string
format: binary
items:
$ref: '#/components/schemas/VendorSubscriber'
'401':
description: Unauthorized, invalid or missing API token.
'404':
description: Government not found or resource does not exist.
'500':
description: Internal server error.
/gateway/v2/entities/{entityUuid}/datasets/contracts:
parameters:
- $ref: '#/components/parameters/EntityUuidPathParam'
servers:
- url: https://api.procurement.opengov.com
description: Production
get:
tags:
- Datasets
summary: Contracts
operationId: getContractsDatasetV2
security:
- basicAuth: []
- apiKeyAuth: []
- xApiKeyHeaderAuth: []
parameters:
- name: utcTime
description: 'If true, all dates and times will be returned in UTC.
If false or not provided, all dates and times will be returned in the time zone selected by the agency.
'
in: query
required: false
schema:
type: boolean
description: "Generates a csv of contracts data. \n\nExample:\n| Column name | Example value |\n| --- | --- |\n| vendor_name | Acme Corp |\n| vendor_email | contact@acme.nil |\n| vendor_city | New York |\n| vendor_state | NY |\n| vendor_country | USA |\n| vendor_zip_code | 10001 |\n| external_vendor_id | VENDOR-001 |\n| vendor_number | ACME-001 |\n| internal_contract_id | 456 |\n| contract_title | Office Supplies Contract |\n| contract_id | CON-789 |\n| external_reference_id | EXT-CON-001 |\n| requisition_id | REQ-101 |\n| term_type | Continuos |\n| status | Active |\n| start_date | 2024-01-01 |\n| end_date | 2024-12-31 |\n| initial_term_length | 12 |\n| initial_term_unit | Months |\n| has_renewal_option | 1 |\n| renewals | 2 |\n| renewals_remaining | 1 |\n| contract_amount | 10000.00 |\n| amount_spent | 5000.00 |\n| department | Finance |\n| project_contact | John Doe |\n| procurement_contact | Jane Smith |\n| contract_type | General |\n| procurement_classification | Goods |\n| category_codes | 1234 |\n| notes | Notes about the contract |\n| is_active_for_financial_transactions | 1 |\n| is_public | 1 |\n| allows_cooperative | 1 |\n| will_rebid | 0 |\n| is_emergency | 0 |\n| assembled_contract_document_count | 5 |\n| contract_document_count | 10 |\n| created_at | 2024-01-01 09:00:00 |\n| updated_at | 2023-01-25 09:00:00 |\n"
responses:
'200':
description: Successfully retrieved Contracts dataset.
content:
text/csv:
schema:
type: string
format: binary
items:
$ref: '#/components/schemas/Contract'
'401':
description: Unauthorized, invalid or missing API token.
'403':
$ref: '#/components/responses/MissingProEntitlement'
'404':
description: Government not found or resource does not exist.
'500':
description: Internal server error.
/gateway/v2/entities/{entityUuid}/datasets/contract-documents:
parameters:
- $ref: '#/components/parameters/EntityUuidPathParam'
servers:
- url: https://api.procurement.opengov.com
description: Production
get:
tags:
- Datasets
summary: Contract Documents
operationId: getContractDocumentsDatasetV2
security:
- basicAuth: []
- apiKeyAuth: []
- xApiKeyHeaderAuth: []
parameters:
- name: utcTime
description: 'If true, all dates and times will be returned in UTC.
If false or not provided, all dates and times will be returned in the time zone selected by the agency.
'
in: query
required: false
schema:
type: boolean
description: "Generates a csv of contract document projects. \n\n\nExample:\n| Column name | Example value |\n| --- | --- |\n| internal_project_id | 12345 |\n| title | Carroll Bog Boardwalk Construction |\n| project_id | P-2024-001 |\n| template | Standard Construction Template |\n| template_abbreviation | SCT |\n| requisition_id | REQ-45678 |\n| department | Facilities Management |\n| project_contact | John Doe |\n| procurement_contact | Jane Smith |\n| status | Review |\n| status_sort | 2 |\n| workload_points_remaining | 50.5 |\n| created_by | admin_user |\n| created_at | 2024-03-01 22:20:31 |\n| last_updated_at | 2024-03-03 23:29:00 |\n| procurement_classification | Invitation to Bid |\n| category_codes | 05500, 06006, 06516, 06523 |\n| is_emergency | 0 |\n| internal_contract_id | 12345 |\n"
responses:
'200':
description: Successfully retrieved Contract Documents dataset.
content:
text/csv:
schema:
type: string
format: binary
items:
$ref: '#/components/schemas/ContractDocument'
'401':
description: Unauthorized, invalid or missing API token.
'403':
$ref: '#/components/responses/MissingProEntitlement'
'404':
description: Government not found or resource does not exist.
'500':
description: Internal server error.
/gateway/v2/entities/{entityUuid}/datasets/contracts-with-spend:
parameters:
- $ref: '#/components/parameters/EntityUuidPathParam'
servers:
- url: https://api.procurement.opengov.com
description: Production
get:
tags:
- Datasets
summary: Contracts with Spend
operationId: getContractsWithSpendDatasetV2
security:
- basicAuth: []
- apiKeyAuth: []
- xApiKeyHeaderAuth: []
parameters:
- name: utcTime
description: 'If true, all dates and times will be returned in UTC.
If false or not provided, all dates and times will be returned in the time zone selected by the agency.
'
in: query
required: false
schema:
type: boolean
description: "Generates a csv of contracts with spend data. \n\n\nExample:\n| Column name | Example value |\n| --- | --- |\n| vendor_name | Acme Corp |\n| vendor_email | contact@acme.nil |\n| vendor_city | New York |\n| vendor_state | NY |\n| vendor_country | USA |\n| vendor_zip_code | 10001 |\n| external_vendor_id | VENDOR-001 |\n| vendor_number | ACME-001 |\n| internal_contract_id | 456 |\n| contract_title | Office Supplies Contract |\n| contract_id | CON-789 |\n| external_reference_id | EXT-CON-001 |\n| requisition_id | REQ-101 |\n| term_type | Continuos |\n| status | Active |\n| start_date | 2024-01-01 |\n| end_date | 2024-12-31 |\n| initial_term_length | 12 |\n| initial_term_unit | Months |\n| has_renewal_option | 1 |\n| renewals | 2 |\n| renewals_remaining | 1 |\n| contract_amount | 10000.00 |\n| amount_spent | 5000.00 |\n| department | Finance |\n| project_contact | John Doe |\n| procurement_contact | Jane Smith |\n| contract_type | General |\n| procurement_classification | Goods |\n| category_codes | 1234 |\n| notes | Notes about the contract |\n| is_active_for_financial_transactions | 1 |\n| is_public | 1 |\n| allows_cooperative | 1 |\n| will_rebid | 0 |\n| is_emergency | 0 |\n| assembled_contract_document_count | 5 |\n| contract_document_count | 10 |\n| internal_po_id | 12345 |\n| po_issue_date | 2024-01-15 |\n| po_fiscal_year | FY2024 |\n| po_department | Finance |\n| po_created_by | John Doe |\n| po_order_status | Approved |\n| po_order_amount | 5000.75 |\n| po_amount_paid | 3000.50 |\n| po_number | PO-67890 |\n| po_description | Purchase of office furniture |\n| po_comments | Urgent request due to office expansion. |\n| po_created_at | 2024-01-01 09:00:00 |\n| po_updated_at | 2024-01-02 09:00:00 |\n"
responses:
'200':
description: Successfully retrieved Contracts with Spend dataset.
content:
text/csv:
schema:
type: string
format: binary
items:
$ref: '#/components/schemas/ContractWithSpend'
'401':
description: Unauthorized, invalid or missing API token.
'403':
$ref: '#/components/responses/MissingProEntitlement'
'404':
description: Government not found or resource does not exist.
'500':
description: Internal server error.
/gateway/v2/entities/{entityUuid}/datasets/intakes:
parameters:
- $ref: '#/components/parameters/EntityUuidPathParam'
servers:
- url: https://api.procurement.opengov.com
description: Production
get:
tags:
- Datasets
summary: Intakes
operationId: getIntakesDatasetV2
security:
- basicAuth: []
- apiKeyAuth: []
- xApiKeyHeaderAuth: []
parameters:
- name: utcTime
description: 'If true, all dates and times will be returned in UTC.
If false or not provided, all dates and times will be returned in the time zone selected by the agency.
'
in: query
required: false
schema:
type: boolean
description: "Generates a csv of intake projects. \n\nExample:\n| Column name | Example value |\n| --- | --- |\n| internal_project_id | 12345 |\n| title | New Office Building Construction |\n| project_id | FIN-2024-001 |\n| type | Construction |\n| requisition_id | REQ-78910 |\n| department | Public Works |\n| project_contact | John Doe |\n| procurement_contact | Jane Smith |\n| release_project_date | 2024-03-01 00:00:00 |\n| pre_proposal_date | 2024-03-15 10:00:00 |\n| question_submission_deadline | 2024-03-20 00:00:00 |\n| question_response_deadline | 2024-03-25 00:00:00 |\n| proposal_submission_deadline | 2024-04-01 00:00:00 |\n| reverse_auction_start_date | 2024-04-05 14:00:00 |\n| reverse_auction_end_date | 2024-04-05 16:00:00 |\n| contractor_selection_date | 2024-04-10 00:00:00 |\n| status | Draft |\n| workload_points_remaining | 50 |\n| created_by | alice_admin |\n| created_at | 2024-02-15 08:30:00 |\n| last_updated_at | 2024-02-20 12:00:00 |\n| assigned_to | Bob Approver |\n| assigned_at | 2024-02-21 09:00:00 |\n| budget_amount | 500000.00 |\n| budget_account | ACC-123456 |\n| budget_description | Office construction fund |\n| procurement_classification | Construction |\n| category_codes | 05500, 06006, 06516, 06523 |\n| is_emergency | false |\n"
responses:
'200':
description: Successfully retrieved Intakes dataset.
content:
text/csv:
schema:
type: string
format: binary
items:
$ref: '#/components/schemas/Intake'
'401':
description: Unauthorized, invalid or missing API token.
'403':
$ref: '#/components/responses/MissingProEntitlement'
'404':
description: Government not found or resource does not exist.
'500':
description: Internal server error.
/gateway/v2/entities/{entityUuid}/datasets/solicitations:
parameters:
- $ref: '#/components/parameters/EntityUuidPathParam'
servers:
- url: https://api.procurement.opengov.com
description: Production
get:
tags:
- Datasets
summary: Solicitations
operationId: getSolicitationDatasetV2
security:
- basicAuth: []
- apiKeyAuth: []
- xApiKeyHeaderAuth: []
parameters:
- name: utcTime
description: 'If true, all dates and times will be returned in UTC.
If false or not provided, all dates and times will be returned in the time zone selected by the agency.
'
in: query
required: false
schema:
type: boolean
description: "Generates a csv of solicitation projects. \n\nExample:\n| Column name | Example value |\n| --- | --- |\n| internal_project_id | 12345 |\n| title | New Office Building Construction |\n| project_id | RFP-2024-001 |\n| template | Standard RFP Template |\n| template_abbreviation | RFP-T |\n| requisition_id | REQ-78910 |\n| department | Public Works |\n| project_contact | John Doe |\n| procurement_contact | Jane Smith |\n| release_project_date | 2024-03-01 00:00:00 |\n| pre-proposal_meeting | 2024-03-15 10:00:00 |\n| question_submission_deadline | 2024-03-20 00:00:00 |\n| question_response_deadline | 2024-03-25 00:00:00 |\n| proposal_submission_deadline | 2024-04-01 00:00:00 |\n| reverse_auction_starting_date | 2024-04-05 14:00:00 |\n| reverse_auction_ending_date | 2024-04-05 16:00:00 |\n| contractor_selection_date | 2024-04-10 00:00:00 |\n| contract_end_date | 2025-04-01 00:00:00 |\n| status | Open |\n| status_sort | 1 |\n| workload_points_remaining | 50 |\n| created_by | alice_admin |\n| created_at | 2024-02-15 08:30:00 |\n| last_updated_at | 2024-02-20 12:00:00 |\n| budget_amount | 500000.00 |\n| budget_account | ACC-123456 |\n| budget_description | Office construction fund |\n| procurement_classification | Construction |\n| category_codes | 05500, 06006, 06516, 06523 |\n| is_emergency | false |\n| notified | 152 |\n| viewed | 0 |\n| followers | 34 |\n| downloaders | 30 |\n| applicants | 10 |\n| no_bids | 2 |\n| submissions | 8 |\n"
responses:
# --- truncated at 32 KB (72 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/opengov/refs/heads/main/openapi/opengov-datasets-api-openapi.yml