Get All Tools

GET

/v2/api/organization/{organization_id}/tool

Overview

The Get All Tools endpoint retrieves a list of all tools associated with a specified organization.
This is helpful for clients or administrators who want to view and manage tools that belong to a particular organization.
It supports pagination and provides metadata such as total count and page information for efficient result handling.

Functionality

Accepts organization_id as a path parameter to identify the organization whose tools are to be fetched.

Returns a paginated list of tools associated with the provided organization.

Each tool in the list includes complete metadata, such as:

Tool ID, name, and description

Organization ID

Type of the tool (e.g., API, UI)

Creator’s email address

Tool status indicators: enabled, default, and connection state

Request Example

Shell

JavaScript

Java

Swift

curl --location -g --request GET 'https:///v2/api/organization/1/tool' \
--header 'Ocp-Apim-Subscription-Key: ' \
--header 'Authorization: Bearer '

Response Example

200 - Example 1

{
    "success": true,
    "message": "Tools found successfully.",
    "data": {
        "count": 27,
        "num_pages": 1,
        "current_page": 1,
        "tools": [
            {
                "id": 58,
                "name": "test tool API",
                "description": "",
                "org": 1,
                "tool_type": "api",
                "created_by": "yumna@example.com",
                "is_enabled": true,
                "is_default": false,
                "connection": false
            }
        ]
    }
}

Request

Path Params

Header Params

Responses

🟢200OK

application/json

Successfully retrieved all tools for the specified organization.

Body

🟠400Bad Request

🟠404Record Not Found

🔴500Server Error

Create Tool

Get Tool

Get All Tools

Overview#

Functionality#

Request

Responses

Overview

Functionality