Actions252
- Api Keys Actions
- Attachments Actions
- Blocklists Actions
- Calendar Channel Event Associations Actions
- Find Many Calendar Channel Event Associations
- Create One Calendar Channel Event Association
- Create Many Calendar Channel Event Associations
- Find One Calendar Channel Event Association
- Delete One Calendar Channel Event Association
- Update One Calendar Channel Event Association
- Find Calendar Channel Event Association Duplicates
- Companies Actions
- Calendar Channels Actions
- Calendar Event Participants Actions
- Calendar Events Actions
- Connected Accounts Actions
- Favorite Folders Actions
- Favorites Actions
- Message Channel Message Associations Actions
- Find Many Message Channel Message Associations
- Create One Message Channel Message Association
- Create Many Message Channel Message Associations
- Find One Message Channel Message Association
- Delete One Message Channel Message Association
- Update One Message Channel Message Association
- Find Message Channel Message Association Duplicates
- Message Channels Actions
- Message Folders Actions
- View Fields Actions
- Message Participants Actions
- Messages Actions
- Message Threads Actions
- Notes Actions
- Note Targets Actions
- Opportunities Actions
- People Actions
- Tasks Actions
- Task Targets Actions
- Timeline Activities Actions
- View Filter Groups Actions
- View Filters Actions
- View Groups Actions
- Views Actions
- View Sorts Actions
- Webhooks Actions
- Workflow Automated Triggers Actions
- Workflow Runs Actions
- Workflows Actions
- Workflow Versions Actions
- Workspace Members Actions
Overview
This node interacts with the Twenty API to retrieve detailed information about a single API key by its unique identifier. It is useful when you need to fetch specific data about an API key, such as its metadata or related objects, for auditing, management, or integration purposes.
A practical example would be automating the retrieval of API key details in a workflow that manages access control or monitors usage statistics.
Properties
| Name | Meaning |
|---|---|
| Id | The unique identifier of the API key object to retrieve. This is required to specify which API key to find. |
| Depth | Determines how much related nested information to include in the response: |
| - 0: Only the primary API key object information. | |
| - 1: The primary API key plus its directly related objects (no further nesting). | |
| - 2: The primary API key, its directly related objects, and their related objects (two levels of nesting). |
Output
The node outputs a JSON object representing the requested API key. Depending on the Depth property, this JSON may include nested related objects up to two levels deep. The structure typically contains all relevant fields of the API key, such as identifiers, metadata, and any associated entities included based on the depth setting.
No binary data output is indicated.
Dependencies
- Requires an API authentication token credential to connect securely to the Twenty API.
- The node uses the base URL configured via credentials to send requests.
- No additional external dependencies are specified beyond the Twenty API service.
Troubleshooting
Common issues:
- Providing an invalid or non-existent API key
Idwill likely result in an error or empty response. - Incorrect or missing API authentication credentials will cause authorization failures.
- Setting an unsupported
Depthvalue outside the allowed options may lead to unexpected results or errors.
- Providing an invalid or non-existent API key
Error messages:
- Authorization errors indicate problems with the API key credential; verify and update credentials accordingly.
- Not found errors suggest the provided
Iddoes not correspond to any existing API key; double-check the identifier. - Network or timeout errors may require checking connectivity or API service status.
Links and References
- Twenty API Documentation (for detailed API key object schema and related endpoints)
- n8n documentation on API Key Authentication