Skip to main content
GET
List poses

Authorizations

Authorization
string
header
required

API key as a bearer token: Authorization: Bearer bpx_live_xxx

Query Parameters

q
string

Words that must all appear in the pose's name, handle, description or tags (e.g. knee up).

shelf
enum<string>

One shelf.

Available options:
standing,
sitting,
lying,
kneeling_crouching,
walking_running,
jumping_action,
dance,
sports_fitness,
glamour,
gestures_upper_body
fit
enum<string>

women or men: the poses made for them plus the unisex ones (unisex lists them all). Every pose works for any character: the mannequin follows the character's gender.

Available options:
women,
men,
unisex
limit
integer
default:20
Required range: 1 <= x <= 50
offset
integer
default:0
Required range: x >= 0

Response

The poses that match.

has_more
boolean

More poses match after this page; ask again with a higher offset.

how_to_use
string
poses
object[]
shelves
object[]

Every shelf with its label.

total
integer

How many poses match.