Skip to main content
GET
/
api
/
v1
/
credentials
List Credentials
curl --request GET \
  --url https://api.example.com/api/v1/credentials
{
  "401": {},
  "403": {},
  "404": {},
  "500": {},
  "id": "<string>",
  "name": "<string>",
  "credentialName": "<string>",
  "encryptedData": "<string>",
  "createdDate": {},
  "updatedDate": {},
  "workspaceId": "<string>"
}
Retrieve all credentials in your workspace. Credentials are used to store API keys and authentication tokens for various integrations.

​
Query Parameters

​
credentialName
string
Filter credentials by credential name (e.g., openAIApi, pineconeApi)

​
Response

​
id
string
Unique identifier for the credential
​
name
string
User-defined name for the credential
​
credentialName
string
Type of credential (e.g., openAIApi, pineconeApi, azureOpenAIApi)
​
encryptedData
string
Encrypted credential data (sensitive fields are encrypted)
​
createdDate
timestamp
When the credential was created
​
updatedDate
timestamp
When the credential was last updated
​
workspaceId
string
ID of the workspace containing this credential

​
Example Request

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

​
Example Request - Filter by Credential Type

curl -X GET \
  'https://your-flowise-instance.com/api/v1/credentials?credentialName=openAIApi' \
  -H 'Authorization: Bearer YOUR_API_KEY'

​
Example Response

[
  {
    "id": "cred-123",
    "name": "My OpenAI Key",
    "credentialName": "openAIApi",
    "encryptedData": "encrypted_string_here",
    "createdDate": "2024-01-15T10:30:00Z",
    "updatedDate": "2024-01-15T10:30:00Z",
    "workspaceId": "workspace-123"
  },
  {
    "id": "cred-456",
    "name": "Pinecone Production",
    "credentialName": "pineconeApi",
    "encryptedData": "encrypted_string_here",
    "createdDate": "2024-01-16T14:20:00Z",
    "updatedDate": "2024-01-16T14:20:00Z",
    "workspaceId": "workspace-123"
  }
]

​
Security Note

Credential values are encrypted at rest. The encryptedData field contains encrypted information and should not be exposed to end users. When using credentials in flows, Flowise automatically decrypts them during execution.

​
Error Responses

​
401
error
Unauthorized - Invalid or missing API key
​
403
error
Forbidden - Insufficient permissions to view credentials
​
404
error
Not Found - Workspace not found
​
500
error
Internal Server Error - Error retrieving credentials

Build docs developers (and LLMs) love

Get started for freeTalk to us