Search Psc Categories

Search_Psc_Categories returns GovTribe Product and Service Code (PSC) category records so downstream workflows can use canonical PSC identifiers.

When To Use

  • Which GovTribe PSC category matches a known PSC code or category phrase?

  • Which canonical PSC identifiers should be passed into psc_category_ids filters in downstream federal tools?

  • Which PSC categories should be included or excluded before running opportunity or award research?

  • How many PSC categories match the current lookup criteria before retrieving rows?

  • Which result-set ID and URL should be reused for saved-search style follow-on workflows?

Required Reading

  1. Search_Query_Guide: Required before setting free-text query strings when search_mode is used.

  2. Search_Mode_Guide: Required before choosing keyword vs semantic retrieval.

Input Contract

  • query: Free-text query string. See Required Reading: Search_Query_Guide.

    • type: string

    • required: no

    • default: n/a

  • page: 1-based page index.

    • type: null|number

    • required: no

    • default: 1

  • per_page: Rows per page.

    • type: null|number

    • required: no

    • default: 10

  • search_mode: Query interpretation mode. See Required Reading: Search_Mode_Guide.

    • type: string

    • required: no

    • default: keyword

    • options: keyword, semantic

  • psc_category_ids: Include or exclude results by PSC categories. Use GovTribe IDs or PSC codes.

    • type: array<string>

    • required: no

    • default: n/a

  • psc_category_ids_operator: Choose whether to include or exclude values for PSC Category IDs (GovTribe or PSC code).

    • type: null|string

    • required: no

    • default: in

    • options: in, not_in

  • fields_to_return: Optional field list for row payloads. If omitted and per_page > 0, rows default to govtribe_id. For per_page: 0 aggregation/meta calls, this field may be omitted. Specify fields_to_return whenever the user asks for fields beyond govtribe_id, and prefer omitting it in pure aggregation workflows.

    • type: array<string>

    • required: no

    • default: n/a

    • options: govtribe_id, govtribe_type, govtribe_url, name, code, updated_at, federal_contract_awards, federal_contract_opportunities

Output Contract

  • Top-level keys:

    • current_page: Current page number when per_page > 0.

    • data: Array of result rows when per_page > 0.

    • from: First row position in the current page.

    • last_page: Last page number for current filters.

    • path: GovTribe search URL for this result set.

    • per_page: Applied page size.

    • to: Last row position in the current page.

    • total: Total matched row count for current query filters.

    • contains: Dataset label for the returned result set.

    • search_results_id_can_generate_saved_search: Saved-search eligibility flag.

    • search_results_id: Server-side search result identifier.

    • view_search_results_url: URL to open this exact result set.

    • per_page: 0 behavior: returns path, total, contains, search_results_id_can_generate_saved_search, search_results_id, and view_search_results_url without row keys.

  • Row keys:

    • govtribe_id

    • govtribe_type

    • govtribe_url

    • name

    • code

    • updated_at

    • federal_contract_awards

    • federal_contract_opportunities

  • Relationship retrieval map:

    • federal_contract_awards

      • resource_type: federal_contract_award

      • tool: Search_Federal_Contract_Awards

      • filter: federal_contract_award_ids

      • nested_keys: govtribe_id, govtribe_type, govtribe_url, name

    • federal_contract_opportunities

      • resource_type: federal_contract_opportunity

      • tool: Search_Federal_Contract_Opportunities

      • filter: federal_contract_opportunity_ids

      • nested_keys: govtribe_id, govtribe_type, govtribe_url, name

Usage Patterns

Pattern A: Resolve one known PSC code to its canonical GovTribe category row. Tool: Search_Psc_Categories

Pattern B: Find PSC categories by category phrase using keyword matching. Tool: Search_Psc_Categories

Pattern C: Exclude known PSC categories while reviewing the remaining category universe. Tool: Search_Psc_Categories

Pattern D: Return metadata only when a workflow needs counts, result IDs, and the results URL. Tool: Search_Psc_Categories

Pattern E: Resolve candidate PSCs for downstream opportunity filtering. Tool: Search_Psc_Categories

Last updated

Was this helpful?