SuperAI Flow Platform

Sections

Theme switcher

Get credential by ID

Retrieve metadata for a specific integration credential.

Returns credential metadata without sensitive data. Use this endpoint to check credential status, provider type, and creation date without exposing passwords or tokens.

Context: This endpoint provides safe access to credential information for UI display and validation purposes. Common use cases include: - Displaying credential details in integration settings pages - Verifying credential ownership before performing operations - Checking credential type before initiating provider-specific workflows - Validating credential exists before attempting to use it in tasks

Use Cases: Verify credential exists and belongs to current user before displaying integration UI.

Check credential type to determine which configuration UI to show (password vs OAuth).

Display credential creation date in integration settings for audit purposes.

Related Endpoints: - GET /integrations/credentials - List all user credentials - GET /integrations/credentials/{credential_id}/credentials - Get credential secrets (service accounts only) - PATCH /integrations/credentials/{credential_id} - Update credential - DELETE /integrations/credentials/{credential_id} - Delete credential

Notes: - This endpoint is safe for UI use (no sensitive data exposure) - Soft-deleted credentials return 404 - OAuth credentials include token expiration metadata

Header Parameters

Authorizationstring

Path Parameters

credential_idstring Required

UUID of the credential to retrieve. Must belong to the authenticated user's organization.

Response

200
Object
Credential metadata retrieved successfully

Response Attributes

created_atstring Required
google_emailnull
idstring Required
modified_bystring Required
providerstring Required

API-friendly version of ProviderEnum without spaces

Enum values:
microsoftsharepointsftpaws_sesgooglepostgresqlinternal_postgresql
updated_atstring Required
user_idnull
400
Object
Invalid credential ID

Response Attributes

errorobject Required

Standard error detail structure.

This model matches the error format returned by the centralized exception handlers in app/api/errors/handlers.py.

Show child attributes

request_idnull
401
Object
Unauthorized - Missing or invalid authentication credentials

Response Attributes

errorobject Required

Standard error detail structure.

This model matches the error format returned by the centralized exception handlers in app/api/errors/handlers.py.

Show child attributes

request_idnull
403
Object
Forbidden - Insufficient permissions to access this resource

Response Attributes

errorobject Required

Standard error detail structure.

This model matches the error format returned by the centralized exception handlers in app/api/errors/handlers.py.

Show child attributes

request_idnull
404
Object
Credential not found

Response Attributes

errorobject Required

Standard error detail structure.

This model matches the error format returned by the centralized exception handlers in app/api/errors/handlers.py.

Show child attributes

request_idnull
422
Object
Validation Error

Response Attributes

detailarray

Show child attributes

500
Object
Internal Server Error - An unexpected error occurred

Response Attributes

errorobject Required

Standard error detail structure.

This model matches the error format returned by the centralized exception handlers in app/api/errors/handlers.py.

Show child attributes

request_idnull
Was this section helpful?

What made this section unhelpful for you?

GET

/

Select
1

Response

Was this section helpful?

What made this section unhelpful for you?

View as Markdown

Ask an AI

Open in ChatGPTOpen in ClaudeOpen in Perplexity

Code with AI

Open in Copilot