Skip to main content
GET
List and search droplets

Authorizations

Authorization
string
header
required

A company admin credential for your company. Droplet installation tokens are refused.

Query Parameters

q
string

Words describing what the droplet should do. Matches the title, summary, description and categories. With no sort, the response is one page of the best matches, most relevant first, and next_cursor is null: refine q rather than paging. With a sort, every match (up to 10,000) pages in that order.

Maximum string length: 200
page[cursor]
string

Opaque cursor from meta.pagination.next_cursor or prev_cursor. Do not construct or decode it.

page[limit]
integer

Droplets per page. Default 25, maximum 100.

Required range: 1 <= x <= 100
filter[ownership]
enum<string>

all (default): every droplet your company may see, which is published droplets, your own in any status, and internal droplets granted to you. owned: only the droplets your company publishes. installed: only the droplets your company has installed.

Available options:
all,
owned,
installed
filter[category]
string

A droplet category slug.

filter[status]
enum<string>

Only droplets in this status.

Available options:
draft,
internal,
pending,
published,
archived
sort
enum<string>

Sort key; prefix - for descending. Default title, or relevance when q is given.

Available options:
title,
-title,
created_at,
-created_at,
updated_at,
-updated_at

Response

A page of droplets.

A page of droplets.

droplets
object[]
required
status
integer
required
meta
object
required

Response metadata included on every successful response body. request_id and timestamp are always present; list endpoints also add pagination.