Sign in
pools

Search pools

Changed on

Returns a paginated list of pools matching the given search criteria.

get/pools.json

Request

  • Base URL: https://e621.net
  • URL: https://e621.net/pools.json
  • Auth: one of:
    • none
    • HTTP basic
    • API key in query parameter login and API key in query parameter api_key

Query parameters

pageinteger

The page number for pagination

limitinteger

The number of pools to retrieve per page

search[name_matches]string

Filter by pool name (wildcards supported)

search[description_matches]string

Filter by description text

search[creator_id]integer

Filter by creator user ID

search[creator_name]string

Filter by creator username

search[category]'series' | 'collection'

The pool category

Filter by pool category

search[is_active]string

Filter by active status

search[order]'name' | 'updated_at' | 'post_count' | 'created_at'

Sort order

Response

A list of pools

idinteger required

The unique ID of the pool

namestring required

The name of the pool

creator_idinteger required

The ID of the pool creator

creator_namestring

The username of the pool creator

descriptionstring

The pool description

is_activeboolean required

Whether the pool is active

post_idsinteger[] required

Ordered array of post IDs in the pool

post_countinteger

The number of posts in the pool

category'series' | 'collection' required

The pool category

created_atstring date-time required

When the pool was created

updated_atstring date-time required

When the pool was last updated

Changes