List filter options

GEThttps://sandbox-api.tryflume.ai/partner/v1/filters

Returns every value each search filter accepts, with a label to show.

Build your filter menus from this call. New values then appear without a release.

curl -X GET "https://sandbox-api.tryflume.ai/partner/v1/filters" \
  -H "X-Flume-Partner-Key: $FLUME_PARTNER_KEY"

import os

import requests

headers = {
    "X-Flume-Partner-Key": os.environ["FLUME_PARTNER_KEY"],
}

response = requests.get(
    "https://sandbox-api.tryflume.ai/partner/v1/filters",
    headers=headers,
    timeout=30,
)
response.raise_for_status()
print(response.json())

const response = await fetch("https://sandbox-api.tryflume.ai/partner/v1/filters", {
  method: "GET",
  headers: {
    "X-Flume-Partner-Key": process.env.FLUME_PARTNER_KEY,
  },
});
if (!response.ok) throw new Error(`${response.status} ${await response.text()}`);
console.log(await response.json());

{
  "tile": {
    "material": [
      {
        "value": "PORCELAIN",
        "label": "Porcelain"
      },
      {
        "value": "CERAMIC",
        "label": "Ceramic"
      }
    ],
    "finish": [
      {
        "value": "MATTE",
        "label": "Matte",
        "also_matches": [
          "NATURAL",
          "HONED",
          "ANTI_SLIP"
        ]
      },
      {
        "value": "GLOSSY_POLISHED",
        "label": "Glossy / Polished",
        "also_matches": [
          "LAPPATO_SEMI_POLISHED"
        ]
      }
    ],
    "application_area": [
      {
        "value": "INTERIOR_DRY_FLOOR",
        "label": "Interior Dry Floor",
        "group": "FLOORS"
      },
      {
        "value": "SHOWER_WALL",
        "label": "Shower Wall",
        "group": "WALLS"
      }
    ]
  },
  "flooring": {
    "wear_layer_mil": [
      {
        "value": 20,
        "label": "20 mil"
      },
      {
        "value": 28,
        "label": "28 mil and up"
      }
    ],
    "installation_method": [
      {
        "value": "CLICK_LOCK",
        "label": "Click Lock"
      }
    ],
    "finish": [
      {
        "value": "MATTE",
        "label": "Matte"
      }
    ],
    "rigid_core": [
      {
        "value": "SPC",
        "label": "SPC"
      }
    ]
  }
}

Request

Headers

Header	Required	Description
`X-Flume-Partner-Key`	Yes	Your partner key. See Authentication and keys.

This call takes no body.

Returns

200 with these fields. Every field is always present. A field with no value is null.

tileobject
Values for a TILE search.
ShowHide the 3 fields of tile
- materialarray of objects
  Values for tile_filters.material.
  ShowHide the 4 fields of material
  - valuestring or integer
    The value to send.
  - labelstring
    The text to show.
  - groupstring or null
    The group an application area belongs to.
  - also_matchesarray of strings or null
    The similar tile finishes this finish also finds.
- finisharray of objects
  Values for tile_filters.finish and tile_filters.finish_exclude.
  ShowHide the 4 fields of finish
  - valuestring or integer
    The value to send.
  - labelstring
    The text to show.
  - groupstring or null
    The group an application area belongs to.
  - also_matchesarray of strings or null
    The similar tile finishes this finish also finds.
- application_areaarray of objects
  Values for tile_filters.application_area.
  ShowHide the 4 fields of application_area
  - valuestring or integer
    The value to send.
  - labelstring
    The text to show.
  - groupstring or null
    The group an application area belongs to.
  - also_matchesarray of strings or null
    The similar tile finishes this finish also finds.
flooringobject
Values for a FLOORING search.
ShowHide the 4 fields of flooring
- wear_layer_milarray of objects
  Values for flooring_filters.wear_layer_mil.
  ShowHide the 4 fields of wear_layer_mil
  - valuestring or integer
    The value to send.
  - labelstring
    The text to show.
  - groupstring or null
    The group an application area belongs to.
  - also_matchesarray of strings or null
    The similar tile finishes this finish also finds.
- installation_methodarray of objects
  Values for flooring_filters.installation_method.
  ShowHide the 4 fields of installation_method
  - valuestring or integer
    The value to send.
  - labelstring
    The text to show.
  - groupstring or null
    The group an application area belongs to.
  - also_matchesarray of strings or null
    The similar tile finishes this finish also finds.
- finisharray of objects
  Values for flooring_filters.finish.
  ShowHide the 4 fields of finish
  - valuestring or integer
    The value to send.
  - labelstring
    The text to show.
  - groupstring or null
    The group an application area belongs to.
  - also_matchesarray of strings or null
    The similar tile finishes this finish also finds.
- rigid_corearray of objects
  Values for flooring_filters.rigid_core.
  ShowHide the 4 fields of rigid_core
  - valuestring or integer
    The value to send.
  - labelstring
    The text to show.
  - groupstring or null
    The group an application area belongs to.
  - also_matchesarray of strings or null
    The similar tile finishes this finish also finds.

Errors

Every error uses one envelope. Branch on error.code.

Status	Code	Meaning
401	`EMBED_TOKEN_INVALID`	You sent an `Authorization` header and no `X-Flume-Partner-Key`. Flume read the call as one from its own iframe.
401	`PARTNER_KEY_INVALID`	The partner key is missing, unknown, revoked, expired, or from the other environment. On live, also a platform Flume has not enabled yet.
401	`USER_TOKEN_INVALID`	The user access token is unknown, revoked, another partner's, or replaced by a later verification. A verification in the iframe replaces it too.
422	`VALIDATION_FAILED`	A field is missing, unknown or has an unusable value. `field` names it as a dotted path. Some refusals carry the detail in `details` and leave `field` empty.
500	`INTERNAL`	Something failed on Flume's side.