Presets

List presets

GET
/preset

Lists presets that are either created by the authenticated user, shared with groups the user belongs to, or system presets. Results are paginated.

Authorization

token_auth
headerAuthorizationBearer <token>

Token-based authentication using access tokens.

Query Parameters

page?Page

Page number.

Default1
per_page?Per Page

Items per page.

Range1 <= value <= 100
Default20
order?Order

Sort order.

Default"desc"
Value in"asc""desc"
type?|

Filter by preset type.

Defaultnull
search?|

Search term to filter presets by name, or by the name of a template they belong to.

Defaultnull
sort_by?Sort By

Sort by field.

Default"created_at"
Value in"name""created_at"
ownership?|

Filter by ownership: 'mine' for own presets, 'shared' for group-shared presets, 'default' for system presets only.

Defaultnull
created_by?|

Filter by creator username (exact match). Typically the username of a teammate.

Defaultnull
category_id?|

Filter by category ID.

Defaultnull
group_by?|

When set to 'category', returns presets grouped by category. Pagination applies to categories, not presets.

Defaultnull

Response Body

Successful Response

application/json
  1. response
presets?array<>|

When group_by=category is not used, this field contains the flat list of presets.

Defaultnull
groups?array<>|

When group_by=category is used, this field contains the categorized results. Otherwise, this field is null.

Defaultnull
pagination*

Pagination metadata.

curl -X GET "https://example.com/preset"
{  "presets": null,  "groups": null,  "pagination": {    "page": 0,    "per_page": 0,    "total": 0,    "pages": 0,    "has_next": true,    "has_prev": true  }}