Skip to main content

Getting started with the Dashboard API

Welcome to the DeePsy API v1 documentation! DeePsy is a comprehensive psychology and mental health platform that empowers organizations to conduct professional psychological assessments, manage recruitment campaigns, and generate detailed candidate reports.

What is DeePsy API?​

The DeePsy API v1 provides programmatic access to our psychology platform, enabling seamless integration with your existing systems. Our API covers:

  • Company Management: Multi-company support with granular permission systems
  • User Administration: Profile management, invitations, and role-based access control
  • Campaign Management: Create and manage assessment campaigns for candidate evaluation
  • Candidate Assessment: Psychological testing, test unlocking, and detailed reporting
  • Analytics & Reporting: Generate PDF reports and access detailed assessment data
  • White Label Solutions: Custom branding and logo management for client-facing materials
  • Asset Management: Upload and manage campaign-related assets and resources

Getting Started​

Ready to start using the DeePsy API? Follow our step-by-step guide:

Quick Start Guide - Complete setup from account creation to your first API calls

This guide covers everything you need:

  • Prerequisites and account setup
  • API key creation and authorization
  • Authentication setup
  • Your first API calls with examples
  • Understanding API responses and error handling

Core Concepts​

The API is built around a few key concepts:

  • Companies: Organizations using DeePsy for assessments
  • Campaigns: Assessment projects within a company
  • Candidates: Individuals taking psychological assessments
  • Permissions: Granular access control system

For detailed explanations and permission system documentation, see our Permissions Guide.

Authentication​

All API endpoints require authentication using an API key:

Authorization: Bearer deepsy-dev-your-api-key-here

For complete authentication setup instructions, see our Authentication Guide.

Base URL​

All API requests should be made to:

https://deepsy.fr/api/v1

Example Use Cases​

HR & Recruitment​

  • Candidate Screening: Create campaigns for job applicants
  • Bulk Assessment: Invite multiple candidates to assessment campaigns
  • Report Generation: Generate PDF reports for hiring decisions
  • Progress Tracking: Monitor candidate completion rates

Psychology Practice​

  • Client Assessment: Manage individual client psychological evaluations
  • Practice Management: Organize assessments by client or assessment type
  • Report Delivery: Generate and deliver professional assessment reports
  • Data Analysis: Access detailed assessment data for research

Enterprise Integration​

  • HRIS Integration: Connect DeePsy with existing HR systems
  • Automated Workflows: Trigger assessments based on application status
  • Data Synchronization: Keep candidate data synchronized across systems
  • Custom Reporting: Build custom dashboards and analytics

Support​

Ready to get started? Begin with our Quick Start Guide for hands-on examples, or explore the Dashboard API Reference for complete endpoint documentation.