SEARCH API
Manage resources and operations related to search.
GET Search
GET https://api.app.vanihq.com/vani/api/v1/editions/{edition_id}/teams/{team_id}/search
Searches for the keyword across Zones, frames, and comments that are accessible to the user.
Parameters
| Name | Type | In | Required | Description |
|---|---|---|---|---|
| search | string | query | Required | The keyword or phrase to search for. |
| from | string | query | Optional | The starting point (page number) for the query used for pagination. The default value is 1. |
| limit | string | query | Optional | The number of results to be returned in the response. The default value is 10. |
| edition_id | string | path | Required | The unique ID of the edition. |
| team_id | string | path | Required | The unique ID of the team associated with the edition. |
Responses
200
success
200
no match found
200
Filter by types
success - Response
{
"data": {
"search_result": {
"comments": [
{
"zone_id": "db069372-0246-42e8-a049-bdcbd84b292c",
"space_name": "test duplicate project",
"comment_id": "577B2B70-B190-4574-A0C0-D5DF8ACD9F0D",
"space_id": "3009000000303003",
"uri": "/vani/api/v1/editions/96499735/spaces/3009000000303003/zones?action_type=GET_SPACE_DATA_WITH_ZONE_DATA&zone_id=db069372-0246-42e8-a049-bdcbd84b292c"
}
],
"frames": [
{
"frame_name": "Team onboarding",
"zone_id": "6ac7327e-19ea-441c-aeb8-7ed2689d9aa4",
"space_name": "Vani - Getting Started",
"zone_name": "Who can use Vani?",
"space_id": "3009000000002013",
"uri": "/vani/api/v1/editions/96499735/spaces/3009000000002013/zones?action_type=GET_SPACE_DATA_WITH_ZONE_DATA&zone_id=6ac7327e-19ea-441c-aeb8-7ed2689d9aa4",
"frame_id": "08C5C1E6-3F2B-410F-8C2B-F5E8DA2E26AA"
},
{
"frame_name": "Pins",
"zone_id": "f3dd023d-6a37-4237-9740-183c8041c2f2",
"space_name": "Vani - Getting Started",
"zone_name": "FAQs",
"space_id": "3009000000002013",
"uri": "/vani/api/v1/editions/96499735/spaces/3009000000002013/zones?action_type=GET_SPACE_DATA_WITH_ZONE_DATA&zone_id=f3dd023d-6a37-4237-9740-183c8041c2f2",
"frame_id": "13188A26-7AC3-49D1-A763-69A4AF710071"
},
{
"frame_name": "Starting on Vani",
"zone_id": "f3dd023d-6a37-4237-9740-183c8041c2f2",
"space_name": "Vani - Getting Started",
"zone_name": "FAQs",
"space_id": "3009000000002013",
"uri": "/vani/api/v1/editions/96499735/spaces/3009000000002013/zones?action_type=GET_SPACE_DATA_WITH_ZONE_DATA&zone_id=f3dd023d-6a37-4237-9740-183c8041c2f2",
"frame_id": "A6D8C018-5CDD-4F58-ADAC-7C4D98D67E54"
},
{
"frame_name": "Pins",
"zone_id": "f3dd023d-6a37-4237-9740-183c8041c2f2",
"space_name": "Vani - Getting Started",
"zone_name": "FAQs",
"space_id": "3009000000002013",
"uri": "/vani/api/v1/editions/96499735/spaces/3009000000002013/zones?action_type=GET_SPACE_DATA_WITH_ZONE_DATA&zone_id=f3dd023d-6a37-4237-9740-183c8041c2f2",
"frame_id": "9D189640-16D9-4C33-A6C5-407098D9B08E"
},
{
"frame_name": "Uses of Vani",
"zone_id": "f3dd023d-6a37-4237-9740-183c8041c2f2",
"space_name": "Vani - Getting Started",
"zone_name": "FAQs",
"space_id": "3009000000002013",
"uri": "/vani/api/v1/editions/96499735/spaces/3009000000002013/zones?action_type=GET_SPACE_DATA_WITH_ZONE_DATA&zone_id=f3dd023d-6a37-4237-9740-183c8041c2f2",
"frame_id": "02A3F8FC-2F14-4EB3-BD21-2910A58920B2"
},
{
"frame_name": "Invite your team",
"zone_id": "9aeb2e5c-c91e-497b-83f1-e20865b5543f",
"space_name": "Vani - Getting Started",
"zone_name": "Things to know",
"space_id": "3009000000002013",
"uri": "/vani/api/v1/editions/96499735/spaces/3009000000002013/zones?action_type=GET_SPACE_DATA_WITH_ZONE_DATA&zone_id=9aeb2e5c-c91e-497b-83f1-e20865b5543f",
"frame_id": "F746EDA0-910D-465A-A494-2BD4ED80A4B5"
}
],
"zones": [
{
"zone_id": "2109e8c5-cbe7-42b7-b8e6-a900983e83cc",
"space_name": "New Space",
"zone_name": "Swot analysis - Research & Reference",
"space_id": "3009000000100307",
"uri": "/vani/api/v1/editions/96499735/spaces/3009000000100307/zones?action_type=GET_SPACE_DATA_WITH_ZONE_DATA&zone_id=2109e8c5-cbe7-42b7-b8e6-a900983e83cc"
},
{
"zone_id": "46985e9f-2d53-47a7-b3c7-2dbbfc639531",
"space_name": "New Space",
"zone_name": "Zone 1 - final",
"space_id": "3009000000100187",
"uri": "/vani/api/v1/editions/96499735/spaces/3009000000100187/zones?action_type=GET_SPACE_DATA_WITH_ZONE_DATA&zone_id=46985e9f-2d53-47a7-b3c7-2dbbfc639531"
},
{
"zone_id": "6bd164bb-8308-4446-93a0-8bf432527172",
"space_name": "Team culture guide",
"zone_name": "Zone 1 - final",
"space_id": "3009000000095122",
"uri": "/vani/api/v1/editions/96499735/spaces/3009000000095122/zones?action_type=GET_SPACE_DATA_WITH_ZONE_DATA&zone_id=6bd164bb-8308-4446-93a0-8bf432527172"
},
{
"zone_id": "cf3b11a1-df3d-42ab-b937-aab048579ff5",
"space_name": "Service blueprint",
"zone_name": "Service blueprint - Plan & Ship",
"space_id": "3009000000093216",
"uri": "/vani/api/v1/editions/96499735/spaces/3009000000093216/zones?action_type=GET_SPACE_DATA_WITH_ZONE_DATA&zone_id=cf3b11a1-df3d-42ab-b937-aab048579ff5"
},
{
"zone_id": "d58ca262-9c23-49ef-b116-96e424c7ca0d",
"space_name": "PEST analysis",
"zone_name": "Zone 1",
"space_id": "3009000000093625",
"uri": "/vani/api/v1/editions/96499735/spaces/3009000000093625/zones?action_type=GET_SPACE_DATA_WITH_ZONE_DATA&zone_id=d58ca262-9c23-49ef-b116-96e424c7ca0d"
}
],
"shapes": []
}
},
"message": "Content search completed successfully",
"request_uri": "/vani/api/v1/editions/96499735/teams/3009000000002003/search",
"status": "success"
}
Code Examples
cURL
Command line HTTP client
cURL
curl -X GET "https://api.app.vanihq.com/vani/api/v1/editions/{edition_id}/teams/{team_id}/search" \
-H "Authorization: Bearer YOUR_ACCESS_TOKEN" \
-H "Content-Type: application/json"
GET Zone Search
GET https://api.app.vanihq.com/vani/api/v1/editions/{edition_id}/teams/{team_id}/spaces/search
Searches across Zones and their linked content and returns the matching Zones with metadata and assets.
Parameters
| Name | Type | In | Required | Description |
|---|---|---|---|---|
| search | string | query | Required | The keyword or phrase to search for. |
| from | string | query | Optional | The starting point (page number) for the query used for pagination. The default value is 1. |
| limit | string | query | Optional | The number of results to be returned in the response. The default value is 10. |
| edition_id | string | path | Required | The unique ID of the edition |
| team_id | string | path | Required | The unique ID of the team associated with the edition. |
Responses
200
success
200
no match found
success - Response
{
"data": {
"search_result": [
{
"zone_id": "865efd0a-9b1b-418c-a894-82b63417063f",
"space_name": "New Space",
"zone_name": "duplicate zone with template1",
"space_id": "693000000603451",
"uri": "/vani/api/v1/editions/75918186/spaces/693000000603451/zones?action_type=GET_SPACE_DATA_WITH_ZONE_DATA&zone_id=865efd0a-9b1b-418c-a894-82b63417063f"
},
{
"zone_id": "ea2f15ae-4e53-49f1-ad1e-e30eae16f31b",
"space_name": "New Space",
"zone_name": "Zone 1",
"space_id": "693000000603389",
"uri": "/vani/api/v1/editions/75918186/spaces/693000000603389/zones?action_type=GET_SPACE_DATA_WITH_ZONE_DATA&zone_id=ea2f15ae-4e53-49f1-ad1e-e30eae16f31b"
},
{
"zone_id": "09a45216-f714-4d96-aa78-e857738060c6",
"space_name": "New Space",
"zone_name": "Zone 1",
"space_id": "693000000603293",
"uri": "/vani/api/v1/editions/75918186/spaces/693000000603293/zones?action_type=GET_SPACE_DATA_WITH_ZONE_DATA&zone_id=09a45216-f714-4d96-aa78-e857738060c6"
},
{
"zone_id": "6a392f16-55ab-417d-8170-d8f1b6e17148",
"space_name": "New Space test",
"zone_name": "Zone 1",
"space_id": "693000000603341",
"uri": "/vani/api/v1/editions/75918186/spaces/693000000603341/zones?action_type=GET_SPACE_DATA_WITH_ZONE_DATA&zone_id=6a392f16-55ab-417d-8170-d8f1b6e17148"
},
{
"zone_id": "2da6aa5e-8a20-4d6a-955a-e97fc4b2bd9f",
"space_name": "New Space test",
"zone_name": "Zone 1",
"space_id": "693000000599045",
"uri": "/vani/api/v1/editions/75918186/spaces/693000000599045/zones?action_type=GET_SPACE_DATA_WITH_ZONE_DATA&zone_id=2da6aa5e-8a20-4d6a-955a-e97fc4b2bd9f"
},
{
"zone_id": "ea5e020b-4e3b-4e5d-8229-b38c5f8a3084",
"space_name": "duplicate zone b",
"zone_name": "duplicate zone",
"space_id": "693000000562297",
"uri": "/vani/api/v1/editions/75918186/spaces/693000000562297/zones?action_type=GET_SPACE_DATA_WITH_ZONE_DATA&zone_id=ea5e020b-4e3b-4e5d-8229-b38c5f8a3084"
},
{
"zone_id": "9a853213-9f1a-488d-bbcf-9efcb3e2d419",
"space_name": "duplicate zone b",
"zone_name": "duplicate zone",
"space_id": "693000000562297",
"uri": "/vani/api/v1/editions/75918186/spaces/693000000562297/zones?action_type=GET_SPACE_DATA_WITH_ZONE_DATA&zone_id=9a853213-9f1a-488d-bbcf-9efcb3e2d419"
},
{
"zone_id": "64d56703-7071-4670-8153-33819171239f",
"space_name": "duplicate zone b",
"zone_name": "Copy of duplicate zone with template1",
"space_id": "693000000562297",
"uri": "/vani/api/v1/editions/75918186/spaces/693000000562297/zones?action_type=GET_SPACE_DATA_WITH_ZONE_DATA&zone_id=64d56703-7071-4670-8153-33819171239f"
},
{
"zone_id": "cfcdde4d-13dc-4148-b5e4-a8adb64195a9",
"space_name": "New Space",
"zone_name": "duplicate zone with template1",
"space_id": "693000000573098",
"uri": "/vani/api/v1/editions/75918186/spaces/693000000573098/zones?action_type=GET_SPACE_DATA_WITH_ZONE_DATA&zone_id=cfcdde4d-13dc-4148-b5e4-a8adb64195a9"
},
{
"zone_id": "6b6f718a-300d-4f8e-b9e8-ff53426d8874",
"space_name": "MOVE",
"zone_name": "Copy(2) of duplicate zone with template1",
"space_id": "693000000569219",
"uri": "/vani/api/v1/editions/75918186/spaces/693000000569219/zones?action_type=GET_SPACE_DATA_WITH_ZONE_DATA&zone_id=6b6f718a-300d-4f8e-b9e8-ff53426d8874"
}
]
},
"message": "Content search completed successfully",
"request_uri": "/vani/api/v1/editions/75918186/teams/693000000435005/zones/search",
"status": "success"
}
Code Examples
cURL
Command line HTTP client
cURL
curl -X GET "https://api.app.vanihq.com/vani/api/v1/editions/{edition_id}/teams/{team_id}/spaces/search" \
-H "Authorization: Bearer YOUR_ACCESS_TOKEN" \
-H "Content-Type: application/json"
GET Frame Search
GET https://api.app.vanihq.com/vani/api/v1/editions/{edition_id}/teams/{team_id}/frames/search
Searches specifically within frames and their associated content and returns matching frames with relevant metadata.
Parameters
| Name | Type | In | Required | Description |
|---|---|---|---|---|
| search | string | query | Required | Keyword to search within frames and their associated content. |
| from | string | query | Optional | The starting point (page number) for the query used for pagination. The default value is 1. |
| limit | string | query | Optional | The number of results to be returned in the response. The default value is 10. |
| edition_id | string | path | Required | The unique ID of the edition. |
| team_id | string | path | Required | The unique ID of the team associated with the edition. |
Responses
200
success
200
no match found
success - Response
{
"data": {
"search_result": [
{
"frame_name": "Content/Technical Writing & Brand Marketing",
"zone_id": "6ac7327e-19ea-441c-aeb8-7ed2689d9aa4",
"space_name": "Vani - Getting Started",
"zone_name": "Who can use Vani?",
"space_id": "3009000000002013",
"uri": "/vani/api/v1/editions/96499735/spaces/3009000000002013/zones?action_type=GET_SPACE_DATA_WITH_ZONE_DATA&zone_id=6ac7327e-19ea-441c-aeb8-7ed2689d9aa4",
"frame_id": "8F6541AF-A759-4FBF-9912-A3A73DEAEA33"
},
{
"frame_name": "Product Management",
"zone_id": "6ac7327e-19ea-441c-aeb8-7ed2689d9aa4",
"space_name": "Vani - Getting Started",
"zone_name": "Who can use Vani?",
"space_id": "3009000000002013",
"uri": "/vani/api/v1/editions/96499735/spaces/3009000000002013/zones?action_type=GET_SPACE_DATA_WITH_ZONE_DATA&zone_id=6ac7327e-19ea-441c-aeb8-7ed2689d9aa4",
"frame_id": "05752704-A388-4EDC-B089-4E0372EC4552"
},
{
"frame_name": "Team onboarding",
"zone_id": "6ac7327e-19ea-441c-aeb8-7ed2689d9aa4",
"space_name": "Vani - Getting Started",
"zone_name": "Who can use Vani?",
"space_id": "3009000000002013",
"uri": "/vani/api/v1/editions/96499735/spaces/3009000000002013/zones?action_type=GET_SPACE_DATA_WITH_ZONE_DATA&zone_id=6ac7327e-19ea-441c-aeb8-7ed2689d9aa4",
"frame_id": "08C5C1E6-3F2B-410F-8C2B-F5E8DA2E26AA"
},
{
"frame_name": "Engineering/Development",
"zone_id": "6ac7327e-19ea-441c-aeb8-7ed2689d9aa4",
"space_name": "Vani - Getting Started",
"zone_name": "Who can use Vani?",
"space_id": "3009000000002013",
"uri": "/vani/api/v1/editions/96499735/spaces/3009000000002013/zones?action_type=GET_SPACE_DATA_WITH_ZONE_DATA&zone_id=6ac7327e-19ea-441c-aeb8-7ed2689d9aa4",
"frame_id": "F361DC68-C12D-4FF0-95AF-A8CF0519C7DD"
},
{
"frame_name": "Design",
"zone_id": "6ac7327e-19ea-441c-aeb8-7ed2689d9aa4",
"space_name": "Vani - Getting Started",
"zone_name": "Who can use Vani?",
"space_id": "3009000000002013",
"uri": "/vani/api/v1/editions/96499735/spaces/3009000000002013/zones?action_type=GET_SPACE_DATA_WITH_ZONE_DATA&zone_id=6ac7327e-19ea-441c-aeb8-7ed2689d9aa4",
"frame_id": "2DE1E10D-EF27-4874-A9E7-15FD434AFC01"
},
{
"frame_name": "Product Marketing",
"zone_id": "6ac7327e-19ea-441c-aeb8-7ed2689d9aa4",
"space_name": "Vani - Getting Started",
"zone_name": "Who can use Vani?",
"space_id": "3009000000002013",
"uri": "/vani/api/v1/editions/96499735/spaces/3009000000002013/zones?action_type=GET_SPACE_DATA_WITH_ZONE_DATA&zone_id=6ac7327e-19ea-441c-aeb8-7ed2689d9aa4",
"frame_id": "EF5A9085-BA1C-4915-BF06-4BBCB37E2386"
},
{
"frame_name": "Pins",
"zone_id": "f3dd023d-6a37-4237-9740-183c8041c2f2",
"space_name": "Vani - Getting Started",
"zone_name": "FAQs",
"space_id": "3009000000002013",
"uri": "/vani/api/v1/editions/96499735/spaces/3009000000002013/zones?action_type=GET_SPACE_DATA_WITH_ZONE_DATA&zone_id=f3dd023d-6a37-4237-9740-183c8041c2f2",
"frame_id": "13188A26-7AC3-49D1-A763-69A4AF710071"
},
{
"frame_name": "Mouse Navigation",
"zone_id": "f3dd023d-6a37-4237-9740-183c8041c2f2",
"space_name": "Vani - Getting Started",
"zone_name": "FAQs",
"space_id": "3009000000002013",
"uri": "/vani/api/v1/editions/96499735/spaces/3009000000002013/zones?action_type=GET_SPACE_DATA_WITH_ZONE_DATA&zone_id=f3dd023d-6a37-4237-9740-183c8041c2f2",
"frame_id": "659A0F55-6B2B-4259-BE4A-DD49A71BB75E"
},
{
"frame_name": "Hyperlinks",
"zone_id": "f3dd023d-6a37-4237-9740-183c8041c2f2",
"space_name": "Vani - Getting Started",
"zone_name": "FAQs",
"space_id": "3009000000002013",
"uri": "/vani/api/v1/editions/96499735/spaces/3009000000002013/zones?action_type=GET_SPACE_DATA_WITH_ZONE_DATA&zone_id=f3dd023d-6a37-4237-9740-183c8041c2f2",
"frame_id": "F08026FB-2CAC-457F-BB63-C916EAB745B8"
},
{
"frame_name": "Navigating with Spacemate",
"zone_id": "f3dd023d-6a37-4237-9740-183c8041c2f2",
"space_name": "Vani - Getting Started",
"zone_name": "FAQs",
"space_id": "3009000000002013",
"uri": "/vani/api/v1/editions/96499735/spaces/3009000000002013/zones?action_type=GET_SPACE_DATA_WITH_ZONE_DATA&zone_id=f3dd023d-6a37-4237-9740-183c8041c2f2",
"frame_id": "C5270404-5149-461B-9F7C-7FD6259900EE"
}
]
},
"message": "Content search completed successfully",
"request_uri": "/vani/api/v1/editions/96499735/teams/3009000000002003/frames/search",
"status": "success"
}
Code Examples
cURL
Command line HTTP client
cURL
curl -X GET "https://api.app.vanihq.com/vani/api/v1/editions/{edition_id}/teams/{team_id}/frames/search" \
-H "Authorization: Bearer YOUR_ACCESS_TOKEN" \
-H "Content-Type: application/json"
GET Comment Search
GET https://api.app.vanihq.com/vani/api/v1/editions/{edition_id}/teams/{team_id}/comments/search
Searches user comments in the specified team and returns matching comments and related content.
Parameters
| Name | Type | In | Required | Description |
|---|---|---|---|---|
| search | string | query | Required | Search query used to search within comments |
| from | string | query | Optional | The starting point (page number) for the query used for pagination. The default value is 1. |
| limit | string | query | Optional | The number of results to be returned in the response. The default value is 10. |
| edition_id | string | path | Required | The unique ID of the edition |
| team_id | string | path | Required | The unique ID of the team associated with the edition. |
Responses
200
success
200
no match found
success - Response
{
"data": {
"search_result": [
{
"zone_id": "db069372-0246-42e8-a049-bdcbd84b292c",
"space_name": "test duplicate project",
"comment_id": "551335F3-BD3E-415A-95DC-74F241507E75",
"space_id": "3009000000303003",
"uri": "/vani/api/v1/editions/96499735/spaces/3009000000303003/zones?action_type=GET_SPACE_DATA_WITH_ZONE_DATA&zone_id=db069372-0246-42e8-a049-bdcbd84b292c"
}
]
},
"message": "Content search completed successfully",
"request_uri": "/vani/api/v1/editions/96499735/teams/3009000000002003/comments/search",
"status": "success"
}
Code Examples
cURL
Command line HTTP client
cURL
curl -X GET "https://api.app.vanihq.com/vani/api/v1/editions/{edition_id}/teams/{team_id}/comments/search" \
-H "Authorization: Bearer YOUR_ACCESS_TOKEN" \
-H "Content-Type: application/json"
GET Org Member Search
GET https://api.app.vanihq.com/vani/api/v1/editions/{edition_id}/members/search
Searches for organization members in a specific edition.
Parameters
| Name | Type | In | Required | Description |
|---|---|---|---|---|
| search | string | query | Required | To search for organization members in a specific edition. |
| edition_id | string | path | Required | The unique ID of the edition |
Responses
200
success
200
pagination
200
using fields
200
no match found
403
NOT AN ORG EDITION
success - Response
{
"data": {
"search_result": [
{
"mail_id": "test3@zohotest.com",
"display_name": "test",
"zuid": "81479212"
},
{
"mail_id": "test2@zohotest.com",
"display_name": "test",
"zuid": "96384499"
},
{
"mail_id": "admintest@zohotest.com",
"display_name": "testadmin",
"zuid": "80585905"
}
]
},
"message": "Edition member search completed successfully",
"request_uri": "/vani/api/v1/editions/75918186/members/search",
"status": "success"
}
Code Examples
cURL
Command line HTTP client
cURL
curl -X GET "https://api.app.vanihq.com/vani/api/v1/editions/{edition_id}/members/search" \
-H "Authorization: Bearer YOUR_ACCESS_TOKEN" \
-H "Content-Type: application/json"
GET Team Member Search
GET https://api.app.vanihq.com/vani/api/v1/editions/{edition_id}/teams/{team_id}/members/search
Searches for team members in a specific edition.
Parameters
| Name | Type | In | Required | Description |
|---|---|---|---|---|
| from | string | query | Optional | Specifies the starting point (offset) from where to begin retrieving members. The default value is 0. |
| limit | string | query | Optional | Defines the maximum number of members to include in the response. |
| search | string | query | Required | To search for team members in a specific edition. |
| edition_id | string | path | Required | The unique ID of the edition |
| team_id | string | path | Required | The unique ID of the team associated with the edition. |
Responses
200
success
200
no match found
404
team not found
200
Pagination
200
using fields and pagination
401
unauthorized
success - Response
{
"data": {
"search_result": [
{
"role_name": "MEMBER",
"added_time": "Fri, 27 Sep 2024, 15:01:26",
"modified_time": "Fri, 27 Sep 2024, 15:01:26",
"mail_id": "ash@boxible.co",
"added_by": "60029267674",
"display_name": "Ash Lee",
"zuid": "60031564451"
}
]
},
"message": "Team member search completed successfully",
"request_uri": "/vani/api/v1/editions/60029715808/teams/1303000000002003/members/search",
"status": "success"
}
Code Examples
cURL
Command line HTTP client
cURL
curl -X GET "https://api.app.vanihq.com/vani/api/v1/editions/{edition_id}/teams/{team_id}/members/search" \
-H "Authorization: Bearer YOUR_ACCESS_TOKEN" \
-H "Content-Type: application/json"