Presets

List presets

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

GET
/preset

Authorization

token_auth
AuthorizationBearer <token>

Token-based authentication using access tokens.

In: header

Query Parameters

page?Page

Page number.

Default1
per_page?Per Page

Items per page.

Default20
Range1 <= value <= 100
order?Order

Sort order.

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

Filter by preset type.

Defaultnull
search?|

Search term to filter presets by name.

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

application/json

application/json

curl -X GET "https://v2.api.piktid.com/preset"
{
  "presets": null,
  "groups": null,
  "pagination": {
    "page": 0,
    "per_page": 0,
    "total": 0,
    "pages": 0,
    "has_next": true,
    "has_prev": true
  }
}
{
  "error": "Invalid request",
  "detail": [
    {
      "field": null,
      "message": "string",
      "position": "query"
    }
  ]
}
Empty