# Govly Developer Documentation

- [Introduction](https://docs.govly.com/getting-started/introduction.md): Govly specializes in ingesting, parsing, and analyzing government contracting data. These docs will help you set up data ingestion pipelines, configure integrations with your existing systems, and implement webhooks for real-time notifications. While our enterprise API is currently only available to…
- [Salesforce Integration](https://docs.govly.com/enterprise/integrations/sfdc.md): Sync Govly opportunities to Salesforce as custom Govly Opportunity objects
- [HubSpot Integration](https://docs.govly.com/enterprise/integrations/hubspot.md): Sync Govly opportunities to HubSpot as deals
- [MCP Overview](https://docs.govly.com/enterprise/integrations/mcp.md): Connect AI assistants to Govly through the Model Context Protocol
- [Connect to Claude](https://docs.govly.com/enterprise/integrations/mcp/claude.md): Install Govly from Claude's connector directory
- [MCP for Developers](https://docs.govly.com/enterprise/integrations/mcp/developers.md): Connect APIs and developer tools to Govly MCP
- [Single Sign-On (SSO)](https://docs.govly.com/enterprise/integrations/sso.md): Govly supports SAML 2.0-based Single Sign-On, allowing your team to authenticate using your organization's identity provider
- [Webhooks Overview](https://docs.govly.com/api-reference/enterprise/webhooks/overview.md): Learn about Govly Enterprise webhooks
- [Webhook Events](https://docs.govly.com/webhooks/events.md): Available webhook events
- [Webhook Security](https://docs.govly.com/webhooks/security.md): Learn how to secure your webhooks
- [Email Integration](https://docs.govly.com/enterprise/email-integration.md): Set up email forwarding for opportunity and award tracking
- [Web Automation](https://docs.govly.com/enterprise/web-automation.md): Managed procurement portal monitoring through Govly Secure Enclave
- [Overview](https://docs.govly.com/enterprise/security.md): An overview of Govly’s approach to safeguarding data and supporting privacy requirements.
- [Opportunity Attachment Handling](https://docs.govly.com/enterprise/security/restricted-opportunity-attachments.md): How Govly handles opportunity attachments with document-control markings
- [Secure Enclave](https://docs.govly.com/enterprise/security/secure-enclave.md): C3PAO-assessed CMMC Level 2 managed ingestion services
- [SOC 2](https://docs.govly.com/enterprise/security/soc2.md): Information about Govly’s SOC 2 program and available documentation
- [Rate Limits](https://docs.govly.com/api-reference/enterprise/rate-limits.md): Understanding API rate limits and usage restrictions
- [Errors](https://docs.govly.com/api-reference/enterprise/errors.md): Understanding Enterprise API error responses
- [List opportunities by ID](https://docs.govly.com/api-reference/enterprise/opportunities/list.md): Retrieve detailed information about specific opportunities by their IDs
- [List Saved Searches](https://docs.govly.com/api-reference/enterprise/opportunities/saved_searches/list.md): Returns a paginated list of saved opportunity searches for your organization
- [Execute a search on a saved search](https://docs.govly.com/api-reference/enterprise/opportunities/saved_searches/search.md): Search opportunities using a saved search query
- [List saved search matches](https://docs.govly.com/api-reference/enterprise/opportunities/saved_search_matches/list.md): Retrieve opportunities that match your saved searches
- [List awards](https://docs.govly.com/api-reference/enterprise/awards/list.md): Retrieve federal contract awards with filtering by date range, unique key, or recipient
- [List Saved Searches](https://docs.govly.com/api-reference/enterprise/awards/saved_searches/list.md): Returns a paginated list of saved award searches for your organization
- [Execute a search on a saved search](https://docs.govly.com/api-reference/enterprise/awards/saved_searches/search.md): Search awards using a saved search query
- [Fetch opportunities by ID](https://docs.govly.com/api-reference/tools-v1/opportunities/fetch-opportunities-by-id.md)
- [Show an opportunity](https://docs.govly.com/api-reference/tools-v1/opportunities/show-an-opportunity.md)
- [Search opportunities](https://docs.govly.com/api-reference/tools-v1/opportunities/search-opportunities.md): Search opportunities with the constrained public parameter set shared by MCP search_opportunities. Defaults to open opportunities and excludes prediction records from search results.
- [Mark an opportunity not interested](https://docs.govly.com/api-reference/tools-v1/opportunities/mark-an-opportunity-not-interested.md): Marks the opportunity not interested / dismissed for the authenticated user. Sets a team-visible disinterested status on the user's workspace follow, unfollows the user, and dismisses the user's matching inbox items.
- [Undo a not-interested mark](https://docs.govly.com/api-reference/tools-v1/opportunities/undo-a-not-interested-mark.md): Removes a previous not-interested mark for the authenticated user and restores matching dismissed inbox items. The user returns to a neutral (not following) state.
- [Show an award](https://docs.govly.com/api-reference/tools-v1/awards/show-an-award.md): Show a single awarded contract with transactions, sub-awards, related opportunities, program links, line items, places, classification codes, and contacts. The path parameter accepts either identifier shape: an all-digit value is treated as the Govly award database id; anything else is treated as th…
- [Search awards](https://docs.govly.com/api-reference/tools-v1/awards/search-awards.md): Search awarded government contracts with the constrained public parameter set shared by MCP search_awards. Searches all time unless dateRange is given. searchType defaults to the authenticated user's market focus (fed or sled); sled and international require the matching organization subscription.
- [Show a contact](https://docs.govly.com/api-reference/tools-v1/contacts/show-a-contact.md): Show a single government point of contact by Govly contact id, with titles and associated buyers, vendors, and contract vehicles. Email and phone are included for paid callers.
- [Search contacts](https://docs.govly.com/api-reference/tools-v1/contacts/search-contacts.md): Search government points of contact with the constrained public parameter set shared by MCP search_contacts. Email and phone are never returned in search results; use show_contact for a single contact. jurisdictionLevel defaults to federal.
- [Resolve place names to canonical Place ids](https://docs.govly.com/api-reference/tools-v1/places/resolve-place-names-to-canonical-place-ids.md): Resolve a place name to canonical Govly Place ids — counties, municipalities, states, ZIP codes, school districts, military installations, and countries. Results are relevance-ranked with records-bearing places first. Paging walks the matches for a query, not a category — use /api/tools/v1/places/li…
- [Enumerate every Place of a category within a jurisdiction](https://docs.govly.com/api-reference/tools-v1/places/enumerate-every-place-of-a-category-within-a-jurisdiction.md): Enumerate every canonical Govly Place of a category within a jurisdiction — every county in California, every school district in Texas. At least one of categories or isoCodes is required. Ordering is stable but arbitrary, not alphabetical — sort client-side when presenting a list. Use /api/tools/v1/…
- [Show a signal cluster](https://docs.govly.com/api-reference/tools-v1/signals/show-a-signal-cluster.md)
- [Search signals](https://docs.govly.com/api-reference/tools-v1/signals/search-signals.md): Search clustered procurement and market signals (news, hearings, laws, events, analysis, policy, regulatory actions, and public meetings) with the constrained public parameter set shared by MCP search_signals. query is a fuzzy, semantic search; contentTypes, categories, and dateRange are exact filte…
- [List accessible product catalogs](https://docs.govly.com/api-reference/tools-v1/product-catalogs/list-accessible-product-catalogs.md): List the government contract price lists (product catalogs) available to the caller — public catalogs plus any owned by the caller's organization. Returns catalog metadata only, no pricing. Not paginated; the catalog set is small. Use the returned ids and groups to filter search_product_catalog.
- [Search product catalog items](https://docs.govly.com/api-reference/tools-v1/product-catalogs/search-product-catalog-items.md): Search line items across government contract price lists for negotiated pricing, part numbers, and availability, with the constrained public parameter set shared by MCP search_product_catalog. query is a fuzzy search over item descriptions, manufacturers, and part numbers; productCatalogIds, group,…
- [List workspaces associated with an entity](https://docs.govly.com/api-reference/tools-v1/workspaces/list-workspaces-associated-with-an-entity.md)
- [Create a workspace](https://docs.govly.com/api-reference/tools-v1/workspaces/create-a-workspace.md)
- [Search active workspaces](https://docs.govly.com/api-reference/tools-v1/workspaces/search-active-workspaces.md): Searches the authenticated organization's Active Work with exact totals and opaque cursor pagination. The default scope is current, open workspaces with an opportunity primary focus or no primary focus. Explicit participants narrow organization participation and never grant access. A user participan…
- [Show a workspace](https://docs.govly.com/api-reference/tools-v1/workspaces/show-a-workspace.md)
- [Update a workspace](https://docs.govly.com/api-reference/tools-v1/workspaces/update-a-workspace.md)
- [Add a user or team member to a workspace](https://docs.govly.com/api-reference/tools-v1/workspace-members/add-a-user-or-team-member-to-a-workspace.md): Adds a member, reactivates a previously removed one, or updates an existing active member's notifications. Provide exactly one of userId or teamId; both are resolved within the calling user's own organization, so a member from another organization returns 404. state accepts only "following" — remove…
- [Remove a user or team member from a workspace](https://docs.govly.com/api-reference/tools-v1/workspace-members/remove-a-user-or-team-member-from-a-workspace.md): Removes a member from the workspace. Idempotent: removing a member who is absent or already removed succeeds with data null and meta.noOp true rather than 404, and never reports whether an id exists. Users may always remove themselves, unless their only membership is through a team. Removing anyone…
- [List workspace attachments](https://docs.govly.com/api-reference/tools-v1/workspace-attachments/list-workspace-attachments.md)
- [Upload workspace attachments](https://docs.govly.com/api-reference/tools-v1/workspace-attachments/upload-workspace-attachments.md)
- [Post a Markdown comment to a workspace](https://docs.govly.com/api-reference/tools-v1/workspace-comments/post-a-markdown-comment-to-a-workspace.md)
- [Follow a Govly entity](https://docs.govly.com/api-reference/tools-v1/follows/follow-a-govly-entity.md): Follow, track, or subscribe to changes for a Govly entity. For opportunities, awards, or contacts, this creates or reuses the entity's default workspace and follows that workspace for the authenticated user.
- [Unfollow a Govly entity](https://docs.govly.com/api-reference/tools-v1/follows/unfollow-a-govly-entity.md): Stops following an opportunity, award, or contact for the authenticated user. Whether anything is cleared is decided entirely by the caller's follow on the entity's default workspace. When that follow is in the following state, it is cleared along with the caller's follows on every other workspace f…
- [Share an opportunity, award, or contact by email](https://docs.govly.com/api-reference/tools-v1/shares/share-an-opportunity-award-or-contact-by-email.md): Send an opportunity, award, or contact to one or more recipients by email. Delivery is queued immediately and is at-least-once, so a transient failure may redeliver to recipients who already received the message.
- [List award saved searches](https://docs.govly.com/api-reference/tools-v1/saved-searches/list-award-saved-searches.md)
- [Create an award saved search](https://docs.govly.com/api-reference/tools-v1/saved-searches/create-an-award-saved-search.md): Saves a set of award search criteria as a replayable search. Award saved searches do not send notifications — run one any time with the results endpoint. The date window is stored as relative day offsets and defaults to the last year. The market the search is created under is stored and bounds every…
- [Show an award saved search](https://docs.govly.com/api-reference/tools-v1/saved-searches/show-an-award-saved-search.md)
- [Update an award saved search](https://docs.govly.com/api-reference/tools-v1/saved-searches/update-an-award-saved-search.md): Merges the supplied criteria into the stored ones. Only supplied keys change; omitted keys are left as they are, and there is no way to remove a stored filter — recreate the saved search to clear one. Award saved searches do not send notifications.
- [Execute an award saved search](https://docs.govly.com/api-reference/tools-v1/saved-searches/execute-an-award-saved-search.md): Runs the saved search live against the award index rather than reading a cached match list, so results reflect the index at call time. The saved search's own relative date window is applied; meta.dateRange reports the absolute window actually searched.
- [List opportunity saved searches](https://docs.govly.com/api-reference/tools-v1/saved-searches/list-opportunity-saved-searches.md): Latest match previews exclude prediction records.
- [Create an opportunity saved search](https://docs.govly.com/api-reference/tools-v1/saved-searches/create-an-opportunity-saved-search.md): Saves a set of opportunity search criteria. Opportunity saved searches percolate, so the stored filters also drive match notifications. The market the search is created under is stored with it and bounds every later match, so set searchType explicitly when scoping to a state or local place. Stored f…
- [Show an opportunity saved search](https://docs.govly.com/api-reference/tools-v1/saved-searches/show-an-opportunity-saved-search.md)
- [Update an opportunity saved search](https://docs.govly.com/api-reference/tools-v1/saved-searches/update-an-opportunity-saved-search.md): Merges the supplied criteria into the stored ones. Only supplied keys change; omitted keys are left as they are, and there is no way to remove a stored filter — recreate the saved search to clear one.
- [List cached opportunity results for a saved search](https://docs.govly.com/api-reference/tools-v1/saved-searches/list-cached-opportunity-results-for-a-saved-search.md): Returns cached saved-search matches, excluding prediction records.
- [Read bounded document content](https://docs.govly.com/api-reference/tools-v1/documents/read-bounded-document-content.md): Reads a bounded portion of an authorized document without creating an analysis or enqueueing extraction work. Start a read with documentType and id. Continue when meta.hasMore is true by sending only meta.nextCursor and, optionally, maxChars. Cursors are opaque, source-bound, and re-authorized on ev…
- [Get a temporary original-file download](https://docs.govly.com/api-reference/tools-v1/documents/get-a-temporary-original-file-download.md): Returns a fresh presigned URL for the authorized original file. The URL expires at data.expiresAt. This operation is separate from document_read so reading representations never downloads the full file implicitly.
- [Check quote submission requirements](https://docs.govly.com/api-reference/tools-v1/quote-submissions/check-quote-submission-requirements.md): Returns destination-specific quote submission requirements and blocking reasons for the authenticated actor and workspace.
- [List quote submissions for a workspace](https://docs.govly.com/api-reference/tools-v1/quote-submissions/list-quote-submissions-for-a-workspace.md)
- [Submit a quote](https://docs.govly.com/api-reference/tools-v1/quote-submissions/submit-a-quote.md): Submit a quote to the destination for an opportunity workspace. Upload each file to the workspace attachments endpoint first, then describe the destination-specific package in files. Call get_quote_submission_requirements for the supported roles, fields, and modes. The response returns a submission…
- [Show quote submission status](https://docs.govly.com/api-reference/tools-v1/quote-submissions/show-quote-submission-status.md): Poll this endpoint after create_quote_submission until meta.terminal is true. Completed submissions include confirmation details when the portal returns them; failed submissions include failureReason when available.
- [List inbox items](https://docs.govly.com/api-reference/tools-v1/inbox/list-inbox-items.md): List the authenticated user's active inbox items (Govly AI matches and saved-search matches), newest first. Continue while meta.nextCursor is non-null. A page may contain fewer than perPage records, or no records, while a continuation cursor is present; do not infer completion from page size.
- [Search inbox items](https://docs.govly.com/api-reference/tools-v1/inbox/search-inbox-items.md): Full-text search and filter the authenticated user's inbox items. Returns matchable-type aggregation counts.
- [Show an inbox item](https://docs.govly.com/api-reference/tools-v1/inbox/show-an-inbox-item.md)
- [Accept an inbox item](https://docs.govly.com/api-reference/tools-v1/inbox/accept-an-inbox-item.md): Follow an underlying opportunity or award and create or reuse its default workspace. For a signal, save the item without creating a workspace or follow when Signal saves are enabled for the organization; otherwise Signal acceptance returns 403. Opportunity and award accepts are final and cannot be r…
- [Dismiss an inbox item](https://docs.govly.com/api-reference/tools-v1/inbox/dismiss-an-inbox-item.md)
- [Decline (reject) an inbox item as a bad fit](https://docs.govly.com/api-reference/tools-v1/inbox/decline-reject-an-inbox-item-as-a-bad-fit.md): Mark the item a bad fit, optionally with a reason that feeds the organization's matching-exclusions memory. Reversible with restore.
- [Restore a dismissed or declined inbox item](https://docs.govly.com/api-reference/tools-v1/inbox/restore-a-dismissed-or-declined-inbox-item.md): Return a dismissed or bad-fit item to the active inbox. Only dismissed or bad-fit items can be restored — an accepted item cannot.
- [Get Opportunity](https://docs.govly.com/api-reference/v3/opportunities/get.md): Retrieve a specific opportunity by ID
- [Filter Opportunities](https://docs.govly.com/api-reference/v3/opportunities/filter.md)
- [Get Workspace](https://docs.govly.com/api-reference/v3/workspaces/get.md): Retrieve a specific opportunity workspace by ID
- [Create Workspace](https://docs.govly.com/api-reference/v3/workspaces/create.md)
- [Update Workspace](https://docs.govly.com/api-reference/v3/workspaces/update.md)
- [List Contract Vehicles](https://docs.govly.com/api-reference/v3/contract-vehicles/list.md)

## OpenAPI Specs

- [tools-v1](/openapi/tools-v1.yaml)