EDITIONS API

Manage resources and operations related to editions.

Data Center:

GET All Editions

GET https://api.app.vanihq.com/vani/api/v1/editions

Retrieves the edition details based on the specified fields. If no fields are provided, the API returns all the details about the edition.

Parameters

Name	Type	In	Required	Description
fields	string	query	Optional	Specifies the fields (comma-separated) to retrieve. Allowed values: `state`, `created_time`, `last_modified_time`, `edition_type_name`, `edition_name`, `edition_role_name`, `edition_id`, `edition_owner_id`, `is_default`, `uri`.

Responses

200 success

200 using filter fields

200 User is not part of any edition

success - Response

{
  "data": {
    "editions_info": [
      {
        "created_time": "Sun, 09 Apr 2023, 08:43:02",
        "last_modified_time": "Sun, 09 Apr 2023, 08:43:02",
        "edition_id": "75918186",
        "edition_type_name": "ORG",
        "state": "ACTIVE",
        "edition_name": "OrgEditionTest",
        "edition_owner_id": "69828190",
        "is_default": "true",
        "uri": "/vani/api/v1/editions/75918186"
      },
      {
        "created_time": "Fri, 03 Jan 2025, 11:55:58",
        "last_modified_time": "Wed, 29 Jan 2025, 18:26:53",
        "edition_id": "96499735",
        "edition_type_name": "TEAM",
        "state": "ACTIVE",
        "edition_name": "REST API TEAM V1 1",
        "edition_owner_id": "96384499",
        "uri": "/vani/api/v1/editions/96499735"
      },
      {
        "created_time": "Tue, 21 Jan 2025, 17:04:53",
        "last_modified_time": "Tue, 21 Jan 2025, 17:06:52",
        "edition_id": "97375109",
        "edition_type_name": "ORG",
        "state": "ACTIVE",
        "edition_name": "NR&#39;s ORG",
        "edition_owner_id": "96384499",
        "uri": "/vani/api/v1/editions/97375109"
      },
      {
        "created_time": "Fri, 31 Jan 2025, 17:11:31",
        "last_modified_time": "Fri, 31 Jan 2025, 17:11:31",
        "edition_id": "98587682",
        "edition_type_name": "ORG",
        "state": "ACTIVE",
        "edition_name": "testing",
        "edition_owner_id": "96384499",
        "uri": "/vani/api/v1/editions/98587682"
      }
    ]
  },
  "message": "Editions fetched successfully",
  "request_uri": "/vani/api/v1/editions",
  "status": "success"
}

using filter fields - Response

{
  "data": {
    "editions_info": [
      {
        "edition_name": "OrgEditionTest",
        "edition_owner_id": "69828190"
      },
      {
        "edition_name": "DEV team",
        "edition_owner_id": "85572741"
      },
      {
        "edition_name": "testing",
        "edition_owner_id": "96384499"
      },
      {
        "edition_name": "TeamEdition",
        "edition_owner_id": "98722154"
      },
      {
        "edition_name": "REST API TEAM V1 1 😃😃",
        "edition_owner_id": "96384499"
      },
      {
        "edition_name": "NR&#39;s ORG",
        "edition_owner_id": "96384499"
      }
    ]
  },
  "message": "Editions fetched successfully",
  "request_uri": "/vani/api/v1/editions",
  "status": "success"
}

User is not part of any edition - Response

{
  "data": {
    "editions_info": {}
  },
  "message": "Editions fetched successfully",
  "request_uri": "/vani/api/v1/editions",
  "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" \
  -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', {
  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'),
  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"
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"))
            .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";

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"
    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 Single Edition

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

Retrieves information for a specific edition based on the provided edition_id.

Parameters

Name	Type	In	Required	Description
fields	string	query	Optional	Specifies the fields (comma-separated) to retrieve. Allowed values: `state`, `created_time`, `last_modified_time`, `edition_type_name`, `edition_name`, `edition_role_name`, `edition_id`, `edition_owner_id`, `is_default`, `uri`.
edition_id	string	path	Required	The unique ID of the edition.

Responses

200 success

200 using filter fields

401 with invalid apikey

success - Response

{
  "data": {
    "edition_info": {
      "created_time": "Tue, 28 May 2024, 15:34:44",
      "last_modified_time": "Tue, 28 May 2024, 15:35:02",
      "edition_id": "60029715808",
      "edition_type_name": "TEAM",
      "state": "ACTIVE",
      "edition_name": "Boxible",
      "edition_owner_id": "60029267674",
      "uri": "/vani/api/v1/editions/60029715808/teams"
    }
  },
  "message": "Editions fetched successfully",
  "request_uri": "/vani/api/v1/editions/60029715808",
  "status": "success"
}

using filter fields - Response

{
  "data": {
    "edition_info": {
      "edition_name": "Boxible",
      "edition_owner_id": "60029267674",
      "state": "ACTIVE"
    }
  },
  "message": "Editions fetched successfully",
  "request_uri": "/vani/api/v1/editions/60029715808",
  "status": "success"
}

with invalid apikey - Response

{
  "error": {
    "details": {
      "message": "Given API Key is not valid.",
      "error_code": "A1008",
      "edition_id": "96499735"
    }
  },
  "request_uri": "/vani/api/v1/editions/96499735",
  "status": "error"
}

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}" \
  -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}', {
  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}'),
  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}"
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}"))
            .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}";

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}"
    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");
}

POST Team Edition Creation

POST https://api.app.vanihq.com/vani/api/v1/editions

Creates a new edition and a team.

Parameters

Name	Type	In	Required	Description
team_name	string	body	Based on Request	Name of the team to be created.
description	string	body	Based on Request	Brief description about the team.
plan_type	string	body	Based on Request	Specifies the nature of the plan. Allowed values: `FREE`, `TRIAL`. (The Free plan will be selected when the plan_type is not provided)

Request Body

JSON

{
  "team_name": "TeamEdition",
  "description": "testing team edition creation",
  "plan_type": "TRIAL"
}

Responses

200 success

409 already created edition

success - Response

{
  "data": {
    "current_user_id": "98722154",
    "edition_id": "98723605",
    "team_id": 5265000000002003,
    "team_name": "TeamEdition"
  },
  "message": "Team created successfully",
  "request_uri": "/vani/api/v1/editions",
  "status": "success"
}

Code Examples

cURL Command line HTTP client

JavaScript Fetch API example

Python Requests library example

cURL

curl -X POST "https://api.app.vanihq.com/vani/api/v1/editions" \
  -H "Authorization: Bearer YOUR_ACCESS_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
  "team_name": "TeamEdition",
  "description": "testing team edition creation",
  "plan_type": "TRIAL"
}'

JavaScript

const response = await fetch('https://api.app.vanihq.com/vani/api/v1/editions', {
  method: 'POST',
  headers: {
    'Authorization': 'Bearer YOUR_ACCESS_TOKEN',
    'Content-Type': 'application/json'
  },
  body: JSON.stringify({
  "team_name": "TeamEdition",
  "description": "testing team edition creation",
  "plan_type": "TRIAL"
})
});

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'),
  method: 'POST',
  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.write(JSON.stringify({
  "team_name": "TeamEdition",
  "description": "testing team edition creation",
  "plan_type": "TRIAL"
}));
req.end();

Python

import requests

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

data = {
  "team_name": "TeamEdition",
  "description": "testing team edition creation",
  "plan_type": "TRIAL"
}

response = requests.post(url, headers=headers, json=data)
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"))
            .header("Authorization", "Bearer YOUR_ACCESS_TOKEN")
            .header("Content-Type", "application/json")
            .timeout(Duration.ofSeconds(30));

        String requestBody = "{\"team_name\":\"TeamEdition\",\"description\":\"testing team edition creation\",\"plan_type\":\"TRIAL\"}";
        HttpRequest request = requestBuilder
            .POST(HttpRequest.BodyPublishers.ofString(requestBody))
            .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";

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

requestData = {"team_name": "TeamEdition", "description": "testing team edition creation", "plan_type": "TRIAL"};

response = invokeurl
[
    url: "https://api.app.vanihq.com/vani/api/v1/editions"
    type: POST
    headers: headers
    parameters: requestData
];

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");
}