Skip to main content
GET
/
api
/
v1
/
apikey
List API Keys
curl --request GET \
  --url https://api.example.com/api/v1/apikey
{
  "401": {},
  "403": {},
  "500": {},
  "id": "<string>",
  "keyName": "<string>",
  "apiKey": "<string>",
  "permissions": [
    {}
  ],
  "createdDate": {},
  "updatedDate": {},
  "workspaceId": "<string>"
}
Retrieve all API keys in your workspace. API keys are used to authenticate API requests to Flowise.

​
Query Parameters

​
type
string
Filter by key type. Use organization to list organization-level keys (requires admin role)
​
page
number
Page number for pagination. Default: 1
​
limit
number
Number of results per page. Default: 50

​
Response

​
id
string
Unique identifier for the API key
​
keyName
string
User-defined name for the API key
​
apiKey
string
The API key value (only shown once during creation)
​
permissions
array
Array of permission strings granted to this API key
​
createdDate
timestamp
When the API key was created
​
updatedDate
timestamp
When the API key was last updated
​
workspaceId
string
ID of the workspace containing this API key

​
Example Request

curl -X GET \
  'https://your-flowise-instance.com/api/v1/apikey' \
  -H 'Authorization: Bearer YOUR_API_KEY'

​
Example Request - Organization Keys

curl -X GET \
  'https://your-flowise-instance.com/api/v1/apikey?type=organization' \
  -H 'Authorization: Bearer YOUR_API_KEY'

​
Example Response

[
  {
    "id": "key-123",
    "keyName": "Production API Key",
    "apiKey": "fsk_***",
    "permissions": [
      "chatflows:view",
      "chatflows:execute",
      "agentflows:view",
      "agentflows:execute"
    ],
    "createdDate": "2024-01-15T10:30:00Z",
    "updatedDate": "2024-01-15T10:30:00Z",
    "workspaceId": "workspace-123"
  },
  {
    "id": "key-456",
    "keyName": "Development Key",
    "apiKey": "fsk_***",
    "permissions": [
      "chatflows:view",
      "chatflows:create",
      "chatflows:update",
      "chatflows:delete"
    ],
    "createdDate": "2024-01-16T14:20:00Z",
    "updatedDate": "2024-01-16T14:20:00Z",
    "workspaceId": "workspace-123"
  }
]

​
Permission Types

Available permissions include:

​
Chatflows & Agentflows

  • chatflows:view - View chatflows
  • chatflows:create - Create chatflows
  • chatflows:update - Update chatflows
  • chatflows:delete - Delete chatflows
  • chatflows:execute - Execute chatflows
  • agentflows:view - View agentflows
  • agentflows:create - Create agentflows
  • agentflows:update - Update agentflows
  • agentflows:delete - Delete agentflows
  • agentflows:execute - Execute agentflows

​
Resources

  • credentials:view - View credentials
  • credentials:create - Create credentials
  • credentials:update - Update credentials
  • credentials:delete - Delete credentials
  • tools:view - View tools
  • tools:create - Create tools
  • tools:update - Update tools
  • tools:delete - Delete tools
  • documentStores:view - View document stores
  • documentStores:create - Create document stores
  • documentStores:update - Update document stores
  • documentStores:delete - Delete document stores

​
API Keys

  • apikeys:view - View API keys
  • apikeys:create - Create API keys
  • apikeys:update - Update API keys
  • apikeys:delete - Delete API keys

​
Security Note

API key values are only shown in full when created. After creation, they are masked. Store your API keys securely and never commit them to version control.

​
Error Responses

​
401
error
Unauthorized - Invalid or missing authentication
​
403
error
Forbidden - Insufficient permissions to view API keys
​
500
error
Internal Server Error - Error retrieving API keys

Build docs developers (and LLMs) love

Get started for freeTalk to us