list_filters: List filters accepted by a resource

View source: R/metadata.R

list_filtersR Documentation

List filters accepted by a resource

Description

Lists the filters published in the OpenAPI contract supported by this package. Unknown filters are rejected before a request is sent to prevent silently incorrect queries. Filter names and categorical values remain in Portuguese because they are part of the upstream API contract.

Usage

list_filters(resource)

obrasgov_filtros(recurso)

Arguments

resource

A resource name returned by list_resources(). Portuguese resource names used by earlier package versions are also accepted.

recurso

Portuguese alias for resource, available only in obrasgov_filtros().

Value

A tibble containing filter names, expected types, and allowed values when applicable.

Examples

list_filters("projects")

obrasgovr documentation built on July 24, 2026, 5:07 p.m.