Preset categories

Get a preset category with its presets

Only accessible if the user created the category, reaches it through a preset shared with one of their groups, or if it is a system category.

GET
/preset/categories/{category_id}

Authorization

token_auth
AuthorizationBearer <token>

Token-based authentication using access tokens.

In: header

Path Parameters

category_id*string

Query Parameters

include_presets?Include Presets

Set false to fetch only the category metadata (e.g. resolving an id to a name) without shipping every preset's instruction_data.

Defaulttrue

Response Body

application/json

application/json

curl -X GET "https://v2.api.piktid.com/preset/categories/string"
{
  "id": "string",
  "name": "string",
  "description": "string",
  "thumbnail_url": "string",
  "visibility": "shared",
  "created_by": "string",
  "created_at": "string",
  "preset_count": 0,
  "preset_types": [
    "flat_2_model"
  ],
  "groups": [
    "string"
  ],
  "preset_previews": [
    {
      "preset_code": "string",
      "name": "string",
      "preview_url": null
    }
  ],
  "viewer_role": "owner",
  "can_edit": true,
  "can_manage_presets": true,
  "owner_user_id": null,
  "presets": null
}
{
  "error": "Invalid request",
  "detail": [
    {
      "field": null,
      "message": "string",
      "position": "query"
    }
  ]
}
Empty
Empty