TEMPLATES - Vani API Documentation

GET Fetch All Templates

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

Required Scopes:

vani.editions.read

Retrieves all templates available in the specific edition.

Parameters

Name	Type	In	Required	Description
fields	string	query	Optional	Specifies the fields (comma-separated) to retrieve. Allowed values: `id`, `description`, `name`, `is_available_for_edition`.
from	string	query	Optional	The starting index from where the results should be fetched. Default value is 0.
limit	string	query	Optional	The maximum number of results to return in the response. Default value is 20.
edition_id	string	path	Required	The unique ID of the edition.

Responses

200 Success

Success - Response

{
  "data": {
    "templates": [
      {
        "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": "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": "5 whys",
        "description": "Find the root cause of a problem by asking &quot;Why?&quot; questions.",
        "id": "8825346814681087568",
        "is_available_for_edition": "true"
      },
      {
        "name": "Guess the Doodle",
        "description": "Just want to chill with the team for a while? This visual game will help you and your team relax and bond with each other.",
        "id": "7193564480716665813",
        "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": "Customer problem statement",
        "description": "Get into your customer's shoes to better understand their problems. ",
        "id": "3570349084835838944",
        "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": "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": "New teammate onboarding",
        "description": "Onboard new members of your team with this fun template.",
        "id": "8077947179536093903",
        "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": "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": "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": "Team bookshelf",
        "description": "Build your team library with book recommendations from everyone.",
        "id": "2601700237097182900",
        "is_available_for_edition": "true"
      },
      {
        "name": "Team coffee discussion",
        "description": "Bond with your team over coffee, or just about anything you want, and have fun discussions.",
        "id": "6282257423499599528",
        "is_available_for_edition": "true"
      },
      {
        "name": "Team priority : Now, Next, Later",
        "description": "Working on your next team project? Quickly list down tasks and details, sort the most-important things to do, and keep track of the progress.\r\n",
        "id": "1189335149816408152",
        "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": "Website signup flow",
        "description": "A simple sign up flow to capture the visitor-to-subscriber conversion.",
        "id": "5772067647393374657",
        "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": "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/888012145/templates",
  "status": "success"
}

Code Examples

cURL

curl -X GET "https://api.app.vanihq.com/vani/api/v1/editions/{edition_id}/templates" \
  -H "Authorization: Bearer YOUR_ACCESS_TOKEN" \
  -H "x-vani-apikey: YOUR_API_KEY" \
  -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',
    'x-vani-apikey': 'YOUR_API_KEY',
    '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',
    'x-vani-apikey': 'YOUR_API_KEY',
    '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",
    "x-vani-apikey": "YOUR_API_KEY",
    "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("x-vani-apikey", "YOUR_API_KEY")
            .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("x-vani-apikey", "YOUR_API_KEY");
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 Fetch Template

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

Required Scopes:

vani.editions.read

Retrieves information about the specific template in an edition.

Parameters

Name	Type	In	Required	Description
fields	string	query	Optional	Specifies the fields (comma-separated) to retrieve. Allowed values: `id`, `description`, `name`, `is_available_for_edition`.
edition_id	string	path	Required	The unique ID of the edition.
template_id	string	path	Required	The unique ID of the template.

Responses

200 Success

404 Template not found

Success - Response

{
  "data": {
    "template": {
      "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"
    }
  },
  "message": "Template fetched successfully",
  "request_uri": "/vani/api/v1/editions/888012145/templates/415170746673786701",
  "status": "success"
}

Code Examples

cURL

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

JavaScript

const response = await fetch('https://api.app.vanihq.com/vani/api/v1/editions/{edition_id}/templates/{template_id}', {
  method: 'GET',
  headers: {
    'Authorization': 'Bearer YOUR_ACCESS_TOKEN',
    'x-vani-apikey': 'YOUR_API_KEY',
    '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/{template_id}'),
  method: 'GET',
  headers: {
    'Authorization': 'Bearer YOUR_ACCESS_TOKEN',
    'x-vani-apikey': 'YOUR_API_KEY',
    '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/{template_id}"
headers = {
    "Authorization": "Bearer YOUR_ACCESS_TOKEN",
    "x-vani-apikey": "YOUR_API_KEY",
    "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/{template_id}"))
            .header("Authorization", "Bearer YOUR_ACCESS_TOKEN")
            .header("x-vani-apikey", "YOUR_API_KEY")
            .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/{template_id}";

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

response = invokeurl
[
    url: "https://api.app.vanihq.com/vani/api/v1/editions/{edition_id}/templates/{template_id}"
    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");
}

TEMPLATES API

GET Fetch All Templates

Required Scopes:

Parameters

Responses

Code Examples

GET Fetch Template

Required Scopes:

Parameters

Responses

Code Examples