TEMPLATES API

Manage resources and operations related to templates.

Data Center:

GET Get Templates

GET https://api.app.vanihq.com/vani/api/v1/editions/{edition_id}/templates

Retrieves all templates available in the specific edition.

Parameters

Name	Type	In	Required	Description
edition_id	string	path	Required	The unique ID of the edition.

Responses

200 GET TEMPLATES

GET TEMPLATES - Response

{
  "data": {
    "templates": [
      {
        "name": "DAILY_STANDUP",
        "description": "Create to-do lists and ask teammates for help during the course of your work day.\r\n",
        "id": "3393603942092995046",
        "is_available_for_edition": "true"
      },
      {
        "name": "EISENHOWER_MATRIX",
        "description": "The Eisenhower Matrix, also known as the Urgent-Important Matrix, is a productivity tool used to prioritize tasks based on their urgency and importance.",
        "id": "2227813839241884264",
        "is_available_for_edition": "true"
      },
      {
        "name": "5WHYS",
        "description": "Find the root cause of a problem by asking &quot;Why?&quot; questions.",
        "id": "8825346814681087568",
        "is_available_for_edition": "true"
      },
      {
        "name": "TEAM_RECIPE_BOARD",
        "description": "A fun team activity to share the best and favorite recipes with each other.",
        "id": "709495071782421321",
        "is_available_for_edition": "true"
      },
      {
        "name": "NEVER_HAVE_I_EVER",
        "description": "Never Have I Ever is a popular card game designed to reveal interesting and embarrassing secrets about the players. It's a great icebreaker and often opens up fun, entertaining conversations.",
        "id": "9068022063805355070",
        "is_available_for_edition": "true"
      },
      {
        "name": "SITEMAP",
        "description": "Visualize your website flow with this sitemap template.",
        "id": "1786541087905054996",
        "is_available_for_edition": "true"
      },
      {
        "name": "NEW_TEAMMATE_PROJECT_MILESTONES",
        "description": "Help your new teammate understand all about your team's projects, the stuff they need to work on, and the expectations you've set for them.\r\n",
        "id": "2197960956629199196",
        "is_available_for_edition": "true"
      },
      {
        "name": "WEBSITE_SIGNUP_FLOW",
        "description": "A simple sign up flow to capture the visitor-to-subscriber conversion.",
        "id": "5772067647393374657",
        "is_available_for_edition": "true"
      },
      {
        "name": "PRODUCT_POSITIONING",
        "description": "Working on a new product or revising an existing one? Here are some positioning exercises for you and your teammates to brainstorm and fill in.\r\n",
        "id": "4786897632740503006",
        "is_available_for_edition": "true"
      },
      {
        "name": "STRATEGIC_GOAL_BOARD",
        "description": "Chart out some goals and work together with your teammates towards achieving them.\r\n",
        "id": "146806559048094029",
        "is_available_for_edition": "true"
      },
      {
        "name": "SALES_CALL_FOLLOW-UP",
        "description": "This is a quick way to share insights after a sales call and discuss them with your team.",
        "id": "1758538615716321335",
        "is_available_for_edition": "true"
      },
      {
        "name": "TEAM_CULTURE_GUIDE",
        "description": "A handy guide for any new entrant into a team, to understand more about the team culture and product/project building values.",
        "id": "4746934313648655725",
        "is_available_for_edition": "true"
      },
      {
        "name": "IMPACT_EFFORT_MATRIX",
        "description": "An impact effort matrix is a tool used in project management to help prioritize tasks based on their level of impact and effort required.",
        "id": "4880489140950000824",
        "is_available_for_edition": "true"
      },
      {
        "name": "MARKETING_RELEASE_CHECKLIST",
        "description": "Got an upcoming release? Here&#39;s an easier way to plan and execute\nyour marketing goals, so that you get everything covered.",
        "id": "5252159967532415789",
        "is_available_for_edition": "true"
      },
      {
        "name": "1-ON-1_FEEDBACK",
        "description": "Help your mentor or teammate get an idea of what you're going to discuss with them in your 1-on-1 feedback sessions.",
        "id": "415170746673786701",
        "is_available_for_edition": "true"
      },
      {
        "name": "TEAM_BOOK_SHELF",
        "description": "Build your team library with book recommendations from everyone.",
        "id": "2601700237097182900",
        "is_available_for_edition": "true"
      },
      {
        "name": "LEAN_CANVAS",
        "description": "Grow an idea into a full-fledged plan with this template.",
        "id": "268263724898650022",
        "is_available_for_edition": "true"
      },
      {
        "name": "WEEKLY_TEAM_PLANNER",
        "description": "Plan your week with your teammates using this template.\r\n",
        "id": "3212028571933595674",
        "is_available_for_edition": "true"
      },
      {
        "name": "ROUND_ROBIN_BRAINSTORMING",
        "description": "Collaborate with your teammates, take turns sharing ideas, and build on each other's thoughts to find a creative solution.",
        "id": "8868939742579530567",
        "is_available_for_edition": "true"
      },
      {
        "name": "BOOK_CLUB_MEETING",
        "description": "Use this template to jot down your bookish discussions and thoughts on what you are reading and keep track of your literary adventures. It is your cozy digital den for all things book-related.",
        "id": "2053719903222126011",
        "is_available_for_edition": "true"
      }
    ]
  },
  "message": "Templates fetched successfully",
  "request_uri": "/vani/api/v1/editions/60029715808/templates",
  "status": "success"
}

Code Examples

cURL Command line HTTP client

JavaScript Fetch API example

Python Requests library example

cURL

curl -X GET "https://api.app.vanihq.com/vani/api/v1/editions/{edition_id}/templates" \
  -H "Authorization: Bearer YOUR_ACCESS_TOKEN" \
  -H "Content-Type: application/json"

JavaScript

const response = await fetch('https://api.app.vanihq.com/vani/api/v1/editions/{edition_id}/templates', {
  method: 'GET',
  headers: {
    'Authorization': 'Bearer YOUR_ACCESS_TOKEN',
    'Content-Type': 'application/json'
  }
});

const data = await response.json();
// Process the response data
return data;

Node.js

const https = require('https');
const url = require('url');

const options = {
  ...url.parse('https://api.app.vanihq.com/vani/api/v1/editions/{edition_id}/templates'),
  method: 'GET',
  headers: {
    'Authorization': 'Bearer YOUR_ACCESS_TOKEN',
    'Content-Type': 'application/json'
  }
};

const req = https.request(options, (res) => {
  let data = '';
  res.on('data', (chunk) => data += chunk);
  res.on('end', () => {
    const result = JSON.parse(data);
    // Process the response data
  });
});

req.end();

Python

import requests

url = "https://api.app.vanihq.com/vani/api/v1/editions/{edition_id}/templates"
headers = {
    "Authorization": "Bearer YOUR_ACCESS_TOKEN",
    "Content-Type": "application/json"
}

response = requests.get(url, headers=headers)
data = response.json()
print(data)

Java

import java.net.http.HttpClient;
import java.net.http.HttpRequest;
import java.net.http.HttpResponse;
import java.net.URI;
import java.time.Duration;

public class ApiClient {
    public static void main(String[] args) throws Exception {
        HttpClient client = HttpClient.newBuilder()
            .connectTimeout(Duration.ofSeconds(10))
            .build();

        HttpRequest.Builder requestBuilder = HttpRequest.newBuilder()
            .uri(URI.create("https://api.app.vanihq.com/vani/api/v1/editions/{edition_id}/templates"))
            .header("Authorization", "Bearer YOUR_ACCESS_TOKEN")
            .header("Content-Type", "application/json")
            .timeout(Duration.ofSeconds(30));

        HttpRequest request = requestBuilder
            .GET(HttpRequest.BodyPublishers.noBody())
            .build();

        HttpResponse<String> response = client.send(request,
            HttpResponse.BodyHandlers.ofString());

        System.out.println(response.body());
    }
}

Deluge

info "Making API request to: https://api.app.vanihq.com/vani/api/v1/editions/{edition_id}/templates";

headers = Map();
headers.put("Authorization", "Bearer YOUR_ACCESS_TOKEN");
headers.put("Content-Type", "application/json");

response = invokeurl
[
    url: "https://api.app.vanihq.com/vani/api/v1/editions/{edition_id}/templates"
    type: GET
    headers: headers
];

if (response.get("status_code") == 200) {
    info "Request successful";
    responseData = response.get("response");
    info responseData;
} else {
    info "Request failed with status: " + response.get("status_code");
    info response.get("response");
}

GET Get Single Template

GET https://api.app.vanihq.com/vani/api/v1/editions/{edition_id}/templates/{template_id}

Retrieves information about the specific template in an edition.