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.
AuthorizationBearer <token>
Token-based authentication using access tokens.
In: header
Query Parameters
page?Page
Page number.
Default
1per_page?Per Page
Items per page.
Default
20Range
1 <= value <= 100order?Order
Sort order.
Default
"desc"Value in
"asc" | "desc"type?Type
Filter by preset type.
Default
nullsearch?Search
Search term to filter presets by name.
Default
nullsort_by?Sort By
Sort by field.
Default
"created_at"Value in
"name" | "created_at"ownership?Ownership
Filter by ownership: 'mine' for own presets, 'shared' for system + group presets, 'default' for system presets only.
Default
nullcategory_id?Category Id
Filter by category ID.
Default
nullResponse Body
Examples
curl -X GET "https://v2.api.piktid.com/preset?page=1&per_page=20&order=asc&sort_by=name"{
"presets": [
{
"preset_code": "string",
"name": "string",
"description": "string",
"type": "flat_2_model",
"visibility": "shared",
"groups": [
"string"
],
"categories": [
{
"id": "string",
"name": "string",
"description": "string",
"thumbnail_url": "string",
"visibility": "shared",
"created_by": "string",
"created_at": "string"
}
],
"instruction_data": {},
"created_by": "string",
"created_at": "string",
"updated_at": "string"
}
],
"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