Pools

Search Pools

GET https://e621.net/pools.json

Query Parameters

Name	Type	Description
search[name_matches]	String	The name of the pool.
search[description_matches]	String	The description of the pool.
search[creator_name]	Number	The creator of the pool.
search[creator_id]	String	The ID of the creator of the pool/.
search[is_active]	Boolean	If the pool is "active". (Doesn't really mean much.)
search[category]	String	The category of the pool. One of: series, collection
search[order]	String	The order of the returned results. One of: name, created_at, post_count
search[id]	Number	See Search Parameters: search[id]
limit	Number	See Search Parameters: limit
page	String	See Search Parameters: page

200: OK Success (Results)

[
  {
    "category": "series",
    "created_at": "0000-00-00T00:00:00.000-00:00",
    "creator_id": 0,
    "creator_name": "",
    "description": "",
    "id": 0,
    "is_active": true,
    "name": "",
    "post_count": 0,
    "post_ids": [
      0
    ],
    "updated_at": "0000-00-00T00:00:00.000-00:00"
  }
]

200: OK Success (No Results)

[]

Get Pool

GET https://e621.net/pools/{id}.json

Path Parameters

Name	Type	Description
id*	String	The ID of the pool to get.

200: OK Success

{
  "category": "series",
  "created_at": "0000-00-00T00:00:00.000-00:00",
  "creator_id": 0,
  "creator_name": "",
  "description": "",
  "id": 0,
  "is_active": true,
  "name": "",
  "post_count": 0,
  "post_ids": [
    0
  ],
  "updated_at": "0000-00-00T00:00:00.000-00:00"
}

404: Not Found Not Found

{
  "success": false,
  "reason": "not found"
}

Create Pool

POST https://e621.net/pools.json

Authorization Required

Moderator+ Required If account is less than one week old.

Duplicate post IDs are silently ignored. Post IDs are not validated.

Request Body

Name	Type	Description
pool[name]*	String	The name of the pool. Cannot be only digits. Min: 1 / Max: 250
pool[description]	String	The description of the pool. Max: 10,000
pool[category]	String	The category of the pool. One of: series, collection
pool[is_active]	String	If the pool is active.
pool[post_ids][]	String	An array of post ids to create the pool with. Max: 1000
pool[post_ids_string]	String	A space separated string of post ids to create the pool with. Max: 1000

201: Created Success

{
  "category": "series",
  "created_at": "0000-00-00T00:00:00.000-00:00",
  "creator_id": 0,
  "creator_name": "",
  "description": "",
  "id": 0,
  "is_active": true,
  "name": "",
  "post_count": 0,
  "post_ids": [
    0
  ],
  "updated_at": "0000-00-00T00:00:00.000-00:00"
}

403: Forbidden Access Denied

{
  "success": false,
  "reason": "Access Denied"
}

422: Unprocessable Entity Account Too New

{
  "errors": {
    "creator": [
      "can not yet perform this action. Account is too new."
    ]
  }
}

422: Unprocessable Entity Name Taken

{
  "errors": {
    "name": [
      "has already been taken"
    ]
  }
}

422: Unprocessable Entity Name Too Long

{
  "errors": {
    "name": [
      "is too long (maximum is 250 characters)"
    ]
  }
}

422: Unprocessable Entity Name Only Digits

{
  "errors": {
    "name": [
      "cannot contain only digits"
    ]
  }
}

422: Unprocessable Entity Description Too Long

{
  "errors": {
    "description": [
      "is too long (maximum is 10000 characters)"
    ]
  }
}

422: Unprocessable Entity Invalid Category

{
  "errors": {
    "category": [
      "is not included in the list"
    ]
  }
}

422: Unprocessable Entity Hourly Limit Reached

{
  "errors": {
    "creator": [
      "have reached the hourly limit for this action"
    ]
  }
}

422: Unprocessable Entity Too Many Posts

{
  "errors": {
    "base": [
      "Pools can have up to 1,000 posts each"
    ]
  }
}

500: Internal Server Error Name Missing

{
  "success": false,
  "message": "An unexpected error occurred.",
  "code": "00000000-0000-0000-0000-000000000000"
}

Delete Pool

DELETE https://e621.net/pools/{id}.json

Authorization Required

Janitor+ Required

204: No Content Success

403: Forbidden Access Denied

{
  "success": false,
  "reason": "Access Denied"
}

404: Not Found Not Found

{
  "success": false,
  "reason": "not found"
}

Revert Pool

PUT https://e621.net/pools/{id}/revert.json

Authorization Required

Path Parameters

Name	Type	Description
id*	Number	The ID of the pool to revert.

Query Parameters

Name	Type	Description
version_id*	Number	The ID of the version to revert to.

204: No Content Success

403: Forbidden Access Denied

{
  "success": false,
  "reason": "Access Denied"
}

404: Not Found Not Found

{
  "success": false,
  "reason": "not found"
}