---
title: "Get GOAT search facet values"
method: GET
path: "/goat/search/facets"
tags: ["GOAT"]
---

# Get GOAT search facet values

`GET /goat/search/facets`

## Request

- Base URL: `https://api.crawlora.net/api/v1`
- URL: `https://api.crawlora.net/api/v1/goat/search/facets`
- Auth: API key in header `x-api-key`

Returns the accepted values for goat_search's filter parameters: categories, colors, genders, conditions, brands, and years are returned live so a value GOAT adds is discoverable without any client-side change, while product_types and activities are served from a maintained list because GOAT exposes no live facet for them. brands is GOAT's top brands ordered by product count, not the complete brand list -- when brands_truncated is true, brands beyond the ones listed exist and remain valid goat_search values.

## Headers

- `x-api-key` string, required

## Response `200`

OK

- GoatFacetsResponseDoc
  - `code` integer
  - `data` GoatSearchFacetsResponse
    - `activities` string[]
    - `brands` string[]: Brands is ordered by product count descending and is GOAT's top brands, not its whole brand universe -- upstream truncates this bucket (see BrandsTruncated).
    - `brands_truncated` boolean: BrandsTruncated reports that upstream returned its maximum brand bucket size, so brands beyond it exist but are not listed. A brand missing from Brands is still a valid goat_search brands value.
    - `categories` string[]
    - `colors` string[]
    - `conditions` string[]
    - `genders` string[]
    - `product_types` string[]: ProductTypes and Activities are statically maintained, not live -- GOAT never returns them as aggregation buckets.
    - `years` string[]: Years is the vocabulary for goat_search's years parameter, which filters on a product's season year.
  - `msg` string

## Other responses

- `500`: Internal Server Error
- `503`: Service Unavailable

---

[API](https://skmtc.dev/crawlora/apis/crawlora-api.md) · [All operations](https://skmtc.dev/crawlora/apis/crawlora-api/llms.txt) · [OpenAPI document](https://skmtc.dev/crawlora/apis/crawlora-api/revisions/afac9b012a27?raw)