Fivetran REST API Reference
The Fivetran REST API Reference provides documentation for all Fivetran REST API endpoints, auto-generated from our OpenAPI definition. Use it to:
- Explore API fields, data types, and definitions.
- Copy code snippets in multiple languages.
- Review response codes and example responses.
Learn more about OpenAPI in the OpenAPI specification.
We recommend using the API Reference along with the Fivetran REST API Postman collection. The Postman collection helps you try requests quickly without building them from scratch.
Available resources
| Resource | Description |
|---|---|
| Account | Manage account-level settings and information. |
| Certificates | Manage SSL/TLS certificates for secure connections. |
| Connection | Create, configure, and manage connections. |
| Connection Schema | Configure which schemas, tables, and columns are synced. |
| Connector Metadata | Retrieve static metadata about connector types, including supported features and configuration schemas. |
| Connector SDK Package | Manage custom connector packages for the Fivetran Connector SDK. |
| Destination | Create and manage destinations. |
| Group | Manage groups that organize connections and destinations. |
| Hub Registrations | Register a hub with your Fivetran account. |
| Hybrid Deployment Agent | Manage agents for hybrid deployment configurations. |
| Log Service | Create and manage external log services for groups and accounts. |
| Private Link | Manage private network links for secure connectivity. |
| Proxy Agent | Manage proxy agents for network routing. |
| Public Endpoint | Discover all available Fivetran connectors, their display names, icons, supported features, and links to documentation. |
| Role | Retrieve available roles and their permissions. |
| System Key | Manage system keys within your Fivetran account. |
| Team | Manage teams and their access to resources. |
| Transformation | Create, run, and manage individual transformations. |
| Transformation Project | Manage transformation projects. |
| User | Manage user accounts and their access. |
| Webhooks | Configure webhooks to receive event notifications. |