SPACES API

Manage resources and operations related to Spaces.

Data Center:

GET Get

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

Retrieves information about a specific Space in an edition.

Parameters

Name	Type	In	Required	Description
fields	string	query	Optional	Comma-separated list of field names to include in the response. If omitted, all fields will be returned.
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

401 unauthorized

200 using filter fields

success - Response

{
  "data": {
    "space_info": {
      "created_time": "Wed, 02 Apr 2025, 14:46:07",
      "is_favorite": "false",
      "last_modified_time": "Mon, 14 Apr 2025, 19:01:10",
      "can_edit": "true",
      "allow_embed": "false",
      "team_id": "1303000000002003",
      "space_member_count": "1",
      "space_name": "New Space",
      "publish": "false",
      "owner_zuid": "60029267674",
      "space_id": "1303000000492291",
      "last_author_zuid": "60029267674",
      "status": "ACTIVE"
    }
  },
  "message": "Space fetched successfully.",
  "request_uri": "/vani/api/v1/editions/60029715808/spaces/1303000000492291",
  "status": "success"
}

unauthorized - Response

{
  "error": {
    "details": {
      "current_user_id": "96384499",
      "message": "The user doesn't have permission to perform this action",
      "error_code": "A1003"
    }
  },
  "request_uri": "/vani/api/v1/editions/96499735/spaces/300900000009300",
  "status": "error"
}

using filter fields - Response

{
  "data": {
    "space_info": {
      "can_edit": "true",
      "is_favorite": "false",
      "team_id": "1303000000002003"
    }
  },
  "message": "Space fetched successfully.",
  "request_uri": "/vani/api/v1/editions/60029715808/spaces/1303000000492291",
  "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}/spaces/{space_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}/spaces/{space_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}/spaces/{space_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}/spaces/{space_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}/spaces/{space_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}/spaces/{space_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}/spaces/{space_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");
}

GET Get All Spaces

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

Retrieves a list of Spaces in an edition.

Parameters

Name	Type	In	Required	Description
team_id	string	query	Required	The ID of the team within the edition.
action_type	string	query	Required	Specifies the category or context of Spaces `ALLSPACES` : All Spaces within the edition. `SHARED_SPACES` : Spaces shared with you. `SHARED_BY_ME` : Spaces you’ve shared. `SHARED_BY_OTHERS` : Spaces shared by others with you. `PUBLISHED_WITH_TEAM` : Spaces published with the team. `FAVORITES` : Spaces marked as favourites. `DRAFT_SPACES` : Spaces that are in draft. `RECENTLY_TRASHED` : Recently trashed Spaces.
sort_by	string	query	Optional	Specifies how to sort the results. Example: A_Z for alphabetical order. Allowed values: `TIME_CREATED`, `TIME_DELETED_ASC`, `TIME_DELETED_DESC`, `A_Z`, `Z_A`, `RECENTLY_OPENED`, `RECENTLY_TRASHED`, `RECENTLY_ACCESSED_BY_USER, RECENTLY_MODIFIED_BY_USER.`
from	string	query	Optional	Indicates the starting point (page number) for paginated results. The default value is 1, meaning the query will start from the first page. The starting point (page number) for the query used for pagination. Default is 1.
limit	string	query	Optional	The number of Spaces to be returned in the response. The Default value is 10.
need_total_count	string	query	Optional	Set this to true if you want to include the total count of items in the response. By default, this is false.
edition_id	string	path	Required	The unique ID of the edition.

Responses

200 A_T - ALL_SPACES

200 SHARED_SPACES

200 SHARED_BY_ME

200 SHARED_BY_OTHERS

200 PUBLISHED_WITH_TEAM

200 FAVOURITES

200 DRAFT_SPACES

200 RECENTLY_TRASHED

200 RECENT_ALL_SPACES_ORG

200 using filter fields

A_T - ALL_SPACES - Response

{
  "data": {
    "space_count": 34,
    "spaces_info": [
      {
        "created_time": "Fri, 24 Jan 2025, 12:25:29",
        "is_favorite": "true",
        "last_modified_time": "Fri, 24 Jan 2025, 12:25:29",
        "space_name": "Business case template",
        "publish": "false",
        "owner_zuid": "96384499",
        "can_edit": "true",
        "team_id": "3009000000002003",
        "space_member_count": "1",
        "space_id": "3009000000093779",
        "last_author_zuid": "96384499",
        "status": "ACTIVE"
      },
      {
        "created_time": "Fri, 24 Jan 2025, 12:25:24",
        "is_favorite": "false",
        "last_modified_time": "Fri, 24 Jan 2025, 12:25:24",
        "space_name": "Customer journey map",
        "publish": "false",
        "owner_zuid": "96384499",
        "can_edit": "true",
        "team_id": "3009000000002003",
        "space_member_count": "1",
        "space_id": "3009000000093710",
        "last_author_zuid": "96384499",
        "status": "ACTIVE"
      }
    ]
  },
  "message": "Space fetched successfully.",
  "request_uri": "/vani/api/v1/editions/96499735/spaces",
  "status": "success"
}

SHARED_SPACES - Response

{
  "data": {
    "space_count": 4,
    "spaces_info": [
      {
        "created_time": "Wed, 22 Jan 2025, 01:17:29",
        "last_modified_time": "Wed, 22 Jan 2025, 01:17:29",
        "is_favorite": "false",
        "space_name": "New Space",
        "publish": "false",
        "owner_zuid": "97377569",
        "can_edit": "true",
        "team_id": "3009000000002003",
        "space_member_count": "3",
        "space_id": "3009000000058037",
        "last_author_zuid": "97377569",
        "status": "ACTIVE"
      },
      {
        "created_time": "Fri, 24 Jan 2025, 00:01:19",
        "last_modified_time": "Fri, 24 Jan 2025, 00:01:19",
        "is_favorite": "false",
        "space_name": "New Space",
        "publish": "false",
        "owner_zuid": "96384499",
        "can_edit": "true",
        "team_id": "3009000000002003",
        "space_member_count": "2",
        "space_id": "3009000000093003",
        "last_author_zuid": "96384499",
        "status": "ACTIVE"
      },
      {
        "created_time": "Wed, 22 Jan 2025, 00:44:10",
        "last_modified_time": "Wed, 22 Jan 2025, 00:44:10",
        "is_favorite": "false",
        "space_name": "project members test",
        "publish": "false",
        "owner_zuid": "96384499",
        "can_edit": "true",
        "team_id": "3009000000002003",
        "space_member_count": "3",
        "space_id": "3009000000067027",
        "last_author_zuid": "96384499",
        "status": "ACTIVE"
      }
    ]
  },
  "message": "Space fetched successfully.",
  "request_uri": "/vani/api/v1/editions/96499735/spaces",
  "status": "success"
}

SHARED_BY_ME - Response

{
  "data": {
    "space_count": 3,
    "spaces_info": [
      {
        "created_time": "Fri, 24 Jan 2025, 00:01:19",
        "last_modified_time": "Fri, 24 Jan 2025, 00:01:19",
        "is_favorite": "false",
        "space_name": "New Space",
        "publish": "false",
        "owner_zuid": "96384499",
        "can_edit": "true",
        "team_id": "3009000000002003",
        "space_member_count": "2",
        "space_id": "3009000000093003",
        "last_author_zuid": "96384499",
        "status": "ACTIVE"
      }
    ]
  },
  "message": "Space fetched successfully.",
  "request_uri": "/vani/api/v1/editions/96499735/spaces",
  "status": "success"
}

SHARED_BY_OTHERS - Response

{
  "data": {
    "space_count": 1,
    "spaces_info": [
      {
        "created_time": "Wed, 22 Jan 2025, 01:17:29",
        "last_modified_time": "Wed, 22 Jan 2025, 01:17:29",
        "is_favorite": "false",
        "space_name": "New Space",
        "publish": "false",
        "owner_zuid": "97377569",
        "can_edit": "false",
        "team_id": "3009000000002003",
        "space_member_count": "3",
        "space_id": "3009000000058037",
        "last_author_zuid": "97377569",
        "status": "ACTIVE"
      }
    ]
  },
  "message": "Space fetched successfully.",
  "request_uri": "/vani/api/v1/editions/96499735/spaces",
  "status": "success"
}

PUBLISHED_WITH_TEAM - Response

{
  "data": {
    "space_count": 2,
    "spaces_info": [
      {
        "created_time": "Fri, 17 Jan 2025, 12:00:57",
        "last_modified_time": "Fri, 17 Jan 2025, 12:40:05",
        "is_favorite": "false",
        "space_name": "testing library",
        "publish": "false",
        "owner_zuid": "96384499",
        "can_edit": "true",
        "team_id": "3009000000002003",
        "space_member_count": "0",
        "space_id": "3009000000038005",
        "last_author_zuid": "96384499",
        "status": "ACTIVE"
      },
      {
        "created_time": "Fri, 03 Jan 2025, 11:55:58",
        "last_modified_time": "Fri, 03 Jan 2025, 11:57:14",
        "is_favorite": "false",
        "space_name": "Vani - Getting Started",
        "publish": "false",
        "owner_zuid": "96384499",
        "can_edit": "true",
        "team_id": "3009000000002003",
        "space_member_count": "0",
        "space_id": "3009000000002013",
        "last_author_zuid": "96384499",
        "status": "ACTIVE"
      }
    ]
  },
  "message": "Space fetched successfully.",
  "request_uri": "/vani/api/v1/editions/96499735/spaces",
  "status": "success"
}

FAVOURITES - Response

{
  "data": {
    "space_count": 1,
    "spaces_info": [
      {
        "created_time": "Fri, 24 Jan 2025, 12:25:29",
        "last_modified_time": "Fri, 24 Jan 2025, 12:25:29",
        "is_favorite": "true",
        "space_name": "Business case template",
        "publish": "false",
        "owner_zuid": "96384499",
        "can_edit": "true",
        "team_id": "3009000000002003",
        "space_member_count": "1",
        "space_id": "3009000000093779",
        "last_author_zuid": "96384499",
        "status": "ACTIVE"
      }
    ]
  },
  "message": "Space fetched successfully.",
  "request_uri": "/vani/api/v1/editions/96499735/spaces",
  "status": "success"
}

DRAFT_SPACES - Response

{
  "data": {
    "space_count": 24,
    "spaces_info": [
      {
        "created_time": "Fri, 24 Jan 2025, 12:25:29",
        "last_modified_time": "Fri, 24 Jan 2025, 12:25:29",
        "is_favorite": "true",
        "space_name": "Business case template",
        "publish": "false",
        "owner_zuid": "96384499",
        "can_edit": "true",
        "team_id": "3009000000002003",
        "space_id": "3009000000093779",
        "last_author_zuid": "96384499",
        "status": "ACTIVE"
      },
      {
        "created_time": "Fri, 24 Jan 2025, 12:25:24",
        "last_modified_time": "Fri, 24 Jan 2025, 12:25:24",
        "is_favorite": "false",
        "space_name": "Customer journey map",
        "publish": "false",
        "owner_zuid": "96384499",
        "can_edit": "true",
        "team_id": "3009000000002003",
        "space_id": "3009000000093710",
        "last_author_zuid": "96384499",
        "status": "ACTIVE"
      },
      {
        "created_time": "Wed, 22 Jan 2025, 21:42:57",
        "last_modified_time": "Wed, 22 Jan 2025, 21:42:57",
        "is_favorite": "false",
        "space_name": "GET PROJECT TEST",
        "publish": "false",
        "owner_zuid": "96384499",
        "can_edit": "true",
        "team_id": "3009000000002003",
        "space_id": "3009000000090062",
        "last_author_zuid": "96384499",
        "status": "ACTIVE"
      },
      {
        "created_time": "Mon, 27 Jan 2025, 22:07:24",
        "last_modified_time": "Mon, 27 Jan 2025, 22:07:24",
        "is_favorite": "false",
        "space_name": "New Space",
        "publish": "false",
        "owner_zuid": "96384499",
        "can_edit": "true",
        "team_id": "3009000000002003",
        "space_id": "3009000000098042",
        "last_author_zuid": "96384499",
        "status": "ACTIVE"
      },
      {
        "created_time": "Mon, 27 Jan 2025, 22:13:00",
        "last_modified_time": "Mon, 27 Jan 2025, 22:13:00",
        "is_favorite": "false",
        "space_name": "New Space",
        "publish": "false",
        "owner_zuid": "96384499",
        "can_edit": "true",
        "team_id": "3009000000002003",
        "space_id": "3009000000100003",
        "last_author_zuid": "96384499",
        "status": "ACTIVE"
      },
      {
        "created_time": "Mon, 27 Jan 2025, 22:13:35",
        "last_modified_time": "Mon, 27 Jan 2025, 22:13:35",
        "is_favorite": "false",
        "space_name": "New Space",
        "publish": "false",
        "owner_zuid": "96384499",
        "can_edit": "true",
        "team_id": "3009000000002003",
        "space_id": "3009000000100067",
        "last_author_zuid": "96384499",
        "status": "ACTIVE"
      },
      {
        "created_time": "Mon, 27 Jan 2025, 22:14:52",
        "last_modified_time": "Mon, 27 Jan 2025, 22:14:52",
        "is_favorite": "false",
        "space_name": "New Space",
        "publish": "false",
        "owner_zuid": "96384499",
        "can_edit": "true",
        "team_id": "3009000000002003",
        "space_id": "3009000000100187",
        "last_author_zuid": "96384499",
        "status": "ACTIVE"
      },
      {
        "created_time": "Mon, 27 Jan 2025, 22:17:19",
        "last_modified_time": "Mon, 27 Jan 2025, 22:17:19",
        "is_favorite": "false",
        "space_name": "New Space",
        "publish": "false",
        "owner_zuid": "96384499",
        "can_edit": "true",
        "team_id": "3009000000002003",
        "space_id": "3009000000100307",
        "last_author_zuid": "96384499",
        "status": "ACTIVE"
      },
      {
        "created_time": "Tue, 28 Jan 2025, 20:22:52",
        "last_modified_time": "Tue, 28 Jan 2025, 21:39:33",
        "is_favorite": "false",
        "space_name": "New Space",
        "publish": "false",
        "owner_zuid": "96384499",
        "can_edit": "true",
        "team_id": "3009000000002003",
        "space_id": "3009000000111003",
        "last_author_zuid": "96384499",
        "status": "ACTIVE"
      },
      {
        "created_time": "Wed, 29 Jan 2025, 17:43:08",
        "last_modified_time": "Wed, 29 Jan 2025, 17:43:08",
        "is_favorite": "false",
        "space_name": "New Space",
        "publish": "false",
        "owner_zuid": "96384499",
        "can_edit": "true",
        "team_id": "3009000000002003",
        "space_id": "3009000000126009",
        "last_author_zuid": "96384499",
        "status": "ACTIVE"
      }
    ]
  },
  "message": "Space fetched successfully.",
  "request_uri": "/vani/api/v1/editions/96499735/spaces",
  "status": "success"
}

RECENTLY_TRASHED - Response

{
  "data": {
    "space_count": 2,
    "spaces_info": [
      {
        "created_time": "Fri, 24 Jan 2025, 12:26:26",
        "last_modified_time": "Fri, 24 Jan 2025, 12:26:26",
        "is_favorite": "false",
        "space_name": "trash 1",
        "publish": "false",
        "owner_zuid": "96384499",
        "can_edit": "true",
        "team_id": "3009000000002003",
        "state_modified_time": "Fri, 24 Jan 2025, 12:26:36",
        "space_id": "3009000000093854",
        "last_author_zuid": "96384499",
        "status": "TRASH"
      },
      {
        "created_time": "Fri, 24 Jan 2025, 12:26:46",
        "last_modified_time": "Fri, 24 Jan 2025, 12:26:46",
        "is_favorite": "false",
        "space_name": "trash 2",
        "publish": "false",
        "owner_zuid": "96384499",
        "can_edit": "true",
        "team_id": "3009000000002003",
        "state_modified_time": "Fri, 24 Jan 2025, 12:26:51",
        "space_id": "3009000000093930",
        "last_author_zuid": "96384499",
        "status": "TRASH"
      }
    ]
  },
  "message": "Space fetched successfully.",
  "request_uri": "/vani/api/v1/editions/96499735/spaces",
  "status": "success"
}

RECENT_ALL_SPACES_ORG - Response

{
  "data": {
    "space_count": 3,
    "spaces_info": [
      {
        "created_time": "Tue, 21 Jan 2025, 16:42:42",
        "last_modified_time": "Tue, 21 Jan 2025, 16:43:35",
        "is_favorite": "false",
        "space_name": "new project rename testing",
        "publish": "false",
        "owner_zuid": "96384499",
        "can_edit": "true",
        "team_id": "693000000450001",
        "space_member_count": "1",
        "space_id": "693000000486029",
        "last_author_zuid": "96384499",
        "status": "ACTIVE"
      },
      {
        "created_time": "Sun, 19 Jan 2025, 17:45:36",
        "last_modified_time": "Wed, 22 Jan 2025, 12:38:13",
        "is_favorite": "false",
        "space_name": "rename testing",
        "publish": "false",
        "owner_zuid": "80585905",
        "can_edit": "true",
        "team_id": "693000000436009",
        "space_member_count": "5",
        "space_id": "693000000481013",
        "last_author_zuid": "80585905",
        "status": "ACTIVE"
      },
      {
        "created_time": "Fri, 24 Jan 2025, 16:25:39",
        "last_modified_time": "Sun, 26 Jan 2025, 00:12:28",
        "is_favorite": "false",
        "space_name": "Strategy planning",
        "publish": "false",
        "owner_zuid": "96384499",
        "can_edit": "true",
        "team_id": "693000000436009",
        "space_member_count": "1",
        "space_id": "693000000510019",
        "last_author_zuid": "96384499",
        "status": "ACTIVE"
      }
    ]
  },
  "message": "Space fetched successfully.",
  "request_uri": "/vani/api/v1/editions/75918186/spaces",
  "status": "success"
}

using filter fields - Response

{
  "data": {
    "space_count": 58,
    "spaces_info": [
      {
        "space_name": "Business case template",
        "owner_zuid": "96384499",
        "space_member_count": "1"
      },
      {
        "space_name": "Customer journey map",
        "owner_zuid": "96384499",
        "space_member_count": "1"
      },
      {
        "space_name": "GET PROJECT TEST",
        "owner_zuid": "96384499",
        "space_member_count": "1"
      },
      {
        "space_name": "New Space",
        "owner_zuid": "97377569",
        "space_member_count": "2"
      },
      {
        "space_name": "New Space",
        "owner_zuid": "96384499",
        "space_member_count": "1"
      },
      {
        "space_name": "New Space",
        "owner_zuid": "96384499",
        "space_member_count": "1"
      },
      {
        "space_name": "New Space",
        "owner_zuid": "96384499",
        "space_member_count": "1"
      },
      {
        "space_name": "New Space",
        "owner_zuid": "96384499",
        "space_member_count": "1"
      },
      {
        "space_name": "New Space",
        "owner_zuid": "96384499",
        "space_member_count": "1"
      },
      {
        "space_name": "New Space",
        "owner_zuid": "96384499",
        "space_member_count": "1"
      }
    ]
  },
  "message": "Space fetched successfully.",
  "request_uri": "/vani/api/v1/editions/96499735/spaces",
  "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}/spaces" \
  -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', {
  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'),
  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"
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"))
            .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";

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"
    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 Space Creation

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

Creates a new Space within a specific team in an edition.

Parameters

Name	Type	In	Required	Description
edition_id	string	path	Required	The unique ID of the edition
space_name	string	body	Based on Request	The name of the new Space to be created.
team_id	string	body	Based on Request	The ID of the team where the Space is to be created.

Request Body

JSON

{
    "create_space":{
        "space_name":"REST API SPACE",
        "team_id": {{team_id}}
    }
}

Responses

200 success

200 success with template

404 template not found

404 Team not found

401 user is not teammember

success - Response

{
  "data": {
    "current_user_id": "96384499",
    "edition_id": "96499735",
    "space_id": "3009000000141003",
    "uri": "/vani/api/v1/editions/96499735/spaces/3009000000141003"
  },
  "message": "Space created successfully.",
  "request_uri": "/vani/api/v1/editions/96499735/spaces/",
  "status": "success"
}

success with template - Response

{
  "data": {
    "current_user_id": "96384499",
    "edition_id": "96499735",
    "space_id": "3009000000145003",
    "uri": "/vani/api/v1/editions/96499735/spaces/3009000000145003"
  },
  "message": "Space created successfully.",
  "request_uri": "/vani/api/v1/editions/96499735/spaces/",
  "status": "success"
}

template not found - Response

{
  "error": {
    "details": {
      "current_user_id": "60029267674",
      "error_code": "S1030",
      "edition_id": "60029715808",
      "message": "Template not found"
    }
  },
  "request_uri": "/vani/api/v1/editions/60029715808/spaces/",
  "status": "error"
}

Team not found - Response

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

user is not teammember - Response

{
  "error": {
    "details": {
      "current_user_id": "96384499",
      "message": "User is not a member of the team",
      "error_code": "T1006"
    }
  },
  "request_uri": "/vani/api/v1/editions/75918186/spaces/",
  "status": "error"
}

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/{edition_id}/spaces/" \
  -H "Authorization: Bearer YOUR_ACCESS_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
  "create_space": {
    "space_name": "space creation",
    "team_id": "{{team_id}}"
  }
}'

JavaScript

const response = await fetch('https://api.app.vanihq.com/vani/api/v1/editions/{edition_id}/spaces/', {
  method: 'POST',
  headers: {
    'Authorization': 'Bearer YOUR_ACCESS_TOKEN',
    'Content-Type': 'application/json'
  },
  body: JSON.stringify({
  "create_space": {
    "space_name": "space creation",
    "team_id": "{{team_id}}"
  }
})
});

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/'),
  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({
  "create_space": {
    "space_name": "space creation",
    "team_id": "{{team_id}}"
  }
}));
req.end();

Python

import requests

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

data = {
  "create_space": {
    "space_name": "space creation",
    "team_id": "{{team_id}}"
  }
}

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

        String requestBody = "{\"create_space\":{\"space_name\":\"space creation\",\"team_id\":\"{{team_id}}\"}}";
        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/{edition_id}/spaces/";

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

requestData = {"create_space": {"space_name": "space creation", "team_id": "{{team_id}}"}};

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

POST Space Duplicate

POST https://api.app.vanihq.com/vani/api/v1/editions/{edition_id}/spaces/{space_id}/duplicate

Duplicates the Space in a team.

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.
space_name	string	body	Based on Request	The name for the duplicated Space.

Request Body

JSON

{
  "duplicate_space": {
    "space_name": "test duplicate project"
  }
}

Responses

200 SPACE DUPLICATE - success

200 success without new space name

404 SPACE DUPLICATE - not found

403 SPACE DUPLICATE - tryoutteam

401 SPACE DUPLICATE - unauthorized user

SPACE DUPLICATE - success - Response

{
  "data": {
    "space_info": {
      "created_time": "Sat, 08 Mar 2025, 17:37:07",
      "last_modified_time": "Sat, 08 Mar 2025, 17:37:07",
      "is_favorite": "false",
      "space_name": "test duplicate project",
      "publish": "false",
      "owner_zuid": "80215739",
      "can_edit": "true",
      "team_id": "3009000000002003",
      "allow_embed": "false",
      "space_id": "3009000000239335",
      "last_author_zuid": "80215739",
      "status": "ACTIVE"
    }
  },
  "message": "Space duplicated successfully",
  "request_uri": "/vani/api/v1/editions/96499735/spaces/3009000000232005/duplicate",
  "status": "success"
}

success without new space name - Response

{
  "data": {
    "space_info": {
      "created_time": "Sat, 08 Mar 2025, 18:12:41",
      "is_favorite": "false",
      "last_modified_time": "Sat, 08 Mar 2025, 18:12:41",
      "space_name": "Copy of Social media strategy and planning",
      "publish": "false",
      "owner_zuid": "80215739",
      "can_edit": "true",
      "allow_embed": "false",
      "team_id": "3009000000002003",
      "space_id": "3009000000239843",
      "last_author_zuid": "80215739",
      "status": "ACTIVE"
    }
  },
  "message": "Space duplicated successfully",
  "request_uri": "/vani/api/v1/editions/96499735/spaces/3009000000232005/duplicate",
  "status": "success"
}

SPACE DUPLICATE - not found - Response

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

SPACE DUPLICATE - tryoutteam - Response

{
  "error": {
    "details": {
      "current_user_id": "80215739",
      "error_code": "S1025",
      "edition_id": "75434908",
      "message": "Copying space to this team is not permitted.",
      "space_id": "149000040103525"
    }
  },
  "request_uri": "/vani/api/v1/editions/75434908/spaces/149000040103525/duplicate",
  "status": "error"
}

SPACE DUPLICATE - unauthorized user - Response

{
  "error": {
    "details": {
      "current_user_id": "80215739",
      "error_code": "A1003",
      "edition_id": "96499735",
      "message": "The user doesn't have permission to perform this action",
      "space_id": "3009000000093003"
    }
  },
  "request_uri": "/vani/api/v1/editions/96499735/spaces/3009000000093003/duplicate",
  "status": "error"
}

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/{edition_id}/spaces/{space_id}/duplicate" \
  -H "Authorization: Bearer YOUR_ACCESS_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
  "duplicate_space": {
    "space_name": "test duplicate space"
  }
}'

JavaScript

const response = await fetch('https://api.app.vanihq.com/vani/api/v1/editions/{edition_id}/spaces/{space_id}/duplicate', {
  method: 'POST',
  headers: {
    'Authorization': 'Bearer YOUR_ACCESS_TOKEN',
    'Content-Type': 'application/json'
  },
  body: JSON.stringify({
  "duplicate_space": {
    "space_name": "test duplicate space"
  }
})
});

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}/duplicate'),
  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({
  "duplicate_space": {
    "space_name": "test duplicate space"
  }
}));
req.end();

Python

import requests

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

data = {
  "duplicate_space": {
    "space_name": "test duplicate space"
  }
}

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/{edition_id}/spaces/{space_id}/duplicate"))
            .header("Authorization", "Bearer YOUR_ACCESS_TOKEN")
            .header("Content-Type", "application/json")
            .timeout(Duration.ofSeconds(30));

        String requestBody = "{\"duplicate_space\":{\"space_name\":\"test duplicate space\"}}";
        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/{edition_id}/spaces/{space_id}/duplicate";

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

requestData = {"duplicate_space": {"space_name": "test duplicate space"}};

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

POST Space Move

POST https://api.app.vanihq.com/vani/api/v1/editions/{edition_id}/spaces/{space_id}/move

Moves the Space to a different team.

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.

Request Body

JSON

{
  "move_space": {
    "team_id": 693000000435005
  }
}

Responses

200 SPACE MOVE - success

403 SPACE MOVE - moving space to sameteam restricted

404 SPACE MOVE - space not found

400 SPACE MOVE - failed (without request params)

401 SPACE MOVE - unauthorized

SPACE MOVE - success - Response

{
  "data": {
    "space_info": {
      "created_time": "Sun, 09 Mar 2025, 12:27:54",
      "last_modified_time": "Sun, 09 Mar 2025, 12:27:54",
      "is_favorite": "false",
      "space_name": "move space",
      "publish": "false",
      "owner_zuid": "96384499",
      "can_edit": "true",
      "team_id": "693000000435005",
      "allow_embed": "false",
      "space_id": "693000000558051",
      "last_author_zuid": "96384499",
      "status": "ACTIVE"
    }
  },
  "message": "Space moved successfully",
  "request_uri": "/vani/api/v1/editions/75918186/spaces/693000000554217/move",
  "status": "success"
}

SPACE MOVE - moving space to sameteam restricted - Response

{
  "error": {
    "details": {
      "current_user_id": "96384499",
      "error_code": "S1026",
      "edition_id": "75918186",
      "team_id": "693000000436009",
      "message": "Moving space to this team is not permitted.",
      "space_id": "693000000554217"
    }
  },
  "request_uri": "/vani/api/v1/editions/75918186/spaces/693000000554217/move",
  "status": "error"
}

SPACE MOVE - space not found - Response

{
  "error": {
    "details": {
      "current_user_id": "96384499",
      "error_code": "S1009",
      "edition_id": "75918186",
      "team_id": "693000000435005",
      "message": "Space not found",
      "space_id": "693000000554005"
    }
  },
  "request_uri": "/vani/api/v1/editions/75918186/spaces/693000000554005/move",
  "status": "error"
}

SPACE MOVE - failed (without request params) - Response

{
  "error": {
    "details": {
      "current_user_id": "96384499",
      "error_code": "A1005",
      "edition_id": "75918186",
      "message": "The param requested is Invalid or empty",
      "space_id": "693000000554005"
    }
  },
  "request_uri": "/vani/api/v1/editions/75918186/spaces/693000000554005/move",
  "status": "error"
}

SPACE MOVE - unauthorized - Response

{
  "error": {
    "details": {
      "current_user_id": "96384499",
      "error_code": "A1003",
      "edition_id": "75918186",
      "team_id": "693000000435005",
      "message": "The user doesn't have permission to perform this action",
      "space_id": "693000000481013"
    }
  },
  "request_uri": "/vani/api/v1/editions/75918186/spaces/693000000481013/move",
  "status": "error"
}

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/{edition_id}/spaces/{space_id}/move" \
  -H "Authorization: Bearer YOUR_ACCESS_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
  "move_space": {
    "team_id": "{{team_id}}"
  }
}'

JavaScript

const response = await fetch('https://api.app.vanihq.com/vani/api/v1/editions/{edition_id}/spaces/{space_id}/move', {
  method: 'POST',
  headers: {
    'Authorization': 'Bearer YOUR_ACCESS_TOKEN',
    'Content-Type': 'application/json'
  },
  body: JSON.stringify({
  "move_space": {
    "team_id": "{{team_id}}"
  }
})
});

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}/move'),
  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({
  "move_space": {
    "team_id": "{{team_id}}"
  }
}));
req.end();

Python

import requests

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

data = {
  "move_space": {
    "team_id": "{{team_id}}"
  }
}

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/{edition_id}/spaces/{space_id}/move"))
            .header("Authorization", "Bearer YOUR_ACCESS_TOKEN")
            .header("Content-Type", "application/json")
            .timeout(Duration.ofSeconds(30));

        String requestBody = "{\"move_space\":{\"team_id\":\"{{team_id}}\"}}";
        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/{edition_id}/spaces/{space_id}/move";

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

requestData = {"move_space": {"team_id": "{{team_id}}"}};

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

PUT Trash

PUT https://api.app.vanihq.com/vani/api/v1/editions/{edition_id}/spaces/{space_id}/state

Trashes the Space in an edition.

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.
space_state	string	body	Based on Request	The value must be set to `TRASH` to consider the Space as trashed. Note: Only active Spaces can be trashed. Trying to trash any other type will result in an error.

Request Body

JSON

{
  "space_state": "TRASH"
}

Responses

200 success

400 space is not in active state

401 unauthorized

success - Response

{
  "data": {
    "current_user_id": "96384499",
    "edition_id": "96499735",
    "space_state": "TRASH",
    "space_id": "3009000000093854"
  },
  "message": "Space state updated successfully.",
  "request_uri": "/vani/api/v1/editions/96499735/spaces/3009000000093854/state",
  "status": "success"
}

space is not in active state - Response

{
  "error": {
    "details": {
      "current_user_id": "96384499",
      "message": "Space is not in an active state",
      "error_code": "S1012"
    }
  },
  "request_uri": "/vani/api/v1/editions/96499735/spaces/3009000000093854/state",
  "status": "error"
}

unauthorized - Response

{
  "error": {
    "details": {
      "current_user_id": "96384499",
      "message": "The user doesn't have permission to perform this action",
      "error_code": "A1003"
    }
  },
  "request_uri": "/vani/api/v1/editions/96499735/spaces/300900000009003/state",
  "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}/spaces/{space_id}/state" \
  -H "Authorization: Bearer YOUR_ACCESS_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
  "space_state": "TRASH"
}'

JavaScript

const response = await fetch('https://api.app.vanihq.com/vani/api/v1/editions/{edition_id}/spaces/{space_id}/state', {
  method: 'PUT',
  headers: {
    'Authorization': 'Bearer YOUR_ACCESS_TOKEN',
    'Content-Type': 'application/json'
  },
  body: JSON.stringify({
  "space_state": "TRASH"
})
});

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}/state'),
  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({
  "space_state": "TRASH"
}));
req.end();

Python

import requests

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

data = {
  "space_state": "TRASH"
}

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}/spaces/{space_id}/state"))
            .header("Authorization", "Bearer YOUR_ACCESS_TOKEN")
            .header("Content-Type", "application/json")
            .timeout(Duration.ofSeconds(30));

        String requestBody = "{\"space_state\":\"TRASH\"}";
        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}/spaces/{space_id}/state";

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

requestData = {"space_state": "TRASH"};

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

PUT Restore

PUT https://api.app.vanihq.com/vani/api/v1/editions/{edition_id}/spaces/{space_id}/state

Restores the Space in an edition.

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.
space_state	string	body	Based on Request	The value must be set to `RESTORE` to restore the Space.Note: Only trashed Spaces can be restored. Trying to restore any other type will result in an error.

Request Body

JSON

{
  "space_state": "RESTORE"
}

Responses

200 sucess

400 space is not trashed

401 unauthorized

sucess - Response

{
  "data": {
    "current_user_id": "96384499",
    "edition_id": "96499735",
    "space_state": "RESTORE",
    "space_id": "3009000000093854"
  },
  "message": "Space state updated successfully.",
  "request_uri": "/vani/api/v1/editions/96499735/spaces/3009000000093854/state",
  "status": "success"
}

space is not trashed - Response

{
  "error": {
    "details": {
      "current_user_id": "96384499",
      "message": "Space is not in an trashed state",
      "error_code": "S1011"
    }
  },
  "request_uri": "/vani/api/v1/editions/96499735/spaces/3009000000141003/state",
  "status": "error"
}

unauthorized - Response

{
  "error": {
    "details": {
      "current_user_id": "96384499",
      "message": "The user doesn't have permission to perform this action",
      "error_code": "A1003"
    }
  },
  "request_uri": "/vani/api/v1/editions/96499735/spaces/300900000000003/state",
  "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}/spaces/{space_id}/state" \
  -H "Authorization: Bearer YOUR_ACCESS_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
  "space_state": "RESTORE"
}'

JavaScript

const response = await fetch('https://api.app.vanihq.com/vani/api/v1/editions/{edition_id}/spaces/{space_id}/state', {
  method: 'PUT',
  headers: {
    'Authorization': 'Bearer YOUR_ACCESS_TOKEN',
    'Content-Type': 'application/json'
  },
  body: JSON.stringify({
  "space_state": "RESTORE"
})
});

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}/state'),
  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({
  "space_state": "RESTORE"
}));
req.end();

Python

import requests

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

data = {
  "space_state": "RESTORE"
}

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}/spaces/{space_id}/state"))
            .header("Authorization", "Bearer YOUR_ACCESS_TOKEN")
            .header("Content-Type", "application/json")
            .timeout(Duration.ofSeconds(30));

        String requestBody = "{\"space_state\":\"RESTORE\"}";
        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}/spaces/{space_id}/state";

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

requestData = {"space_state": "RESTORE"};

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

PUT Space Rename

PUT https://api.app.vanihq.com/vani/api/v1/editions/{edition_id}/spaces/{space_id}/meta

Updates the name of a specific Space in an edition.

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.
space_name	string	body	Based on Request	The new name of the Space.

Request Body

JSON

{
  "space_name": "rename testing",
  "action_type": "SPACE_NAME"
}

Responses

200 success

409 same project name

401 unauthorized

success - Response

{
  "data": {
    "current_user_id": "96384499",
    "edition_id": "96499735",
    "space_id": "3009000000141003",
    "new_name": "rename testing"
  },
  "message": "Space meta updated successfully.",
  "request_uri": "/vani/api/v1/editions/96499735/spaces/3009000000141003/meta",
  "status": "success"
}

same project name - Response

{
  "error": {
    "details": {
      "current_user_id": "96384499",
      "error_code": "S1014",
      "edition_id": "96499735",
      "message": "Space name is same as the new name",
      "space_id": "3009000000141003"
    }
  },
  "request_uri": "/vani/api/v1/editions/96499735/spaces/3009000000141003/meta",
  "status": "error"
}

unauthorized - Response

{
  "error": {
    "details": {
      "current_user_id": "96384499",
      "error_code": "A1003",
      "edition_id": "75918186",
      "message": "The user doesn't have permission to perform this action",
      "space_id": "3009000000141003"
    }
  },
  "request_uri": "/vani/api/v1/editions/75918186/spaces/3009000000141003/meta",
  "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}/spaces/{space_id}/meta" \
  -H "Authorization: Bearer YOUR_ACCESS_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
  "space_name": "rename testing",
  "action_type": "SPACE_NAME"
}'

JavaScript

const response = await fetch('https://api.app.vanihq.com/vani/api/v1/editions/{edition_id}/spaces/{space_id}/meta', {
  method: 'PUT',
  headers: {
    'Authorization': 'Bearer YOUR_ACCESS_TOKEN',
    'Content-Type': 'application/json'
  },
  body: JSON.stringify({
  "space_name": "rename testing",
  "action_type": "SPACE_NAME"
})
});

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}/meta'),
  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({
  "space_name": "rename testing",
  "action_type": "SPACE_NAME"
}));
req.end();

Python

import requests

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

data = {
  "space_name": "rename testing",
  "action_type": "SPACE_NAME"
}

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}/spaces/{space_id}/meta"))
            .header("Authorization", "Bearer YOUR_ACCESS_TOKEN")
            .header("Content-Type", "application/json")
            .timeout(Duration.ofSeconds(30));

        String requestBody = "{\"space_name\":\"rename testing\",\"action_type\":\"SPACE_NAME\"}";
        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}/spaces/{space_id}/meta";

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

requestData = {"space_name": "rename testing", "action_type": "SPACE_NAME"};

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

PUT Space Favorite

PUT https://api.app.vanihq.com/vani/api/v1/editions/{edition_id}/spaces/{space_id}/meta

Adds a Space to your favorites or removes it from the favorites list within the given edition.

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.

Request Body

JSON

{
  "value": true,
  "action_type": "FAVORITE"
}

Responses

200 favorite - success

200 remove favorite - success

409 already favorite

409 already not favorite

401 unauthorized

favorite - success - Response

{
  "data": {
    "current_user_id": "96384499",
    "edition_id": "96499735",
    "is_favourite": true,
    "space_id": "3009000000141003"
  },
  "message": "Space meta updated successfully.",
  "request_uri": "/vani/api/v1/editions/96499735/spaces/3009000000141003/meta",
  "status": "success"
}

remove favorite - success - Response

{
  "data": {
    "current_user_id": "96384499",
    "edition_id": "96499735",
    "is_favourite": false,
    "space_id": "3009000000141003"
  },
  "message": "Space meta updated successfully.",
  "request_uri": "/vani/api/v1/editions/96499735/spaces/3009000000141003/meta",
  "status": "success"
}

already favorite - Response

{
  "error": {
    "details": {
      "current_user_id": "96384499",
      "error_code": "S1017",
      "edition_id": "96499735",
      "message": "Space is already favourite",
      "space_id": "3009000000141003"
    }
  },
  "request_uri": "/vani/api/v1/editions/96499735/spaces/3009000000141003/meta",
  "status": "error"
}

already not favorite - Response

{
  "error": {
    "details": {
      "current_user_id": "96384499",
      "error_code": "S1018",
      "edition_id": "96499735",
      "message": "Space is not favourite",
      "space_id": "3009000000141003"
    }
  },
  "request_uri": "/vani/api/v1/editions/96499735/spaces/3009000000141003/meta",
  "status": "error"
}

unauthorized - Response

{
  "error": {
    "details": {
      "current_user_id": "96384499",
      "error_code": "A1003",
      "edition_id": "96499735",
      "message": "The user doesn't have permission to perform this action",
      "space_id": "300900000014100"
    }
  },
  "request_uri": "/vani/api/v1/editions/96499735/spaces/300900000014100/meta",
  "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}/spaces/{space_id}/meta" \
  -H "Authorization: Bearer YOUR_ACCESS_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
  "value": true,
  "action_type": "FAVORITE"
}'

JavaScript

const response = await fetch('https://api.app.vanihq.com/vani/api/v1/editions/{edition_id}/spaces/{space_id}/meta', {
  method: 'PUT',
  headers: {
    'Authorization': 'Bearer YOUR_ACCESS_TOKEN',
    'Content-Type': 'application/json'
  },
  body: JSON.stringify({
  "value": true,
  "action_type": "FAVORITE"
})
});

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}/meta'),
  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({
  "value": true,
  "action_type": "FAVORITE"
}));
req.end();

Python

import requests

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

data = {
  "value": true,
  "action_type": "FAVORITE"
}

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}/spaces/{space_id}/meta"))
            .header("Authorization", "Bearer YOUR_ACCESS_TOKEN")
            .header("Content-Type", "application/json")
            .timeout(Duration.ofSeconds(30));

        String requestBody = "{\"value\":true,\"action_type\":\"FAVORITE\"}";
        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}/spaces/{space_id}/meta";

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

requestData = {"value": true, "action_type": "FAVORITE"};

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

PUT Space Embed

PUT https://api.app.vanihq.com/vani/api/v1/editions/{edition_id}/spaces/{space_id}/meta

Enables or disables embedding a Space on external platforms or locations.

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.
value	string	body	Based on Request	Set to true to enable embedding, or false to disable it.
action_type	string	body	Based on Request	Must be set to `EMBED` to enable or disable embedding for the Space.

Request Body

JSON

{
  "value": true,
  "action_type": "EMBED"
}

Responses

200 success

409 already in embedded state

200 REMOVE SPACE EMBED - success

409 REMOVE SPACE EMBED - not in embed state

401 SPACE EMBED - unauthorized

success - Response

{
  "data": {
    "current_user_id": "96384499",
    "edition_id": "96499735",
    "space_id": "3009000000093003",
    "embed_status": true
  },
  "message": "Space meta updated successfully.",
  "request_uri": "/vani/api/v1/editions/96499735/spaces/3009000000093003/meta",
  "status": "success"
}

already in embedded state - Response

{
  "error": {
    "details": {
      "current_user_id": "96384499",
      "error_code": "S1021",
      "edition_id": "96499735",
      "message": "Space is already in an embedded state",
      "space_id": "3009000000093003"
    }
  },
  "request_uri": "/vani/api/v1/editions/96499735/spaces/3009000000093003/meta",
  "status": "error"
}

REMOVE SPACE EMBED - success - Response

{
  "data": {
    "current_user_id": "96384499",
    "edition_id": "96499735",
    "space_id": "3009000000093003",
    "embed_status": false
  },
  "message": "Space meta updated successfully.",
  "request_uri": "/vani/api/v1/editions/96499735/spaces/3009000000093003/meta",
  "status": "success"
}

REMOVE SPACE EMBED - not in embed state - Response

{
  "error": {
    "details": {
      "current_user_id": "96384499",
      "error_code": "S1022",
      "edition_id": "96499735",
      "message": "Space is not in an embedded state",
      "space_id": "3009000000093003"
    }
  },
  "request_uri": "/vani/api/v1/editions/96499735/spaces/3009000000093003/meta",
  "status": "error"
}

SPACE EMBED - unauthorized - Response

{
  "error": {
    "details": {
      "current_user_id": "96384499",
      "error_code": "A1003",
      "edition_id": "96499735",
      "message": "The user doesn't have permission to perform this action",
      "space_id": "3009000000220049"
    }
  },
  "request_uri": "/vani/api/v1/editions/96499735/spaces/3009000000220049/meta",
  "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}/spaces/{space_id}/meta" \
  -H "Authorization: Bearer YOUR_ACCESS_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
  "value": true,
  "action_type": "EMBED"
}'

JavaScript

const response = await fetch('https://api.app.vanihq.com/vani/api/v1/editions/{edition_id}/spaces/{space_id}/meta', {
  method: 'PUT',
  headers: {
    'Authorization': 'Bearer YOUR_ACCESS_TOKEN',
    'Content-Type': 'application/json'
  },
  body: JSON.stringify({
  "value": true,
  "action_type": "EMBED"
})
});

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}/meta'),
  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({
  "value": true,
  "action_type": "EMBED"
}));
req.end();

Python

import requests

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

data = {
  "value": true,
  "action_type": "EMBED"
}

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}/spaces/{space_id}/meta"))
            .header("Authorization", "Bearer YOUR_ACCESS_TOKEN")
            .header("Content-Type", "application/json")
            .timeout(Duration.ofSeconds(30));

        String requestBody = "{\"value\":true,\"action_type\":\"EMBED\"}";
        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}/spaces/{space_id}/meta";

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

requestData = {"value": true, "action_type": "EMBED"};

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