Introduction

Overview of the API v2 and its capabilities.

Welcome!

Welcome to the Guides section of our API documentation! Here, you'll find resources to help you navigate and utilize the core functionalities of our API.

💡

Using the API requires coding knowledge, and while we provide thorough documentation, direct coding support is not available.

What's new with the API v2

Our API v2 is designed to enhance the developer experience and support complex workflows. We recommend migrating to v2 or starting with it if you're a new user.

Key enhancements

• Security: Authenticate with OAuth 2.0 to meet industry security standards.
• Permissions: Define access with a two-tier scope system at both company and credential levels.
• Consistency: Use redesigned endpoints with standardized structures, behaviors, and response objects.
• Pagination: Request datasets in smaller chunks to manage large volumes of data.
• Filtering: Query datasets with parameters to return only the required results.
• New endpoints: Extend integrations with additional endpoints for broader use cases.
• Bulk operations: Execute multiple actions in a single request.
• Documentation: Access auto-generated reference docs that remain current with every change.

Quick start

Ready to dive in? Follow these steps to get started:

1. Make your first API call: Use our Getting started guide to obtain API credentials, understand the basics of using our API, and make your first requests.
   • 💡 Please note that only platform owners and platform admins have the necessary permissions to create API credentials in the first step of the Getting started guide. If you're not a platform admin, please share this page with one to request the creation of your API v2 credentials.
2. Review scopes and permissions: Ensure your application has the necessary permissions by reviewing the available scopes.
3. Explore the full documentation:
   • Check the API reference for complete details on all available endpoints and their parameters.
   • Visit the Guides section for detailed instructions on each feature, including Authentication, Scopes and permissions, Pagination, and Filtering.