REST API

Platform management and system-level operations.

The Flowtig REST API provides access to platform-level functionality that is shared across the entire Flowtig ecosystem.

Unlike the GraphQL API, which focuses on business applications and tenant-specific data, the REST API is primarily responsible for authentication, administration and infrastructure-related operations.

Platform API

REST endpoints are designed for system-wide operations rather than application-specific business logic.

When should I use the REST API?

Use the REST API whenever you need to interact with the Flowtig platform itself rather than an individual application.

Typical examples include:

Authentication
Organisation management
User administration
Subscription management
Billing
Platform configuration

If you're building features inside applications such as Invoices, Contacts or Warehouse, you will typically work with the GraphQL API instead.

Typical Responsibilities

The REST API manages platform-wide resources including:

Organisations
Users
Team memberships
Roles
Permissions
Subscription plans
Service bookings

These resources exist independently of any individual business application.

Authentication

REST endpoints are protected using token-based authentication.

Every request is evaluated within the organisational context of the authenticated user.

Platform-wide permission checks are performed before access is granted.

Learn more about the overall security model in the Architecture documentation.

API Documentation

The complete OpenAPI specification, including endpoint descriptions, request examples and response schemas, is available through the interactive API documentation.

👉 https://api.flowtig.com/api/doc/swagger-ui/

The Swagger interface allows you to:

Browse all available endpoints
Inspect request and response schemas
Execute test requests
Explore authentication requirements

Depending on what you're building, these guides may also be helpful:

Need help?

If you have questions about integrating with the Flowtig platform, please contact us through the official support page:

👉 https://flowtig.com/contact