Overview

The Synapse v1 API is a comprehensive RESTful service for managing organizational structures, user authentication, team and project management, task creation, invitation workflows, and skill verification. Built with the Gin framework in Go, it provides a robust foundation for team collaboration and project management systems.


Common Elements

Base URL

All endpoints are prefixed with:

/api/v1

Authentication

Protected endpoints require a JSON Web Token (JWT) in the Authorization header:

Authorization: Bearer <JWT_TOKEN>

Tokens are obtained via the POST /auth/login or POST /invitations/accept endpoints and remain valid for the duration specified in the server configuration.

JWT Payload Claims

Claim Type Description
user_id number Unique identifier of the authenticated user
role string User role: admin, manager, or engineer
team_id number ID of the team the user belongs to (null for unassigned users)
exp number Token expiration timestamp (Unix epoch)
iat number Token issued at timestamp (Unix epoch)

Authorization Levels

Error Response Format

All error responses follow a consistent JSON structure: