USER PERMISSION API

Manage resources and operations related to user permission.

Data Center:

GET Edition - Self Role Check

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

Returns the authenticated user's role in a specific edition.

Parameters

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

Responses

200 success

success - Response

{
  "data": {
    "user_permission_info": {
      "current_user_id": "96384499",
      "edition_id": "96499735",
      "role": "SUPER_ADMIN"
    }
  },
  "message": "User permissions fetched successfully",
  "request_uri": "/vani/api/v1/editions/96499735/users/me/permission",
  "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}/users/me/permission" \
  -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}/users/me/permission', {
  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}/users/me/permission'),
  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}/users/me/permission"
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}/users/me/permission"))
            .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}/users/me/permission";

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}/users/me/permission"
    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 Edition - Other Users

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

Retrieves the role of a specific user in an edition.

Parameters

Name	Type	In	Required	Description
edition_id	string	path	Required	The unique ID of the edition.
user_id	string	path	Required	The unique ID of the user(zuid).

Responses

200 success

404 user not found

401 unauthorized

success - Response

{
  "data": {
    "user_permission_info": {
      "current_user_id": "96384499",
      "edition_id": "96499735",
      "role": "ORG_ADMIN",
      "zuid": "80215739"
    }
  },
  "message": "User permissions fetched successfully",
  "request_uri": "/vani/api/v1/editions/96499735/users/80215739/permission",
  "status": "success"
}

user not found - Response

{
  "error": {
    "details": {
      "current_user_id": "96384499",
      "error_code": "E1009",
      "edition_id": "96499735",
      "message": "User not a part of the edition",
      "zuid": "19061053"
    }
  },
  "request_uri": "/vani/api/v1/editions/96499735/users/19061053/permission",
  "status": "error"
}

unauthorized - Response

{
  "error": {
    "details": {
      "current_user_id": "96384499",
      "error_code": "A1001",
      "edition_id": "75918186",
      "message": "Only super admin can do this action"
    }
  },
  "request_uri": "/vani/api/v1/editions/75918186/users/80215739/permission",
  "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}/users/{user_id}/permission" \
  -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}/users/{user_id}/permission', {
  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}/users/{user_id}/permission'),
  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}/users/{user_id}/permission"
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}/users/{user_id}/permission"))
            .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}/users/{user_id}/permission";

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}/users/{user_id}/permission"
    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 Teams

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

Returns a list of teams in a specific edition, along with the authenticated user's roles in each team.

Parameters

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

Responses

200 success - team admin

200 success - member

success - team admin - Response

{
  "data": {
    "user_permission_info": {
      "teams": [
        {
          "role": "TEAM_ADMIN",
          "team_id": 3009000000002003
        }
      ],
      "current_user_id": "96384499",
      "edition_id": "96499735"
    }
  },
  "message": "User permissions fetched successfully",
  "request_uri": "/vani/api/v1/editions/96499735/teams/users/me/permission",
  "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/users/me/permission" \
  -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/users/me/permission', {
  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/users/me/permission'),
  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/users/me/permission"
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/users/me/permission"))
            .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/users/me/permission";

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/users/me/permission"
    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 - Self Role Check

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

Returns the role of the authenticated user in a team.

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

404 team not found

403 user is not a member

success - Response

{
  "data": {
    "user_permission_info": {
      "current_user_id": "96384499",
      "edition_id": "96499735",
      "role": "TEAM_ADMIN",
      "team_id": "3009000000002003"
    }
  },
  "message": "User permissions fetched successfully",
  "request_uri": "/vani/api/v1/editions/96499735/teams/3009000000002003/users/me/permission",
  "status": "success"
}

team not found - Response

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

user is not a member - Response

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

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}/users/me/permission"
    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 - Other Users

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

Returns the role assigned to a specified user in a team.

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.
user_id	string	path	Required	The unique ID of the user(zuid).

Responses

200 succcess

404 user is not a member

401 unauthorized

succcess - Response

{
  "data": {
    "user_permission_info": {
      "current_user_id": "96384499",
      "edition_id": "96499735",
      "role": "TEAM_ADMIN",
      "team_id": "3009000000002003",
      "zuid": "80215739"
    }
  },
  "message": "User permissions fetched successfully",
  "request_uri": "/vani/api/v1/editions/96499735/teams/3009000000002003/users/80215739/permission",
  "status": "success"
}

user is not a member - Response

{
  "error": {
    "details": {
      "current_user_id": "96384499",
      "error_code": "T1006",
      "edition_id": "96499735",
      "team_id": "3009000000002003",
      "message": "User is not a member of the team",
      "zuid": "80585905"
    }
  },
  "request_uri": "/vani/api/v1/editions/96499735/teams/3009000000002003/users/80585905/permission",
  "status": "error"
}

unauthorized - Response

{
  "error": {
    "details": {
      "current_user_id": "96384499",
      "error_code": "A1002",
      "edition_id": "75918186",
      "team_id": "693000000436009",
      "message": "Only admin can do this action"
    }
  },
  "request_uri": "/vani/api/v1/editions/75918186/teams/693000000436009/users/80585905/permission",
  "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}/users/{user_id}/permission" \
  -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}/users/{user_id}/permission', {
  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}/users/{user_id}/permission'),
  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}/users/{user_id}/permission"
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}/users/{user_id}/permission"))
            .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}/users/{user_id}/permission";

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}/users/{user_id}/permission"
    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 Space - Self Role Check

GET https://api.app.vanihq.com/vani/api/v1/editions/{edition_id}/spaces/{space_id}/users/me/permission

Retrieves the authenticated user's role in a specified Space.

Parameters

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

Responses

200 success

404 space not found

403 member is not part of the space

success - Response

{
  "data": {
    "user_permission_info": {
      "current_user_id": "96384499",
      "edition_id": "96499735",
      "role": "CREATOR",
      "space_id": "3009000000093003"
    }
  },
  "message": "User permissions fetched successfully",
  "request_uri": "/vani/api/v1/editions/96499735/spaces/3009000000093003/users/me/permission",
  "status": "success"
}

space not found - Response

{
  "error": {
    "details": {
      "current_user_id": "96384499",
      "error_code": "S1009",
      "edition_id": "96499735",
      "message": "Space not found",
      "space_id": "300900000093003"
    }
  },
  "request_uri": "/vani/api/v1/editions/96499735/spaces/300900000093003/users/me/permission",
  "status": "error"
}

member is not part of the space - Response

{
  "error": {
    "details": {
      "current_user_id": "96384499",
      "error_code": "S1015",
      "edition_id": "96499735",
      "message": "member is not part of the Space",
      "space_id": "3009000000298005"
    }
  },
  "request_uri": "/vani/api/v1/editions/96499735/spaces/3009000000298005/users/me/permission",
  "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}/spaces/{space_id}/users/me/permission" \
  -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}/spaces/{space_id}/users/me/permission', {
  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}/spaces/{space_id}/users/me/permission'),
  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}/spaces/{space_id}/users/me/permission"
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}/spaces/{space_id}/users/me/permission"))
            .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}/spaces/{space_id}/users/me/permission";

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}/spaces/{space_id}/users/me/permission"
    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 Space - Other Users

GET https://api.app.vanihq.com/vani/api/v1/editions/{edition_id}/spaces/{space_id}/users/{user_id}/permission

Returns the role of a specified user in a given Space.

Parameters

Name	Type	In	Required	Description
edition_id	string	path	Required	The unique ID of the edition.
space_id	string	path	Required	The unique ID of the Space.
user_id	string	path	Required	The unique ID of the user(zuid).

Responses

200 success

404 member not part of the space

401 unauthorized

success - Response

{
  "data": {
    "user_permission_info": {
      "current_user_id": "96384499",
      "edition_id": "96499735",
      "role": "EDITOR",
      "space_id": "3009000000303003",
      "zuid": "80215739"
    }
  },
  "message": "User permissions fetched successfully",
  "request_uri": "/vani/api/v1/editions/96499735/spaces/3009000000303003/users/80215739/permission",
  "status": "success"
}

member not part of the space - Response

{
  "error": {
    "details": {
      "current_user_id": "96384499",
      "error_code": "S1015",
      "edition_id": "96499735",
      "message": "member is not part of the Space",
      "space_id": "3009000000303003",
      "zuid": "80215739"
    }
  },
  "request_uri": "/vani/api/v1/editions/96499735/spaces/3009000000303003/users/80215739/permission",
  "status": "error"
}

unauthorized - Response

{
  "error": {
    "details": {
      "current_user_id": "96384499",
      "error_code": "S1020",
      "edition_id": "96499735",
      "message": "User is not the owner of the Space",
      "space_id": "3009000000298005"
    }
  },
  "request_uri": "/vani/api/v1/editions/96499735/spaces/3009000000298005/users/80215739/permission",
  "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}/spaces/{space_id}/users/{user_id}/permission" \
  -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}/spaces/{space_id}/users/{user_id}/permission', {
  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}/spaces/{space_id}/users/{user_id}/permission'),
  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}/spaces/{space_id}/users/{user_id}/permission"
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}/spaces/{space_id}/users/{user_id}/permission"))
            .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}/spaces/{space_id}/users/{user_id}/permission";

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}/spaces/{space_id}/users/{user_id}/permission"
    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");
}