GET /api/v4/presets
List of preset. Last update: 27/02/24

Request headers ↑

Only registered user can perform this action
  Authentication - string - required
    Example of Authentication header : "Bearer TOKEN_FETCHED_FROM_SERVER_DURING_REGISTRATION"

Success response body ↑

{
  "presets": [
    {
      "id": 3731,
      "name": "preset",
      "s3_key": "s3_key",
      "preview_image_url": "https://gipper-college-logos-development.s3.amazonaws.com/preview_s3_key.jpeg",
      "favorites_count": 0,
      "preset_type": "graphic" (NOTE: updated 11/10/23),
      "published": false,
      "additional_media": false,
      "template": {
        "id": 2778,
        "name": "MatchDay",
        "class_name": "template_two_thousand_five_hundred_two",
        "preview_image_url": "https://gipper-static-assets.s3.amazonaws.com/preview_for_templates/template_2502_preview.jpg",
        "social_media": "portrait",
        "has_video": true,
        "has_motion": false,
        "active_for": "all_platforms",
        "parent_template": "template_two_thousand_four_hundred_ninety_nine",
        "preview_aspect_ratio": "4:5",
        "favorites_count": null,
        "canvas_to_backend": false (NOTE: add 24/08/23),
        "plans": [
          "Free",
          "Basic",
          ...
        ],
        "relative_templates": {
          "instagram": 2775,
          ...
        },
        is_blocked: false (NOTE: add 18/03/24)
      }
    },
    ...
  ],
  "meta": {
    "total_count": 1,
    graphics_total_count: 1,
    newsletter_total_count: 0
  }
}

Params

Param name Description
saved
required

saved or shared

Validations:

  • Must be one of: true, false.
folder_id
optional

ID of folder

Validations:

  • Must be a Integer
q
optional

Search by name

Validations:

  • Must be a String
search_in_folders
optional , nil allowed

Send true if need to search in folders

Validations:

  • Must be one of: true, false.
preset_type
optional

filtering by preset type. Last update: 11/10/23

Validations:

  • Must be one of: graphic, newsletter.
sort_by
optional

Sort by created_at

Validations:

  • Must be one of: created_at, name.
sort_to
optional

Validations:

  • Must be one of: asc, desc.
page
optional

Validations:

  • Must be a String