Concepts

Metadata Filtering

Several API endpoints support filtering by metadata using query parameters with bracket notation.

Query Format

Filter resources by metadata using bracket notation in query parameters:

  • metadata[key]=value - equality match (implicit eq operator)
  • metadata[key][operator]=value - explicit operator

Operators

OperatorDescriptionExample
eqExact match (default when no operator specified)metadata[location][eq]=NYC
not_eqNot equal (excludes matching resources)metadata[status][not_eq]=inactive
inValue is one of comma-delimited valuesmetadata[department][in]=sales,marketing
containsArray metadata value contains the given valuemetadata[tags][contains]=priority
gteGreater than or equal (numeric comparison)metadata[age][gte]=30
lteLess than or equal (numeric comparison)metadata[score][lte]=100

Examples

Filter by exact match:

GET /v1/providers?metadata[location]=NYC

Filter by numeric range:

GET /v1/providers?metadata[age][gte]=30&metadata[age][lte]=50

Filter by multiple values:

GET /v1/providers?metadata[department][in]=sales,marketing,support

Exclude specific values:

GET /v1/providers?metadata[status][not_eq]=inactive

Filter array metadata:

GET /v1/providers?metadata[skills][contains]=javascript

On this page