IMimprovado
Automated Recipes

List recipe templates

Lists the recipe templates your agency can deploy through the API, in catalogue order. A template belongs to the agency, not to a workspace, so the same id can be deployed in every workspace of the agency.

Only templates that can be deployed through the API are returned, so this list can be shorter than the catalogue the interface shows. Templates are created and edited in the interface only; this API reads them.

Pick a template here, then create a recipe from its id. The page holds 20 templates by default and 100 at most; next and previous are full v3.1 URLs.

get/api/v3.1/automated-recipe-templates/

Request

Query parameters

searchstring

Case-insensitive substring of the template title. An empty value is rejected with 400 invalid_query_parameter.

data_sourcesstring

Comma-separated data source names, for example facebook,google_ads. A template is returned when it supports at least one of them. An unknown name, an empty value or a bare comma is rejected with 400 invalid_query_parameter.

pageinteger

Page number, starting at 1. A page beyond the last one is rejected with 400 invalid_query_parameter, not answered with an empty list.

page_sizeinteger

Templates per page, from 1 to 100. A larger value is rejected with 400 invalid_query_parameter; it is not silently capped.

Response

One page of recipe templates

countinteger

Total number of templates matching the request.

nextstring nullable

Full URL of the next page, or null on the last page.

previousstring nullable

Full URL of the previous page, or null on the first page.

Changes

No recorded changes to this operation across all 1 revision of this API.