v1

latestOpenAPI 3.0.12026-07-226992320.0 KB

Integration Tools

List Tools

Returns a paginated list of tools registered under an integration, sorted by most recently created first. Use the status parameter to filter by tool state. Use page and size to navigate through results.

get/v1/integrations/{integrationId}/tools

Path parameters

integrationIdstring required

Unique identifier of the integration whose tools are to be listed.

Query parameters

statusstring

Filter tools by their current state. Accepted values: 'active', 'inactive'. Omit to return tools in all states.

pageinteger

Zero-based page number to retrieve. Use 0 for the first page. Must be 0 or greater.

sizeinteger

Number of tools to return per page. Must be 1 or greater. Defaults to 10.

Response

pageinteger

Current page number (0-based index). Indicates which page of results is being returned.

sizeinteger

Number of items requested per page. Determines the maximum size of the 'data' list.

totalCountinteger

Total number of records available across all pages. Useful for calculating pagination on the client side.

totalPagesinteger

Total number of pages available based on totalCounts and size. Helps clients understand how many pages exist in total.

hasNextboolean

Indicates whether there is a next page available after the current one. Useful for implementing 'Load More' or next navigation.

hasPreviousboolean

Indicates whether there is a previous page before the current one. Useful for enabling backward navigation.

Example response

{
  "data": [
    {
      "toolId": "tool_X9pLm2Wq8Rt3",
      "integrationId": "intg_AuUKK371Spr5",
      "name": "get_order_details",
      "description": "Fetches order details from Shopify by order ID. Call this tool when you need to retrieve order status, line items, or shipping info.",
      "method": "GET",
      "url": "https://my-store.myshopify.com/admin/api/2024-01/orders/{{orderId}}.json",
      "scope": "local",
      "headers": {
        "customer_name": "Michael",
        "account_id": "ACC-001"
      },
      "queryParams": {
        "customer_name": "Michael",
        "account_id": "ACC-001"
      },
      "bodyParams": {
        "customer_name": "Michael",
        "account_id": "ACC-001"
      },
      "createdAt": "2024-04-20T10:00:00.000Z",
      "updatedAt": "2024-04-21T08:30:00.000Z"
    }
  ],
  "size": 20,
  "totalCount": 125,
  "totalPages": 7,
  "hasNext": true
}