API Reference

Welcome to the API Reference section of our documentation. Our APIs are autogenerated and serve as a reference for our clients, partners, and internal teams to interact with our platform programmatically.

API Structure

Our APIs follow a service-based structure, where each endpoint is organized by service name. The general pattern for our endpoints is:

api/v3/{service_name}/{resource_path}

For example, to retrieve project details, you would call:

GET api/v3/workflow/projects/{project_id}

This structure allows for a modular and scalable API design, making it easier to discover and interact with different services across our platform.

Access & Permissions

API access is role-based, meaning that the endpoints and resources available to you depend on your assigned permissions. If you encounter restricted endpoints, it is likely due to insufficient access rights. Please contact your administrator if you believe you should have access to a specific resource.

Key Resources

To get the most out of our API, explore the following resources:

• Access to the Platform – Learn how to authenticate and obtain API credentials.
• API Format (JSON:API) – Understand the structure and conventions of our APIs, which follow the JSON:API standard.
• Error Handling – Guidelines on interpreting error responses and troubleshooting common issues.
• Using our SDK – Simplify API integration with our officially supported SDKs.

For detailed endpoint specifications, refer to the API documentation provided in this section.