Skip to main content
GET
List outfits you can use

Authorizations

Authorization
string
header
required

API key as a bearer token: Authorization: Bearer bpx_live_xxx

Query Parameters

source
enum<string>
default:all

mine = made by you; saved = kept from the free library or from another member; house = the free library.

Available options:
all,
mine,
saved,
house
q
string

Words that must all appear in the outfit's name, handle, description, colours or tags (e.g. red dress).

category
enum<string>

One shelf.

Available options:
everyday,
work,
formal,
party,
sport,
swim,
outerwear,
sleepwear,
underwear,
costume,
traditional,
seasonal
color
string

A colour the outfit has (e.g. navy).

limit
integer
default:100
Required range: 1 <= x <= 200

Response

The outfits you can use.

categories
string[]
count
integer
how_to_use
string
items
object[]