REST API

Automate authorised CrewTango data exchange

Use the JSON REST API to connect employees, projects, tasks, work sessions and other supported resources with an external system.

API and documentation access must be enabled for the company and for the user account performing the integration.

JSON request and response format
JWT access and refresh tokens
OpenAPI Swagger documentation for authorised users
CONFIRMED API RESOURCES

Build an integration around resources implemented in the application

The API is available under the /api path and uses authenticated user access. The exact operations depend on the account permissions and enabled modules.

Employees and users

Work with employee records and account data available to the authorised user.

Projects and tasks

Read or update supported project and task data used to organise work.

Sessions and breaks

Use recorded work sessions and break resources in reporting or settlement workflows.

Clients, locations and schedules

Connect supported operational structures with an external planning or administration process.

Files and approvals

Use available file and approval endpoints where the integration account has the required access.

Swagger / OpenAPI

Inspect current endpoint documentation after the documentation module and user permission have been enabled.

ACCESS AND OPERATION

From account authentication to a maintained integration

Use the same role and permission model that protects data in the CrewTango panel.

1

Enable API access

Agree the individual offer scope and enable API documentation for the company and authorised user.

2

Obtain JWT tokens

Authenticate with the user account to obtain access and refresh tokens; handle 2FA when it is enabled.

3

Synchronise and log

Use stable IDs, validate responses and record enough context to diagnose and safely retry failures.

REST API FAQ

Yes. The application includes Swagger/OpenAPI documentation, available when the company documentation module and the user API-access permission are enabled.

The API login returns JWT access and refresh tokens for an authorised user account. If two-factor authentication is enabled, the login flow also requires its verification step.

No. The current CrewTango version does not expose a general outbound event-webhook mechanism. Integrations should use the REST API and, where needed, a periodic synchronisation process.

Define the API scope before writing the integration

List the resources, direction of exchange and account that should perform it. We will help define a safe first version.