Templates (Designs)

List Templates (designs)

List all templates you have access to with the user assigned to the credentials.

This endpoint makes an HTTP GET request to retrieve a list of templates from the specified API endpoint.

Request

  • Method: GET

  • Endpoint: https://api.creatopy.com/v1/templates

  • Query Parameters:

    • keyword (string, optional): The keyword to search for a template name

    • projectId (string, optional): Return only templates from a project

    • limit (integer, optional): The maximum number of templates to be returned.

    • cursor (string, optional): A cursor for pagination.

    • apiGenerated (boolean, optional): Return only designs generated by API (excluded without this true)

    • onlyTemplates (boolean, optional): Return only designs (marked as custom templates) from a team

    • exactSearch (boolean, optional): If true, it will return only the templates with the name equal to keyword. (For ex. keyword = 'Template 1' will return only designs with the name 'Template 1')

    • orderBy (enum, optional): option to order the response results by next fields: 

      ID
NAME
CREATED_AT
UPDATED_AT

    • orderDirection (enum, optional): option to order the response by direction:

      ASC
DESC

Response

Upon a successful execution with a status code of 200, the response will be in JSON format and will include a "response" object containing an array of "nodes" with "id" and "name" properties, as well as a "pageInfo" object with "hasNextPage" and "endCursor" properties.

Request example:

Response example:

The thumbUrl is valid for 12 hours, after which it must be rerun the query to regenerate it.

Delete Template (design)

This endpoint allows you to delete a design (template).

Request

  • Method: DELETE

  • Endpoint: https://api.creatopy.com/v1/templates

  • Body:

    • hash (string, required): The hash of the template(design) you want to be deleted.

Response

The response will be in JSON format:

PreviousCreativesNextElements

Last updated