RESTful API

DeepSyque API Documentation

Integrate personality assessment into your applications. Build team tools, career platforms, or enterprise HR systems with our comprehensive API.

Get Started Authentication

Features

RESTful API

Simple, predictable REST endpoints for assessment, teams, and enterprise features.

Team Management

Create teams, invite members, and analyze team personality dynamics.

Integrations

Connect with Slack, Lark, Notion, and other popular platforms.

Enterprise SSO

SAML 2.0, OIDC, and OAuth 2.0 support for enterprise authentication.

Audit Logs

Complete audit trail for compliance and security monitoring.

Real-time Results

Instant personality profile calculations with detailed insights.

Getting Started

Step 1

Base URL

All API requests should be made to the following base URL:

Production: https://deepsyque.com/api
Development: http://localhost:3000/api

text

Step 2

Content Type

All request bodies should be JSON with the appropriate content type:

Content-Type: application/json

text

API Reference

Team Management Endpoints

POST/api/teams/createAuth

Create Team

Create a new team with the specified name and owner.

Request Body

{
  "name": "Engineering Team",
  "description": "Core engineering department",
  "ownerId": "user_123"
}

json

Response

{
  "success": true,
  "team": {
    "id": "team_abc123",
    "name": "Engineering Team",
    "inviteCode": "ENG-2024-X8K2",
    "createdAt": "2025-01-15T10:30:00Z"
  }
}

json

POST/api/teams/inviteAuth

Invite Team Member

Send an invitation to join a team via email.

Request Body

{
  "teamId": "team_abc123",
  "email": "colleague@company.com",
  "role": "member"
}

json

Response

{
  "success": true,
  "invite": {
    "id": "inv_123",
    "email": "colleague@company.com",
    "token": "inv_xyz...",
    "expiresAt": "2025-01-22T10:30:00Z"
  }
}

json

POST/api/teams/join

Join Team

Join a team using an invite code.

Request Body

{
  "code": "ENG-2024-X8K2",
  "userId": "user_456",
  "name": "Alex Chen",
  "email": "alex@company.com"
}

json

Response

{
  "success": true,
  "membership": {
    "teamId": "team_abc123",
    "teamName": "Engineering Team",
    "role": "member",
    "joinedAt": "2025-01-15T11:00:00Z"
  }
}

json

GET/api/teams/{id}Auth

Get Team Details

Retrieve team details including members and aggregate scores.

Response

{
  "success": true,
  "team": {
    "id": "team_abc123",
    "name": "Engineering Team",
    "members": [
      { "name": "Alex", "archetype": "Systems Challenger" }
    ],
    "aggregateScores": {
      "cognitive": 78,
      "executive": 52,
      "technical": 71
    }
  }
}

json

GET/api/teams/{id}/insightsAuth

Get Team Insights

Get comprehensive team personality analysis and recommendations.

Response

{
  "success": true,
  "insights": {
    "archetypeDistribution": { "Systems Challenger": 2 },
    "strengths": [
      { "domain": "Cognitive", "score": 78 }
    ],
    "growthAreas": [
      { "domain": "Executive", "score": 45 }
    ],
    "hiringRecommendations": [
      { "recommendedArchetype": "Strategic Driver" }
    ]
  }
}

json

Rate Limits

Endpoint	Limit	Window
/api/teams/*	100 requests	per minute
/api/integrations/*	50 requests	per minute
/api/enterprise/*	100 requests	per minute
/api/assessment/*	100 requests	per minute
/api/auth/magic-link	5 requests	per hour

Ready to Build?

API access is available for teams and enterprises. Contact us to get started.

Request API Access Try Teams Feature