Skip to main content
GET
/
api
/
v1
/
tools
List available tools
curl --request GET \
  --url https://flowra.dev/api/v1/tools \
  --header 'x-api-key: <api-key>'
{
  "success": true,
  "message": "Data retrieved successfully",
  "data": "<array>",
  "total": 100,
  "page": 1,
  "limit": 20,
  "totalPages": 5,
  "hasNextPage": true,
  "hasPreviousPage": false
}

Authorizations

​
x-api-key
string
header
required

Project API key. Create and manage keys in the dashboard under Project → API Keys. Send as header: x-api-key:

Query Parameters

​
q
string

Search keyword for filtering results

Example:

"john doe"

​
page
number
default:1

Page number (1-based)

Required range: x >= 1
Example:

1

​
limit
number
default:20

Number of items per page

Required range: 1 <= x <= 100
Example:

20

​
offset
number

Number of items to skip (for offset-based pagination)

Required range: x >= 0
Example:

0

​
sortBy
string

Field name to sort by

Example:

"createdAt"

​
sortOrder
enum<string>
default:DESC

Sort order

Available options:
ASC,
DESC
Example:

"DESC"

​
fields
string

Comma-separated list of fields to include in response

Example:

"id,name,email"

​
selectedToolSlugs
string

Comma-separated selected tool slugs for sort-order (e.g. put toolkits with these tools first)

Example:

"tool_a,tool_b"

​
provider
enum<string>

Filter tools by provider

Available options:
COMPOSIO,
LOCAL
Example:

"LOCAL"

​
toolkitSlug
string

The slug of the toolkit to filter by

Example:

"slack"

​
toolSlugs
string

Comma-separated list of specific tool slugs to retrieve (overrides other filters)

Example:

"slack_send_message,slack_get_channels"

​
authConfigIds
string

Comma-separated list of auth config IDs to filter tools by

Example:

"auth_config_1,auth_config_2"

​
important
enum<string>

Filter to only show important/featured tools (set to "true" to enable)

Available options:
true,
false
Example:

"true"

​
tags
string

Filter tools by one or more tags (can be specified multiple times)

Example:

"productivity,communication"

​
scopes
string

Array of scopes to filter tools by

Example:

"read,write,admin"

​
includeDeprecated
boolean
default:false

Include deprecated tools in the response

Example:

false

​
toolkitVersions
string

Toolkit version specification. Use "latest" for latest versions or bracket notation for specific versions per toolkit.

Example:

"latest"

​
cursor
string

Cursor for pagination. The cursor is a base64 encoded string of the page and limit.

Example:

"eyJwYWdlIjoxLCJsaW1pdCI6MjB9"

Response

200 - application/json

Tools retrieved successfully