TEAMS API

Manage resources and operations related to teams.

Data Center:

GET Get List of Teams

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

Required Scopes:

vani.teams.read

Retrieves the list of teams associated with an edition.

Parameters

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

Responses

200 success

200 using filter fields

200 user part of the org and not part of anyteam

success - Response

{
  "data": {
    "teams": [
      {
        "created_time": "Tue, 28 May 2024, 15:34:44",
        "team_member_count": "5",
        "team_id": "1303000000002003",
        "is_default": "true",
        "created_by_name": "Dan",
        "zsoid": "60029715808",
        "created_by": "60029267674",
        "uri": "/vani/api/v1/editions/60029715808/teams/1303000000002003",
        "team_name": "Boxible"
      }
    ]
  },
  "message": "Teams fetched successfully",
  "request_uri": "/vani/api/v1/editions/60029715808/teams",
  "status": "success"
}

using filter fields - Response

{
  "data": {
    "teams": [
      {
        "team_member_count": "3",
        "team_name": "Test",
        "team_id": "1505000000002005"
      },
      {
        "team_member_count": "2",
        "team_name": "Shadow",
        "team_id": "1505000000051031"
      }
    ]
  },
  "message": "Teams fetched successfully",
  "request_uri": "/vani/api/v1/editions/97375109/teams",
  "status": "success"
}

user part of the org and not part of anyteam - Response

{
  "data": {
    "teams": []
  },
  "message": "User is not a member of any team",
  "request_uri": "/vani/api/v1/editions/98587682/teams",
  "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}/teams" \
  -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}/teams', {
  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}/teams'),
  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}/teams"
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}/teams"))
            .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}/teams";

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}/teams"
    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 Team Get

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

Required Scopes:

vani.teams.read

Retrieves information about a specific team in an edition.

Parameters

Name	Type	In	Required	Description
edition_id	string	path	Required	The unique ID of the edition.
team_id	string	path	Required	The unique ID of the team associated with the edition.

Responses

200 success

200 using filter fields

404 team not found

401 unauthorized

success - Response

{
  "data": {
    "team": {
      "created_time": "Tue, 28 May 2024, 15:34:44",
      "team_member_count": "5",
      "team_id": "1303000000002003",
      "created_by_name": "Dan",
      "zsoid": "60029715808",
      "created_by": "60029267674",
      "uri": "/vani/api/v1/editions/60029715808/teams/1303000000002003/members",
      "team_name": "Boxible"
    }
  },
  "message": "Teams fetched successfully",
  "request_uri": "/vani/api/v1/editions/60029715808/teams/1303000000002003",
  "status": "success"
}

using filter fields - Response

{
  "data": {
    "team": {
      "team_member_count": "5",
      "team_id": "1303000000002003",
      "created_by_name": "Dan",
      "team_name": "Boxible"
    }
  },
  "message": "Teams fetched successfully",
  "request_uri": "/vani/api/v1/editions/60029715808/teams/1303000000002003",
  "status": "success"
}

team not found - Response

{
  "error": {
    "details": {
      "current_user_id": "96384499",
      "error_code": "T1008",
      "edition_id": "96499735",
      "team_id": "300900000000200",
      "message": "Team not found"
    }
  },
  "request_uri": "/vani/api/v1/editions/96499735/teams/300900000000200",
  "status": "error"
}

unauthorized - Response

{
  "error": {
    "details": {
      "current_user_id": "96384499",
      "error_code": "T1006",
      "edition_id": "75918186",
      "team_id": "693000000008463",
      "message": "User is not a member of the team"
    }
  },
  "request_uri": "/vani/api/v1/editions/75918186/teams/693000000008463",
  "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}/teams/{team_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}/teams/{team_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}/teams/{team_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}/teams/{team_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}/teams/{team_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}/teams/{team_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}/teams/{team_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");
}

PUT Update Team Meta

PUT https://api.app.vanihq.com/vani/api/v1/editions/{edition_id}/teams/{team_id}

Required Scopes:

vani.teams.update

Updates the name and description of a specific team within a given edition.

Parameters

Name	Type	In	Required	Description
edition_id	string	path	Required	The unique ID of the edition.
team_id	string	path	Required	The unique ID of the team associated with the edition.
team_name	string	body	Based on Request	The name of the team.
description	string	body	Based on Request	Brief description about the team.

Request Body

JSON

{
  "team_name": "Test",
  "description": "team rename test"
}

Responses

200 success

200 name update

200 description update

404 team not found

success - Response

{
  "data": {
    "current_user_id": "96384499",
    "edition_id": "97375109",
    "team_id": "1505000000002005",
    "new_name": "Test",
    "new_description": "team rename test"
  },
  "message": "Team updated successfully",
  "request_uri": "/vani/api/v1/editions/97375109/teams/1505000000002005",
  "status": "success"
}

name update - Response

{
  "data": {
    "current_user_id": "96384499",
    "edition_id": "97375109",
    "team_id": "1505000000002005",
    "new_name": "Test"
  },
  "message": "Team updated successfully",
  "request_uri": "/vani/api/v1/editions/97375109/teams/1505000000002005",
  "status": "success"
}

description update - Response

{
  "data": {
    "current_user_id": "96384499",
    "edition_id": "97375109",
    "team_id": "1505000000002005",
    "new_description": "for testing the rest api"
  },
  "message": "Team updated successfully",
  "request_uri": "/vani/api/v1/editions/97375109/teams/1505000000002005",
  "status": "success"
}

team not found - Response

{
  "error": {
    "details": {
      "current_user_id": "96384499",
      "error_code": "T1008",
      "edition_id": "97375109",
      "team_id": "442100000000200",
      "message": "Team not found"
    }
  },
  "request_uri": "/vani/api/v1/editions/97375109/teams/442100000000200",
  "status": "error"
}

Code Examples

cURL Command line HTTP client

JavaScript Fetch API example

Python Requests library example

cURL

curl -X PUT "https://api.app.vanihq.com/vani/api/v1/editions/{edition_id}/teams/{team_id}" \
  -H "Authorization: Bearer YOUR_ACCESS_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
  "description": "team rename test"
}'

JavaScript

const response = await fetch('https://api.app.vanihq.com/vani/api/v1/editions/{edition_id}/teams/{team_id}', {
  method: 'PUT',
  headers: {
    'Authorization': 'Bearer YOUR_ACCESS_TOKEN',
    'Content-Type': 'application/json'
  },
  body: JSON.stringify({
  "description": "team rename test"
})
});

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}/teams/{team_id}'),
  method: 'PUT',
  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({
  "description": "team rename test"
}));
req.end();

Python

import requests

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

data = {
  "description": "team rename test"
}

response = requests.put(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/{edition_id}/teams/{team_id}"))
            .header("Authorization", "Bearer YOUR_ACCESS_TOKEN")
            .header("Content-Type", "application/json")
            .timeout(Duration.ofSeconds(30));

        String requestBody = "{\"description\":\"team rename test\"}";
        HttpRequest request = requestBuilder
            .PUT(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/{edition_id}/teams/{team_id}";

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

requestData = {"description": "team rename test"};

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