Twenty icon

Twenty

Interact with the Twenty API

Actions25

Core Schema → Get OpenAPI Spec

AI-generated

Overview

This node interacts with the Twenty API, specifically supporting operations related to the Core Schema resource, including retrieving the OpenAPI specification. It is useful for automating and integrating workflows with the Twenty platform, such as fetching API schema details for dynamic API exploration or documentation purposes.

Use Case Examples

  1. Fetching the OpenAPI specification of the Twenty API to dynamically generate API clients or documentation.
  2. Integrating with the Twenty platform to automate data retrieval and manipulation based on the API schema.

Properties

Name Meaning
Base URL The base URL for the Twenty workspace REST API, including the /rest suffix, e.g., https://your-workspace.twenty.com/rest.
Request Options Settings to customize the HTTP request behavior, including batching, SSL certificate validation, proxy configuration, and timeout settings.

Output

JSON

  • openApiSpec - The OpenAPI specification retrieved from the Twenty API, describing the API schema and available endpoints.

Dependencies

  • Requires an API key credential for authentication with the Twenty API.

Troubleshooting

  • Ensure the Base URL is correctly set to your Twenty workspace REST API endpoint including the /rest suffix.
  • If SSL certificate validation fails, consider enabling the 'Ignore SSL Issues' option, but be aware of security risks.
  • Check proxy settings if requests fail due to network restrictions.
  • Adjust timeout settings if the server response is slow to avoid premature request abortion.
  • Common errors include authentication failures due to invalid API keys and network errors due to incorrect Base URL or proxy settings.

Discussion