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, tags or, for a cosplay outfit, its character and franchise (e.g. red dress, naruto).

category
enum<string>

One shelf. cosplay is the anime and game characters' outfits (each names its character and franchise), influencers the AI influencers' signature outfits.

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

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

fit
enum<string>

Who the outfits are cut for. women and men also return the unisex ones, so pass the character's gender (gender on GET /v1/characters; female and male work as they are) to get everything that suits them. unisex returns unisex only.

Available options:
women,
men,
unisex
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[]