api:pools

This page has details for how to interact with pool records through the API.

Record field format

Associated attributes

There are no available relations that can be included through the API.

Index

Returns multiple pool records.

Search attributes

Search parameters take the following format (see Help:Common URL parameters for more info):

search[FIELD]=VALUE

The following are the base fields along with their associated type. Check the syntax pages for all of the available variations.

• Number syntax
• id
• created_at
• updated_at
• Text syntax
• name
• description
• Array syntax
• post_ids
• Boolean syntax
• is_deleted
• Chaining syntax
• dtext_links

Special search parameters

The following are additional search fields.

• name_contains - Normalized case-insensitive search with wildcards at the start and end.
• post_tags_match - The pools's post's tags match the given terms. Meta-tags not supported.
• linked_to - Pools that have dtext links to the given wiki page.
• The parameter must use the same format as the wiki title.
• I.e. all lowercase and underscores instead of spaces.
• not_linked_to - Pools that don't have dtext links to the given wiki page.
• Needs the same format as linked_to.
• category
• series - Only series-type pools.
• collection - Only collection-type pools.

Search order

Using the search parameter order with one of the following values changes the order of the results.

• name - Name descending.
• created_at - Created at descending.
• post_count - Post count descending.
• custom - Help:Common URL parameters
• In order to use this order, search[id] must also be set with a list of comma-separated IDs.

Show

Returns a single pool record.

Create

Creates a single pool record.

Create parameters

Pool parameters take the following format (see Help:API Write Requests for more info):

pool[FIELD]=VALUE

• Required:
• name
• category - Can be: series, collection.
• Optional
• description
• post_ids - Uses URL array parameter format.
• Example: pool[post_ids][]=1&pool[post_ids][]=2
• post_ids_string - Space delimited list of post IDs.

Update

Updates a single pool record.

Update parameters

Accepts the same parameters as the Create action. All parameters are optional. Only Builders and above can update a deleted record.

Delete

Deletes a single pool record.

Undelete

Undeletes a single pool record.

Revert

Reverts an a pool record to a prior version.

Revert parameters

• Required:
• version_id - The pool version ID to revert to.

Note: The version ID may be passed along as a URL parameter instead of in the body.

See also

• API:Pool versions
• Help:Common URL Parameters
• Help:API

External links