Coodesh API (2026.02.12)
Download OpenAPI specification:
The Coodesh API lets you integrate your tools with the Coodesh platform — manage jobs, assessments, candidates, and more programmatically.
Base URL
All API requests are made to:
https://api.coodesh.com
Obtaining an API Key
- Sign in to the Coodesh Dashboard.
- Navigate to Settings → API Keys in your workspace.
- Click Generate new key and copy the value — it will only be shown once.
Each API key is scoped to the workspace that created it.
Quick Example
curl https://api.coodesh.com/v2/jobs \
-H "x-api-key: YOUR_API_KEY"
API Key (x-api-key)
Most endpoints require an API key passed in the x-api-key request header. Keys can be managed in the Coodesh dashboard under workspace settings.
x-api-key: YOUR_API_KEY
Public Endpoints
Some endpoints are publicly accessible and do not require authentication. These are marked with an empty security requirement (security: []).
| Header | Required | Description |
|---|---|---|
x-api-key |
Yes* | API key for authenticated endpoints |
x-workspace-id |
Contextual | Identifies the target workspace |
x-subaccount-id |
Contextual | Identifies the target subaccount |
x-language |
Optional | Locale for content responses (pt, en, es) |
* Required for endpoints that are not marked as public.
Handle
Handle GET validate.
header Parameters
| X-Api-Key required | string API key to validate |
| x-workspace-id | any |
| x-subaccount-id | any |
| x-language | any |
Responses
Response samples
- 200
{- "_id": "507f1f77bcf86cd799439011",
- "name": "Production API Key",
- "last_used": "2024-06-15T10:30:00.000Z",
- "created": "2024-01-10T08:00:00.000Z",
- "provider": "coodesh",
- "company": "Acme Corp",
- "author": "John Doe"
}Reset
Handle POST reset/:token.
path Parameters
| token required | string |
header Parameters
| x-workspace-id | any |
| x-subaccount-id | any |
| x-language | any |
Request Body schema: application/jsonrequired
| newPassword required | string New password for the account |
| confirmPassword required | string Confirm the new password (must match newPassword) |
Responses
Request samples
- Payload
{- "newPassword": "N3wP@ssw0rd!",
- "confirmPassword": "N3wP@ssw0rd!"
}Response samples
- 200
{- "message": "Password has been set successfully",
- "user": {
- "_id": "507f1f77bcf86cd799439011",
- "email": "john.doe@company.com",
- "displayName": "John Doe"
}
}Connect
Handle POST connect.
header Parameters
| x-workspace-id | any |
| x-subaccount-id | any |
| x-language | any |
Request Body schema: application/jsonrequired
| email required | string User email address to check the authentication provider |
Responses
Request samples
- Payload
{- "email": "john.doe@company.com"
}Response samples
- 200
{- "email": "john.doe@company.com",
- "provider": "local",
- "password": true
}Sign In
Handle POST signin.
header Parameters
| x-workspace-id | any |
| x-subaccount-id | any |
| x-language | any |
Request Body schema: application/jsonrequired
| email required | string User email address |
| password required | string User password |
| invite | string Workspace invite token to join a company upon sign in |
Responses
Request samples
- Payload
{- "email": "john.doe@company.com",
- "password": "P@ssw0rd!",
- "invite": "abc123def456"
}Response samples
- 201
{- "token": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiI1MDdmMWY3N2JjZjg2Y2Q3OTk0MzkwMTEiLCJpYXQiOjE3MDkwMDAwMDB9.abc123",
- "user": {
- "_id": "507f1f77bcf86cd799439011",
- "displayName": "John Doe",
- "firstName": "John",
- "lastName": "Doe",
- "email": "john.doe@company.com",
- "roles": "user",
- "username": "john-doe"
}, - "isNew": true,
- "flow": "dashboard",
- "provider": "local"
}
Sign Up
Handle POST signup.
header Parameters
| x-workspace-id | any |
| x-subaccount-id | any |
| x-language | any |
Request Body schema: application/jsonrequired
| email required | string User email address |
| password | string User password (required if generatePassword is not set) |
| displayName | string Full display name (alternative to firstName + lastName) |
| firstName | string User first name (required with lastName if displayName is not provided) |
| lastName | string User last name (required with firstName if displayName is not provided) |
| roles | string Enum: "user" "hunter" "manager" "admin" User role: user, admin, or manager |
| invite | string Workspace invite token to join a company on sign up |
| companyName | string Company name to create upon admin sign up |
object User address information | |
object Privacy consent settings | |
| generatePassword | boolean Whether to generate a random password instead of using the provided one |
| origin | string UTM origin tracking parameter |
| content | string UTM content tracking parameter |
| medium | string UTM medium tracking parameter |
| campaign | string UTM campaign tracking parameter |
| term | string UTM term tracking parameter |
| tech_size | string Company tech team size |
| plan | string Pricing plan selected on sign up |
| modules | string Product modules selection (all, assessments, skills, hiring) |
Responses
Request samples
- Payload
{- "email": "john.doe@company.com",
- "password": "P@ssw0rd!",
- "displayName": "John Doe",
- "firstName": "John",
- "lastName": "Doe",
- "roles": "user",
- "invite": "abc123def456",
- "companyName": "Acme Corp",
- "address": {
- "country": "Brazil",
- "state": "Minas Gerais",
- "city": "Belo Horizonte"
}, - "privacy": {
- "gdpr": true
}, - "generatePassword": false,
- "origin": "google",
- "content": "banner-top",
- "medium": "cpc",
- "campaign": "spring-sale",
- "term": "developer-hiring",
- "tech_size": "11-50",
- "plan": "free",
- "modules": "all"
}Response samples
- 201
{- "token": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiI1MDdmMWY3N2JjZjg2Y2Q3OTk0MzkwMTEiLCJpYXQiOjE3MDkwMDAwMDB9.abc123",
- "user": {
- "_id": "507f1f77bcf86cd799439011",
- "displayName": "John Doe",
- "firstName": "John",
- "lastName": "Doe",
- "email": "john.doe@company.com",
- "roles": "user",
- "username": "john-doe"
}, - "isNew": true,
- "flow": "dashboard",
- "provider": "local"
}Validate Invite Token
Handle GET invite/:token.
path Parameters
| token required | string |
header Parameters
| x-workspace-id | any |
| x-subaccount-id | any |
| x-language | any |
Responses
Response samples
- 200
{- "_id": "60d5ecb74e4d2a001f9a1234",
- "whitelabel": {
- "name": "Acme Corp",
- "primaryColor": "#6C5CE7",
- "secondaryColor": "#A29BFE"
}, - "password": true,
- "invited": {
- "user": "507f1f77bcf86cd799439011",
- "email": "john.doe@company.com"
}
}
Invite
Handle POST invite/:token.
path Parameters
| token required | string |
header Parameters
| x-workspace-id | any |
| x-subaccount-id | any |
| x-language | any |
Request Body schema: application/jsonrequired
| email required | string User email address |
| password | string User password (optional if workspace does not allow password login) |
| displayName | string Full display name (alternative to firstName + lastName) |
| firstName | string User first name (required with lastName if displayName is not provided) |
| lastName | string User last name (required with firstName if displayName is not provided) |
| roles | string Enum: "user" "hunter" "manager" "admin" User role: user, admin, or manager |
| invite | string Workspace invite token |
object Privacy consent settings | |
| origin | string UTM origin tracking parameter |
| content | string UTM content tracking parameter |
| medium | string UTM medium tracking parameter |
| campaign | string UTM campaign tracking parameter |
| term | string UTM term tracking parameter |
Responses
Request samples
- Payload
{- "email": "john.doe@company.com",
- "password": "P@ssw0rd!",
- "displayName": "John Doe",
- "firstName": "John",
- "lastName": "Doe",
- "roles": "user",
- "invite": "abc123def456",
- "privacy": {
- "gdpr": true
}, - "origin": "google",
- "content": "banner-top",
- "medium": "cpc",
- "campaign": "spring-sale",
- "term": "developer-hiring"
}Response samples
- 201
{- "token": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiI1MDdmMWY3N2JjZjg2Y2Q3OTk0MzkwMTEiLCJpYXQiOjE3MDkwMDAwMDB9.abc123",
- "user": {
- "_id": "507f1f77bcf86cd799439011",
- "displayName": "John Doe",
- "firstName": "John",
- "lastName": "Doe",
- "email": "john.doe@company.com",
- "roles": "user",
- "username": "john-doe"
}, - "isNew": true,
- "flow": "dashboard",
- "provider": "local"
}Forgot
Handle POST forgot/password.
header Parameters
| x-workspace-id | any |
| x-subaccount-id | any |
| x-language | any |
Request Body schema: application/jsonrequired
| email required | string Email address associated with the account to recover |
Responses
Request samples
- Payload
{- "email": "john.doe@company.com"
}Response samples
- 201
{- "message": "Operation completed successfully"
}Handle POST facebook.
header Parameters
| x-workspace-id | any |
| x-subaccount-id | any |
| x-language | any |
Request Body schema: application/jsonrequired
| code | string OAuth authorization code returned by the provider |
| access_token | string OAuth access token if already obtained from the provider |
| redirectUri | string OAuth redirect URI used in the authorization flow |
| scope | string OAuth scopes requested from the provider |
Responses
Request samples
- Payload
{- "code": "4/0AX4XfWh2...",
- "access_token": "ya29.a0AfH6SM...",
- "scope": "email profile"
}Response samples
- 201
{- "token": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiI1MDdmMWY3N2JjZjg2Y2Q3OTk0MzkwMTEiLCJpYXQiOjE3MDkwMDAwMDB9.abc123",
- "user": {
- "_id": "507f1f77bcf86cd799439011",
- "displayName": "John Doe",
- "firstName": "John",
- "lastName": "Doe",
- "email": "john.doe@company.com",
- "roles": "user",
- "username": "john-doe"
}, - "isNew": true,
- "flow": "dashboard",
- "provider": "local"
}Handle POST google.
header Parameters
| x-workspace-id | any |
| x-subaccount-id | any |
| x-language | any |
Request Body schema: application/jsonrequired
| code | string OAuth authorization code returned by the provider |
| access_token | string OAuth access token if already obtained from the provider |
| redirectUri | string OAuth redirect URI used in the authorization flow |
| scope | string OAuth scopes requested from the provider |
Responses
Request samples
- Payload
{- "code": "4/0AX4XfWh2...",
- "access_token": "ya29.a0AfH6SM...",
- "scope": "email profile"
}Response samples
- 201
{- "token": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiI1MDdmMWY3N2JjZjg2Y2Q3OTk0MzkwMTEiLCJpYXQiOjE3MDkwMDAwMDB9.abc123",
- "user": {
- "_id": "507f1f77bcf86cd799439011",
- "displayName": "John Doe",
- "firstName": "John",
- "lastName": "Doe",
- "email": "john.doe@company.com",
- "roles": "user",
- "username": "john-doe"
}, - "isNew": true,
- "flow": "dashboard",
- "provider": "local"
}Github
Handle POST github.
header Parameters
| x-workspace-id | any |
| x-subaccount-id | any |
| x-language | any |
Request Body schema: application/jsonrequired
| code | string OAuth authorization code returned by the provider |
| access_token | string OAuth access token if already obtained from the provider |
| redirectUri | string OAuth redirect URI used in the authorization flow |
| scope | string OAuth scopes requested from the provider |
Responses
Request samples
- Payload
{- "code": "4/0AX4XfWh2...",
- "access_token": "ya29.a0AfH6SM...",
- "scope": "email profile"
}Response samples
- 201
{- "token": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiI1MDdmMWY3N2JjZjg2Y2Q3OTk0MzkwMTEiLCJpYXQiOjE3MDkwMDAwMDB9.abc123",
- "user": {
- "_id": "507f1f77bcf86cd799439011",
- "displayName": "John Doe",
- "firstName": "John",
- "lastName": "Doe",
- "email": "john.doe@company.com",
- "roles": "user",
- "username": "john-doe"
}, - "isNew": true,
- "flow": "dashboard",
- "provider": "local"
}Handle POST linkedin.
header Parameters
| x-workspace-id | any |
| x-subaccount-id | any |
| x-language | any |
Request Body schema: application/jsonrequired
| code | string OAuth authorization code returned by the provider |
| access_token | string OAuth access token if already obtained from the provider |
| redirectUri | string OAuth redirect URI used in the authorization flow |
| scope | string OAuth scopes requested from the provider |
Responses
Request samples
- Payload
{- "code": "4/0AX4XfWh2...",
- "access_token": "ya29.a0AfH6SM...",
- "scope": "email profile"
}Response samples
- 201
{- "token": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiI1MDdmMWY3N2JjZjg2Y2Q3OTk0MzkwMTEiLCJpYXQiOjE3MDkwMDAwMDB9.abc123",
- "user": {
- "_id": "507f1f77bcf86cd799439011",
- "displayName": "John Doe",
- "firstName": "John",
- "lastName": "Doe",
- "email": "john.doe@company.com",
- "roles": "user",
- "username": "john-doe"
}, - "isNew": true,
- "flow": "dashboard",
- "provider": "local"
}Login Saml
Handle POST saml.
header Parameters
| x-workspace-id | any |
| x-subaccount-id | any |
| x-language | any |
Request Body schema: application/jsonrequired
string User email address to resolve the SAML identity provider via domain | |
| id | string SAML provider ID to directly initiate SSO |
Responses
Request samples
- Payload
{- "email": "john.doe@company.com",
- "id": "507f1f77bcf86cd799439011"
}Saml
Handle POST saml/callback.
header Parameters
| x-workspace-id | any |
| x-subaccount-id | any |
| x-language | any |
Request Body schema: application/jsonrequired
| SAMLResponse | string SAML response XML (base64 encoded) returned by the identity provider |
| RelayState | string Relay state passed through the SAML flow |
Responses
Request samples
- Payload
{- "SAMLResponse": "PHNhbWxwOlJlc3BvbnNl...",
}Confirmation Account Resend
Handle POST confirmation.
header Parameters
| x-workspace-id | any |
| x-subaccount-id | any |
| x-language | any |
Request Body schema: application/jsonrequired
| email required | string Email address of the account to resend the confirmation email to |
Responses
Request samples
- Payload
{- "email": "john.doe@company.com"
}Confirmation Account
Handle PUT confirmation/:token.
path Parameters
| token required | string |
header Parameters
| x-workspace-id | any |
| x-subaccount-id | any |
| x-language | any |
Responses
Response samples
- 200
{- "message": "User account has been confirmed",
- "user": {
- "_id": "507f1f77bcf86cd799439011",
- "email": "john.doe@company.com",
- "displayName": "John Doe",
- "verified": true
}
}Handle
Handle GET :companySlug.
path Parameters
| companySlug required | string |
header Parameters
| x-workspace-id | any |
| x-subaccount-id | any |
| x-language | any |
Responses
Response samples
- 200
{- "_id": "507f1f77bcf86cd799439011",
- "slug": "acme-corp",
- "company_name": "Acme Corp",
- "code": "ACME",
- "company_type": "consulting",
- "headline": "Building the future of tech",
- "description": "<p>We are a technology company...</p>",
- "culture_code": "Innovation-driven",
- "valuation": "series_b",
- "market": "FinTech",
- "tech_size": "51-200",
- "corporate_name": "Acme Corporation Inc.",
- "image": {
- "public_id": "companies/acme-logo"
}, - "cover_image": {
- "public_id": "companies/acme-logo"
}, - "founded_year": "2018",
- "founded": "2018-01-15T00:00:00.000Z",
- "average_rating": {
- "life_balance": 4.2,
- "safety_at_work": 4.5,
- "management": 3.8,
- "total": 4.1
}, - "open_positions": 5,
- "views": 1234,
- "social": {
}, - "address": {
- "city": "San Francisco",
- "country": "US"
}, - "related_companies": [
- "507f1f77bcf86cd799439012"
], - "reviews": [ ],
- "offers": [ ],
- "also_viewed": [ ]
}
Handle
Handle GET root route.
header Parameters
| x-workspace-id | any |
| x-subaccount-id | any |
| x-language | any |
Responses
Response samples
- 200
{- "totalDocs": 42,
- "limit": 10,
- "page": 1,
- "totalPages": 5,
- "pagingCounter": 1,
- "hasPrevPage": false,
- "hasNextPage": true,
- "prevPage": null,
- "nextPage": 2,
- "docs": [
- {
- "value": "507f1f77bcf86cd799439011",
- "label": "Acme Corp",
- "meta": {
- "slug": "acme-corp",
- "demands_count": 3
}
}
]
}Find By Slug
Handle GET slug/:slug.
path Parameters
| slug required | string |
header Parameters
| x-workspace-id | any |
| x-subaccount-id | any |
| x-language | any |
Responses
Response samples
- 200
{- "_id": "507f1f77bcf86cd799439011",
- "slug": "acme-corp",
- "company_name": "Acme Corp",
- "corporate_name": "Acme Corporation Inc.",
- "company_type": "consulting",
- "headline": "Building the future of tech",
- "description": "<p>We are a technology company...</p>",
- "market": "FinTech",
- "tech_size": "51-200",
- "email": "contact@acme.com",
- "cnpj": "12.345.678/0001-90",
- "active": true,
- "deleted": false,
- "founded_year": "2018",
- "founded": "2018-01-15T00:00:00.000Z",
- "views": 1234,
- "warranty_days": 90,
- "author": "507f1f77bcf86cd799439011",
- "image": {
- "public_id": "companies/acme-logo"
}, - "cover_image": {
- "public_id": "companies/acme-logo"
}, - "colors": {
- "primary": "#3B82F6",
- "secondary": "#1E40AF"
}, - "representative": {
- "displayName": "Jane Doe",
- "email": "jane@acme.com",
- "city": "San Francisco",
- "phone": "+14155551234",
- "job_position": "CTO",
- "subject": "Technical Hiring"
}, - "address": {
- "city": "San Francisco",
- "province": "CA",
- "country": "US",
- "zip_code": "94105",
- "address": "123 Market St",
- "address_2": "Suite 400",
- "number": "123",
- "phone_1": "+14155551234",
- "whatsapp_phone": "+14155551234",
- "neighborhood": "SoMa"
}, - "social": {
}, - "privacy": {
- "gdpr": true
}, - "financial": {
- "displayName": "John Finance",
- "email": "finance@acme.com",
- "phone": "+14155551234",
- "hiring_payment_delay": 5,
- "city_ssn": "123456",
- "province_ssn": "789012",
- "taxes": true,
- "notes": "Net-30 terms",
- "address": { }
}, - "linkedin": {
- "companyId": "123456",
- "original_company_id": "789012",
- "industry": "Technology"
}, - "glassdoor": {
- "companyId": "654321",
- "disable_profile": false
}, - "plan": {
- "status": "active",
- "status_formatted": "Active",
- "current_plan": "starter",
- "interval": "monthly",
- "start_at": "2024-01-15T00:00:00.000Z",
- "end_at": "2025-01-15T00:00:00.000Z",
- "quotas": { }
}, - "plan_formatted": "Starter",
- "placement_fee": {
- "type": "70"
}, - "modules": [
- "jobs",
- "feed",
- "assessments"
], - "modules_formatted": [
- "Jobs",
- "Feed",
- "Assessments"
], - "company_page": {
- "status": "public",
- "status_formatted": "Public"
}, - "teams_settings": {
- "login_with_email": true,
- "onboarding": true,
- "onboarding_career": "positions",
- "softskills": true,
- "communities": true,
- "can_unlock_softskills": true
}, - "locales": [
- "en",
- "pt"
], - "default_locale": "en",
- "allowed_domains": [
- { }
], - "saml": [
- { }
], - "contract": [
- { }
], - "mobile_stack": [
- "React Native",
- "Swift"
], - "devops_stack": [
- "Docker",
- "Kubernetes"
], - "backend_stack": [
- "Node.js",
- "Python"
], - "frontend_stack": [
- "React",
- "TypeScript"
], - "related_companies": [
- "string"
], - "reviews": [
- "string"
], - "trial_starts": "2024-01-15T00:00:00.000Z",
- "trial_ends": "2024-01-22T23:59:59.999Z",
- "update_date": "2024-06-01T12:00:00.000Z",
- "created": "2024-01-15T10:30:00.000Z",
- "permissions": {
- "edit_followers": true
}
}Find Stats By Id
Handle GET :partnerId/stats.
path Parameters
| partnerId required | string |
header Parameters
| x-workspace-id | any |
| x-subaccount-id | any |
| x-language | any |
Responses
Response samples
- 200
{- "created": "2024-01-15T10:30:00.000Z",
- "jobs": {
- "created": 25,
- "progress": 10,
- "review": 3
}, - "teams": {
- "created": 5,
- "draft": 1,
- "published": 4
}
}Handle
Handle POST assessment.
header Parameters
| x-workspace-id | any |
| x-subaccount-id | any |
| x-language | any |
Request Body schema: application/jsonrequired
| attempt_id required | string Assessment attempt ID |
| application_id | string Application ID |
| assessment_id | string Assessment ID |
| status required | string Enum: "draft" "invited" "expired" "finished" "started" "blocked" "scheduled" "pending" "pending_review" Webhook event status |
number or string Assessment score | |
| title | string Assessment title |
Responses
Request samples
- Payload
{- "attempt_id": "507f1f77bcf86cd799439011",
- "application_id": "507f1f77bcf86cd799439011",
- "assessment_id": "507f1f77bcf86cd799439011",
- "status": "finished",
- "score": 85,
- "title": "JavaScript Assessment"
}Handle
Handle GET jobs.
header Parameters
| x-workspace-id | any |
| x-subaccount-id | any |
| x-language | any |
Responses
Response samples
- 200
{- "type": {
- "clt": "CLT",
- "pj": "PJ",
- "freelance": "Freelance"
}, - "type_ordered": [
- {
- "clt": "CLT"
}, - {
- "pj": "PJ"
}
], - "status": {
- "created": "Draft",
- "progress": "In Progress"
}, - "status_ordered": [
- {
- "created": "Draft"
}, - {
- "progress": "In Progress"
}
], - "level": {
- "specialist": "Senior",
- "intermediary": "Pleno"
}, - "level_ordered": [
- {
- "trainee": "Trainee"
}, - {
- "beginner": "Junior"
}
], - "looking_for": {
- "backend": "Back-End Developer",
- "frontend": "Front-End Developer"
}, - "looking_for_ordered": [
- {
- "backend": "Back-End"
}, - {
- "frontend": "Front-End"
}
], - "job_type": {
- "job": "Job",
- "pool": "Talent Pool"
}, - "salary_scope": {
- "public": "Public",
- "private": "Private"
}, - "format": {
- "full_time": "Full-time",
- "part_time": "Part-time 4h"
}, - "format_ordered": [
- {
- "full_time": "Full-time"
}
], - "home_office": {
- "integral": "Remote",
- "partial": "Hybrid",
- "none": "On-site"
}, - "home_office_ordered": [
- {
- "integral": "Remote"
}, - {
- "partial": "Hybrid"
}
], - "escort": {
- "0": "Flexible",
- "1": "Moderate",
- "2": "Restricted"
}, - "priority": {
- "1": "Medium",
- "2": "High"
}, - "application_type": {
- "email": "Receive in the platform",
- "external_url": "Redirect to external link"
}
}Find All In Progress
Handle GET jobs.
header Parameters
| x-workspace-id | any |
| x-subaccount-id | any |
| x-language | any |
Responses
Response samples
- 200
{- "docs": [
- {
- "_id": "507f1f77bcf86cd799439011",
- "title": "Senior Full-Stack Developer",
- "slug": "senior-full-stack-developer-at-coodesh-1234",
- "job_type": "job",
- "job_type_formatted": "Job",
- "type": "clt",
- "type_formatted": "CLT",
- "level": "specialist",
- "level_formatted": "Senior",
- "home_office": "integral",
- "home_office_formatted": "Remote",
- "format": "full_time",
- "format_formatted": "Full-time",
- "application_type": "coodesh",
- "salary_scope": "public",
- "currency_salary": "BRL",
- "salary_range_formatted": "R$ 8.000 - R$ 15.000",
- "other_cities": true,
- "address": {
- "city": "Belo Horizonte",
- "province": "MG",
- "country": "BR",
- "full_location": "Belo Horizonte, MG, Brazil",
- "location": {
- "coordinates": [
- -43.1729,
- -22.9068
], - "type": "Point"
}
}, - "company": {
- "_id": "507f1f77bcf86cd799439011",
- "company_name": "Coodesh",
- "slug": "coodesh",
- "address.city": "Belo Horizonte"
}, - "skills": [
- {
- "_id": "507f1f77bcf86cd799439011",
- "name": "React"
}
], - "status": "progress",
- "views": 342,
- "publish_date": "2025-03-15T10:30:00.000Z",
- "created": "2025-03-10T08:00:00.000Z"
}
], - "totalDocs": 42,
- "limit": 10,
- "page": 1,
- "totalPages": 5,
- "pagingCounter": 1,
- "hasPrevPage": false,
- "hasNextPage": true,
- "prevPage": null,
- "nextPage": 2
}
Find All In Progress V2
Handle GET v2/jobs.
header Parameters
| x-workspace-id | any |
| x-subaccount-id | any |
| x-language | any |
Responses
Response samples
- 200
{- "docs": [
- {
- "_id": "507f1f77bcf86cd799439011",
- "title": "Senior Full-Stack Developer",
- "slug": "senior-full-stack-developer-at-coodesh-1234",
- "job_type": "job",
- "job_type_formatted": "Job",
- "type": "clt",
- "type_formatted": "CLT",
- "level": "specialist",
- "level_formatted": "Senior",
- "home_office": "integral",
- "home_office_formatted": "Remote",
- "format": "full_time",
- "format_formatted": "Full-time",
- "application_type": "coodesh",
- "salary_scope": "public",
- "currency_salary": "BRL",
- "salary_range_formatted": "R$ 8.000 - R$ 15.000",
- "other_cities": true,
- "address": {
- "city": "Belo Horizonte",
- "province": "MG",
- "country": "BR",
- "full_location": "Belo Horizonte, MG, Brazil",
- "location": {
- "coordinates": [
- -43.1729,
- -22.9068
], - "type": "Point"
}
}, - "company": {
- "_id": "507f1f77bcf86cd799439011",
- "company_name": "Coodesh",
- "slug": "coodesh",
- "address.city": "Belo Horizonte"
}, - "skills": [
- {
- "_id": "507f1f77bcf86cd799439011",
- "name": "React"
}
], - "status": "progress",
- "views": 342,
- "publish_date": "2025-03-15T10:30:00.000Z",
- "created": "2025-03-10T08:00:00.000Z"
}
], - "totalDocs": 42,
- "limit": 10,
- "page": 1,
- "totalPages": 5,
- "pagingCounter": 1,
- "hasPrevPage": false,
- "hasNextPage": true,
- "prevPage": null,
- "nextPage": 2
}Get Search Fields
Handle GET jobs/search_fields.
header Parameters
| x-workspace-id | any |
| x-subaccount-id | any |
| x-language | any |
Responses
Response samples
- 200
{- "type": [
- {
- "value": "clt",
- "label": "CLT"
}
], - "level": [
- {
- "value": "clt",
- "label": "CLT"
}
], - "format": [
- {
- "value": "clt",
- "label": "CLT"
}
], - "home_office": [
- {
- "value": "clt",
- "label": "CLT"
}
], - "categories": [
- {
- "value": "507f1f77bcf86cd799439011",
- "label": "Technology",
- "slug": "technology"
}
], - "skills": [
- {
- "value": "507f1f77bcf86cd799439011",
- "label": "React",
- "slug": "react"
}
], - "salary_range": {
- "min": 0,
- "max": 30000
}, - "city": [
- {
- "value": "Belo Horizonte",
- "label": "Belo Horizonte, MG, Brazil",
- "city": "Belo Horizonte",
- "province": "MG",
- "country": "BR"
}
], - "province": [
- {
- "value": "MG",
- "label": "Minas Gerais, Brazil",
- "country": "BR"
}
], - "country": [
- {
- "value": "BR",
- "label": "Brazil",
- "country": "BR"
}
]
}Find By Slug
Handle GET jobs/single/:slug.
path Parameters
| slug required | string |
header Parameters
| x-workspace-id | any |
| x-subaccount-id | any |
| x-language | any |
Responses
Response samples
- 200
{- "_id": "507f1f77bcf86cd799439011",
- "title": "Senior Full-Stack Developer",
- "slug": "senior-full-stack-developer-at-coodesh-1234",
- "description": "<p>We are looking for a senior developer...</p>",
- "job_type": "job",
- "job_type_formatted": "Job",
- "type": "clt",
- "type_formatted": "CLT",
- "level": "specialist",
- "level_formatted": "Senior",
- "home_office": "integral",
- "home_office_formatted": "Remote",
- "format": "full_time",
- "format_formatted": "Full-time",
- "looking_for": [
- "backend",
- "fullstack"
], - "looking_for_formatted": [
- "Back-End Developer",
- "Full-Stack Developer"
], - "application_type": "coodesh",
- "salary_scope": "public",
- "currency_salary": "BRL",
- "salary_range": {
- "currency": "BRL",
- "min": 5000,
- "max": 15000
}, - "salary_range_formatted": "R$ 8.000 - R$ 15.000",
- "address": {
- "city": "Belo Horizonte",
- "province": "MG",
- "country": "BR",
- "full_location": "Belo Horizonte, MG, Brazil",
- "location": {
- "coordinates": [
- -43.1729,
- -22.9068
], - "type": "Point"
}
}, - "company": {
- "_id": "507f1f77bcf86cd799439011",
- "company_name": "Coodesh",
- "slug": "coodesh",
- "address.city": "Belo Horizonte"
}, - "category": {
- "_id": "507f1f77bcf86cd799439011",
- "name": "Technology",
- "slug": "technology"
}, - "skills": [
- {
- "_id": "507f1f77bcf86cd799439011",
- "name": "React"
}
], - "languages": [
- "English",
- "Portuguese"
], - "requirements": [
- "5+ years of experience",
- "Strong TypeScript skills"
], - "differentials": [
- "AWS experience",
- "Open source contributions"
], - "highlights": [
- "Competitive salary",
- "Flexible hours"
], - "benefits": [
- "Health insurance",
- "Remote work"
], - "challenges": [
- "Build a REST API",
- "Code review exercise"
], - "expires": "2025-06-15T23:59:59.000Z",
- "status": "progress",
- "status_formatted": "In Progress",
- "views": 342,
- "proposals_counter": 15,
- "publish_date": "2025-03-15T10:30:00.000Z",
- "created": "2025-03-10T08:00:00.000Z",
- "exclude_from_search": false,
- "application": null
}
Find Similar Jobs
Handle GET jobs/single/:slug/related.
path Parameters
| slug required | string |
header Parameters
| x-workspace-id | any |
| x-subaccount-id | any |
| x-language | any |
Responses
Response samples
- 200
{- "docs": [
- {
- "_id": "507f1f77bcf86cd799439011",
- "title": "Senior Full-Stack Developer",
- "slug": "senior-full-stack-developer-at-coodesh-1234",
- "job_type": "job",
- "job_type_formatted": "Job",
- "type": "clt",
- "type_formatted": "CLT",
- "level": "specialist",
- "level_formatted": "Senior",
- "home_office": "integral",
- "home_office_formatted": "Remote",
- "format": "full_time",
- "format_formatted": "Full-time",
- "application_type": "coodesh",
- "salary_scope": "public",
- "currency_salary": "BRL",
- "salary_range_formatted": "R$ 8.000 - R$ 15.000",
- "other_cities": true,
- "address": {
- "city": "Belo Horizonte",
- "province": "MG",
- "country": "BR",
- "full_location": "Belo Horizonte, MG, Brazil",
- "location": {
- "coordinates": [
- -43.1729,
- -22.9068
], - "type": "Point"
}
}, - "company": {
- "_id": "507f1f77bcf86cd799439011",
- "company_name": "Coodesh",
- "slug": "coodesh",
- "address.city": "Belo Horizonte"
}, - "skills": [
- {
- "_id": "507f1f77bcf86cd799439011",
- "name": "React"
}
], - "status": "progress",
- "views": 342,
- "publish_date": "2025-03-15T10:30:00.000Z",
- "created": "2025-03-10T08:00:00.000Z"
}
], - "totalDocs": 42,
- "limit": 10,
- "page": 1,
- "totalPages": 5,
- "pagingCounter": 1,
- "hasPrevPage": false,
- "hasNextPage": true,
- "prevPage": null,
- "nextPage": 2
}Apply
Handle POST jobs/apply/:jobId.
path Parameters
| jobId required | string |
header Parameters
| x-workspace-id | any |
| x-subaccount-id | any |
| x-language | any |
Request Body schema: application/jsonrequired
| email required | string Candidate email address |
| fullname required | string Candidate full name |
string LinkedIn profile URL | |
| github | string GitHub profile URL |
| cv | string CV/resume URL (required if no file upload) |
| contact_preference | string Preferred contact method |
| contact_hour | string Preferred contact hours |
| contract_type | string Enum: "clt" "pj" "intern" "freelance" "flex" "consulting" "project" "lecture" "mvp" "co_founder" Contract type preference |
object Salary range expectation (BRL) | |
object Salary range expectation (JPY) | |
| other_cities | boolean Open to relocate to other cities |
object Candidate address |
Responses
Request samples
- Payload
{- "email": "candidate@example.com",
- "fullname": "John Doe",
- "contact_preference": "email",
- "contact_hour": "morning",
- "contract_type": "clt",
- "salary_range": {
- "currency": "BRL",
- "min": 0,
- "max": 15000
}, - "salary_range_jp": {
- "currency": "BRL",
- "min": 0,
- "max": 15000
}, - "other_cities": true,
- "address": {
- "city": "Belo Horizonte",
- "province": "MG",
- "country": "BR",
- "phone": "+5531999998888"
}
}Response samples
- 201
{- "_id": "507f1f77bcf86cd799439011",
- "fullname": "Jane Doe",
- "contact_preference": "email",
- "contract_type": "clt",
- "salary_range": {
- "currency": "BRL",
- "min": 5000,
- "max": 15000
}, - "status": "draft",
- "status_formatted": "Draft",
- "user": "507f1f77bcf86cd799439011",
- "behavioral_report": {
- "status": "completed",
- "passport_token": "abc123"
}, - "scorecard_report": {
- "token": "def456",
- "status": "completed"
}, - "quiz_report": {
- "token": "ghi789",
- "status": "pending"
}
}Find By Company Slug
Handle GET companies/:slug/jobs.
path Parameters
| slug required | string |
header Parameters
| x-workspace-id | any |
| x-subaccount-id | any |
| x-language | any |
Responses
Response samples
- 200
{- "docs": [
- {
- "_id": "507f1f77bcf86cd799439011",
- "title": "Senior Full-Stack Developer",
- "slug": "senior-full-stack-developer-at-coodesh-1234",
- "job_type": "job",
- "job_type_formatted": "Job",
- "type": "clt",
- "type_formatted": "CLT",
- "level": "specialist",
- "level_formatted": "Senior",
- "home_office": "integral",
- "home_office_formatted": "Remote",
- "format": "full_time",
- "format_formatted": "Full-time",
- "application_type": "coodesh",
- "salary_scope": "public",
- "currency_salary": "BRL",
- "salary_range_formatted": "R$ 8.000 - R$ 15.000",
- "other_cities": true,
- "address": {
- "city": "Belo Horizonte",
- "province": "MG",
- "country": "BR",
- "full_location": "Belo Horizonte, MG, Brazil",
- "location": {
- "coordinates": [
- -43.1729,
- -22.9068
], - "type": "Point"
}
}, - "company": {
- "_id": "507f1f77bcf86cd799439011",
- "company_name": "Coodesh",
- "slug": "coodesh",
- "address.city": "Belo Horizonte"
}, - "skills": [
- {
- "_id": "507f1f77bcf86cd799439011",
- "name": "React"
}
], - "status": "progress",
- "views": 342,
- "publish_date": "2025-03-15T10:30:00.000Z",
- "created": "2025-03-10T08:00:00.000Z"
}
], - "totalDocs": 42,
- "limit": 10,
- "page": 1,
- "totalPages": 5,
- "pagingCounter": 1,
- "hasPrevPage": false,
- "hasNextPage": true,
- "prevPage": null,
- "nextPage": 2
}Handle
Handle GET applications.
header Parameters
| x-workspace-id | any |
| x-subaccount-id | any |
| x-language | any |
Responses
Response samples
- 200
{- "contact_preference": {
- "whatsapp": "WhatsApp",
- "email": "E-mail",
- "phone": "Phone"
}, - "status": {
- "pending": "Pending",
- "approved": "Approved",
- "rejected": "Rejected"
}, - "type": {
- "organic": "Organic",
- "invited": "Invited"
}, - "contract_type": {
- "clt": "CLT",
- "pj": "PJ"
}, - "disapproved_reasons": {
- "no_fit": "No fit for the role",
- "salary": "Salary expectation"
}, - "quit_reasons": {
- "other_offer": "Accepted another offer",
- "no_interest": "Lost interest"
}, - "quit_reasons_candidate": {
- "slow_process": "Slow process",
- "no_feedback": "No feedback"
}, - "format": {
- "remote": "Remote",
- "onsite": "On-site",
- "hybrid": "Hybrid"
}, - "frozen_statuses": [
- "approved",
- "rejected"
], - "challenge_presentation_type": {
- "video": "Video",
- "live": "Live presentation"
}, - "challenge_score": {
- "passed": "Passed",
- "failed": "Failed"
}, - "challenge_category": {
- "frontend": "Front-end",
- "backend": "Back-end"
}, - "home_office": {
- "yes": "Yes",
- "no": "No",
- "partial": "Partial"
}, - "home_office_ordered": [
- {
- "yes": "Yes"
}, - {
- "no": "No"
}
], - "plan_ordered": [
- {
- "basic": "Basic"
}, - {
- "premium": "Premium"
}
], - "plan": {
- "placement_fee": {
- "10": "10%",
- "15": "15%",
- "20": "20%"
}
}, - "assessment": {
- "status": {
- "completed": "Completed",
- "pending": "Pending",
- "expired": "Expired"
}
}, - "emails": {
- "invitation": "Invitation",
- "feedback": "Feedback"
}
}Handle
Handle GET applications.
header Parameters
| x-workspace-id | any |
| x-subaccount-id | any |
| x-language | any |
Responses
Response samples
- 200
{- "totalDocs": 42,
- "limit": 10,
- "page": 1,
- "totalPages": 5,
- "pagingCounter": 1,
- "hasPrevPage": false,
- "hasNextPage": true,
- "prevPage": null,
- "nextPage": 2,
- "docs": [
- {
- "label": "São Paulo, SP, Brazil",
- "value": "São Paulo",
- "city": "São Paulo",
- "province": "SP",
- "country": "BR"
}
]
}Handle
Handle POST :code.
path Parameters
| code required | string |
header Parameters
| x-workspace-id | any |
| x-subaccount-id | any |
| x-language | any |
Request Body schema: application/jsonrequired
| email required | string Candidate email address |
| displayName required | string Candidate full display name |
| focus | string Professional focus area (e.g. backend, frontend, fullstack) |
| looking_for | string Job type the candidate is looking for |
| skills | Array of strings Skill IDs the candidate possesses |
| level | string Experience level (junior, mid, senior) |
| city | string City of residence |
| phone | string Phone number |
string LinkedIn profile URL | |
| github | string GitHub profile URL |
| other_cities | boolean Whether the candidate is open to relocating to other cities |
object Expected salary range |
Responses
Request samples
- Payload
{- "email": "candidate@example.com",
- "displayName": "Maria Silva",
- "focus": "backend",
- "looking_for": "fulltime",
- "skills": [
- "64a1b2c3d4e5f60012345678"
], - "level": "senior",
- "city": "Belo Horizonte",
- "phone": "+5531999999999",
- "other_cities": true,
- "salary_range": {
- "currency": "BRL",
- "min": 5000,
- "max": 12000
}
}Response samples
- 409
{- "message": "You already have a registration. Please contact us to update your preferences.",
- "email": "contact@coodesh.com"
}FindTeamsController_handle
Authorizations:
query Parameters
| author | Array of any |
| order | string Default: "desc" Enum: "asc" "desc" |
| orderBy | string Default: "_id" |
| offset | number >= 0 Default: 0 |
| page | number >= 1 Default: 1 Example: page=1 |
| pageSize | number [ 1 .. 2000 ] Default: 20 Example: pageSize=10 |
| limit | number [ 0 .. 2000 ] Default: 20 |
| status | string Example: status=published |
| grouping | string Enum: "results" "invited" Grouping by status. Cannot be used with status query |
| search | string |
| query | string Base64-encoded JSONLogic filter tree. Supported fields: status, author. |
| locale | string Examples:
Locale override (e.g. en, pt, es). Has priority over team.default_locale |
header Parameters
| x-workspace-id | any Provide to identify the specific workspace from request |
| x-subaccount-id | any Provide to identify the specific subaccount from request |
| x-language | any Provide to identify the locale from the content |
Responses
Response samples
- 200
{- "docs": [
- {
- "_id": "6501d432afe2730012f74d68",
- "name": "Engineering Career Path",
- "description": "Career progression for engineers",
- "slug": "engineering-career",
- "status": "published",
- "status_formatted": "Published",
- "created": "2019-08-24T14:15:22Z",
- "archived_date": "2019-08-24T14:15:22Z",
- "author": {
- "_id": "6501d432afe2730012f74d68",
- "displayName": "Jane Smith",
}, - "users": [
- {
- "_id": "6501d432afe2730012f74d68",
- "displayName": "John Doe",
}
], - "users_count": 25
}
], - "totalDocs": 50,
- "limit": 10,
- "totalPages": 5,
- "page": 1,
- "pagingCounter": 1,
- "hasPrevPage": false,
- "hasNextPage": true,
- "prevPage": null,
- "nextPage": 2
}
Create a new career team
Authorizations:
header Parameters
| x-workspace-id | any Provide to identify the specific workspace from request |
| x-subaccount-id | any Provide to identify the specific subaccount from request |
| x-language | any Provide to identify the locale from the content |
Request Body schema: application/jsonrequired
required | object Translated content for team |
| default_locale required | string Default: "en" Default locale for the team content |
| owners required | Array of objects (ObjectId) User that created this Assessment |
| author required | object Team author |
| subaccount_ids required | Array of objects (ObjectId) Workspaces that this team belongs to |
Responses
Request samples
- Payload
{- "translated_content": {
- "pt": {
- "name": "string",
- "description": "string"
}, - "en": {
- "name": "string",
- "description": "string"
}, - "es": {
- "name": "string",
- "description": "string"
}
}, - "default_locale": "pt",
- "owners": "62b5faff5a80481c2cba4669",
- "author": "62b5faff5a80481c2cba4669",
- "subaccount_ids": [
- "62b384d70309831f9c13c87d",
- "62b5faff5a80481c2cba4669"
]
}Delete teams
Authorizations:
header Parameters
| x-workspace-id | any Provide to identify the specific workspace from request |
| x-subaccount-id | any Provide to identify the specific subaccount from request |
| x-language | any Provide to identify the locale from the content |
Request Body schema: application/jsonrequired
| ids required | Array of objects (ObjectId) Array of ids |
Responses
Request samples
- Payload
{- "ids": [
- { }
]
}MoveTeamToArchivedController_handle
Authorizations:
path Parameters
| id required | string Example: 61b8e9bb2300e80010c0bcc2 |
header Parameters
| x-workspace-id | any Provide to identify the specific workspace from request |
| x-subaccount-id | any Provide to identify the specific subaccount from request |
| x-language | any Provide to identify the locale from the content |
Responses
MoveTeamToPublishedController_handle
Authorizations:
path Parameters
| id required | string Example: 61b8e9bb2300e80010c0bcc2 |
header Parameters
| x-workspace-id | any Provide to identify the specific workspace from request |
| x-subaccount-id | any Provide to identify the specific subaccount from request |
| x-language | any Provide to identify the locale from the content |
Responses
DuplicateTeamController_handle
Authorizations:
path Parameters
| id required | string Example: 61b8e9bb2300e80010c0bcc2 |
header Parameters
| x-workspace-id | any Provide to identify the specific workspace from request |
| x-subaccount-id | any Provide to identify the specific subaccount from request |
| x-language | any Provide to identify the locale from the content |
Request Body schema: application/jsonrequired
| name required | string |
| description required | string |
Responses
Request samples
- Payload
{- "name": "string",
- "description": "string"
}FindTeamsAuthorsController_handle
Authorizations:
query Parameters
| author | Array of strings |
header Parameters
| x-workspace-id | any Provide to identify the specific workspace from request |
| x-subaccount-id | any Provide to identify the specific subaccount from request |
| x-language | any Provide to identify the locale from the content |
Responses
Response samples
- 200
[- {
- "value": "6501d432afe2730012f74d68",
- "label": "John Doe"
}
]StatisticsController_handle
Authorizations:
header Parameters
| x-workspace-id | any Provide to identify the specific workspace from request |
| x-subaccount-id | any Provide to identify the specific subaccount from request |
| x-language | any Provide to identify the locale from the content |
Responses
Response samples
- 200
{- "teams": 10,
- "people": 150,
- "tracks": 25
}FindTeamByIdController_handle
Authorizations:
path Parameters
| id required | string Example: 1661452472991 |
query Parameters
| locale | string Examples:
Locale override (e.g. en, pt, es). Has priority over team.default_locale |
header Parameters
| x-workspace-id | any Provide to identify the specific workspace from request |
| x-subaccount-id | any Provide to identify the specific subaccount from request |
| x-language | any Provide to identify the locale from the content |
Responses
Response samples
- 200
{- "_id": "6501d432afe2730012f74d68",
- "name": "Engineering Career Path",
- "description": "Career progression for engineers",
- "translated_content": {
- "pt": {
- "name": "Carreira de Engenharia",
- "description": "Progressão..."
}
}, - "default_locale": "en",
- "status": "published",
- "author": "6501d432afe2730012f74d68",
- "owners": [
- "6501d432afe2730012f74d68"
], - "subaccount_ids": [
- "6501d432afe2730012f74d68"
]
}UpdateTeamByIdController_handle
Authorizations:
path Parameters
| id required | string Example: 61b8e9bb2300e80010c0bcc2 |
header Parameters
| x-workspace-id | any Provide to identify the specific workspace from request |
| x-subaccount-id | any Provide to identify the specific subaccount from request |
| x-language | any Provide to identify the locale from the content |
Request Body schema: application/jsonrequired
required | object Translated content for team |
| default_locale required | string Default: "en" Default locale for the team content |
| owners required | Array of objects (ObjectId) User that created this Assessment |
| author required | object Team author |
| subaccount_ids required | Array of objects (ObjectId) Workspaces that this team belongs to |
| _id required | object Team ID |
| status required | string Enum: "draft" "published" "archived" Team status |
Responses
Request samples
- Payload
{- "translated_content": {
- "pt": {
- "name": "string",
- "description": "string"
}, - "en": {
- "name": "string",
- "description": "string"
}, - "es": {
- "name": "string",
- "description": "string"
}
}, - "default_locale": "pt",
- "owners": "62b5faff5a80481c2cba4669",
- "author": "62b5faff5a80481c2cba4669",
- "subaccount_ids": [
- "62b384d70309831f9c13c87d",
- "62b5faff5a80481c2cba4669"
], - "_id": "62b384d70309831f9c13c87d",
- "status": "published"
}Translate career name and description
Authorizations:
path Parameters
| id required | string Example: 61b8e9bb2300e80010c0bcc2 |
header Parameters
| x-workspace-id | any Provide to identify the specific workspace from request |
| x-subaccount-id | any Provide to identify the specific subaccount from request |
| x-language | any Provide to identify the locale from the content |
Request Body schema: application/jsonrequired
| targetLocales required | Array of strings non-empty Target language codes for translation (e.g. ["en","pt"]). |
Responses
Request samples
- Payload
{- "targetLocales": [
- "string"
]
}Translate track name and description
Authorizations:
path Parameters
| id required | string |
| trackId required | string |
header Parameters
| x-workspace-id | any Provide to identify the specific workspace from request |
| x-subaccount-id | any Provide to identify the specific subaccount from request |
| x-language | any Provide to identify the locale from the content |
Request Body schema: application/jsonrequired
| targetLocales required | Array of strings non-empty Target language codes for translation (e.g. ["en","pt"]). |
Responses
Request samples
- Payload
{- "targetLocales": [
- "string"
]
}Translate position label and description
Authorizations:
path Parameters
| id required | string |
| positionId required | string |
| trackId required | string |
header Parameters
| x-workspace-id | any Provide to identify the specific workspace from request |
| x-subaccount-id | any Provide to identify the specific subaccount from request |
| x-language | any Provide to identify the locale from the content |
Request Body schema: application/jsonrequired
| targetLocales required | Array of strings non-empty Target language codes for translation (e.g. ["en","pt"]). |
Responses
Request samples
- Payload
{- "targetLocales": [
- "string"
]
}Translate category name and description
Authorizations:
path Parameters
| id required | string |
| categoryId required | string |
header Parameters
| x-workspace-id | any Provide to identify the specific workspace from request |
| x-subaccount-id | any Provide to identify the specific subaccount from request |
| x-language | any Provide to identify the locale from the content |
Request Body schema: application/jsonrequired
| targetLocales required | Array of strings non-empty Target language codes for translation (e.g. ["en","pt"]). |
Responses
Request samples
- Payload
{- "targetLocales": [
- "string"
]
}FindTeamViewController_handle
Authorizations:
path Parameters
| id required | string Example: 1661452472991 |
query Parameters
| locale | string Examples:
Locale override (e.g. en, pt, es). Has priority over team.default_locale |
header Parameters
| x-workspace-id | any Provide to identify the specific workspace from request |
| x-subaccount-id | any Provide to identify the specific subaccount from request |
| x-language | any Provide to identify the locale from the content |
Responses
Response samples
- 200
{- "positions": [
- {
- "_id": "6501d432afe2730012f74d68",
- "track": "6501d432afe2730012f74d68",
- "category": "6501d432afe2730012f74d68",
- "name": "Senior Developer",
- "description": "Lead technical initiatives",
- "order": 1,
- "label": "Sr. Dev",
- "seniority_level": 3,
- "vertical_level": 2,
- "skills_count": 5,
- "salary": {
- "min": 50000,
- "max": 80000,
- "currency": "USD"
}, - "users_count": 10
}
], - "categories": [
- {
- "_id": "6501d432afe2730012f74d68",
- "name": "Engineering",
- "order": 1
}
], - "tracks": [
- {
- "_id": "6501d432afe2730012f74d68",
- "name": "Engineering Track",
- "description": "Technical career path",
- "order": 1,
- "category": "6501d432afe2730012f74d68",
- "positions": [
- "6501d432afe2730012f74d68",
- "6501d432afe2730012f74d69"
]
}
], - "requirements": [
- {
- "_id": "6501d432afe2730012f74d68",
- "position": "6501d432afe2730012f74d68",
- "skill_variant": "6501d432afe2730012f74d68",
- "skill_level": "6501d432afe2730012f74d68",
- "order": 1
}
], - "skills": [
- {
- "_id": "6501d432afe2730012f74d68",
- "skill_variant": "6501d432afe2730012f74d68",
- "category": "6501d432afe2730012f74d68",
- "order": 1
}
], - "skill_variants": [
- {
- "_id": "6501d432afe2730012f74d68",
- "name": "JavaScript Proficiency",
- "levels": [
- {
- "_id": "6501d432afe2730012f74d68",
- "level": 1,
- "name": "Beginner",
- "description": "Can perform basic tasks"
}
], - "skill": {
- "_id": "6501d432afe2730012f74d68",
- "name": "React",
- "description": "A JavaScript library for building UI",
- "icon": "react-icon",
- "translated_content": { }
}
}
], - "users": [
- {
- "_id": "6501d432afe2730012f74d68",
- "displayName": "John Doe",
- "position": "6501d432afe2730012f74d68"
}
]
}FindTeamPositionsTreeController_handle
Authorizations:
query Parameters
| team | string |
| status | Array of strings Filter positions by status |
| show_empty required | boolean |
header Parameters
| x-workspace-id | any Provide to identify the specific workspace from request |
| x-subaccount-id | any Provide to identify the specific subaccount from request |
| x-language | any Provide to identify the locale from the content |
Responses
Response samples
- 200
{- "tracks": [
- {
- "_id": "6501d432afe2730012f74d68",
- "name": "Engineering Track",
- "description": "Technical career path",
- "teamId": "6501d432afe2730012f74d68",
- "teamName": "Engineering Team",
- "teamDescription": "Team description",
- "positions": [
- {
- "_id": "6501d432afe2730012f74d68",
- "name": "Senior Developer",
- "description": "Lead technical initiatives"
}
]
}
]
}UpdateOrderingController_handle
Authorizations:
path Parameters
| id required | string Example: 61b8e9bb2300e80010c0bcc2 |
header Parameters
| x-workspace-id | any Provide to identify the specific workspace from request |
| x-subaccount-id | any Provide to identify the specific subaccount from request |
| x-language | any Provide to identify the locale from the content |
Request Body schema: application/jsonrequired
| kind | string Enum: "position" "team" "category" |
Array of objects |
Responses
Request samples
- Payload
{- "kind": "category",
- "ordering": [
- {
- "_id": "61b8e9bb2300e80010c0bcc2",
- "order": 1
}
]
}FindPositionUsersController_handle
Authorizations:
path Parameters
| id required | string Example: 1661452472991 |
| positionId required | string Example: 1661452472991 |
query Parameters
| order | string Default: "desc" Enum: "asc" "desc" |
| orderBy | string Default: "_id" |
| offset | number >= 0 Default: 0 |
| page | number >= 1 Default: 1 |
| pageSize | number [ 1 .. 2000 ] Default: 20 |
| limit | number [ 0 .. 2000 ] Default: 20 |
| search | string |
header Parameters
| x-workspace-id | any Provide to identify the specific workspace from request |
| x-subaccount-id | any Provide to identify the specific subaccount from request |
| x-language | any Provide to identify the locale from the content |
Responses
Response samples
- 200
{- "docs": [
- {
- "_id": "6501d432afe2730012f74d68",
- "displayName": "John Doe",
- "email": "john.doe@example.com",
}
], - "totalDocs": 50,
- "limit": 10,
- "totalPages": 5,
- "page": 1,
- "pagingCounter": 1,
- "hasPrevPage": false,
- "hasNextPage": true,
- "prevPage": null,
- "nextPage": 2
}UpdatePositionUsersController_handle
Authorizations:
path Parameters
| id required | string Example: 61b8e9bb2300e80010c0bcc2 |
| positionId required | string Example: 61b8e9bb2300e80010c0bcc2 |
header Parameters
| x-workspace-id | any Provide to identify the specific workspace from request |
| x-subaccount-id | any Provide to identify the specific subaccount from request |
| x-language | any Provide to identify the locale from the content |
Request Body schema: application/jsonrequired
| ids | Array of objects (ObjectId) Array of ids |
| users | object user for has bean created and invited |
Responses
Request samples
- Payload
{- "ids": [
- { }
], - "users": { }
}FindTeamUsersController_handle
Authorizations:
path Parameters
| id required | string Example: 1661452472991 |
query Parameters
| order | string Default: "desc" Enum: "asc" "desc" |
| orderBy | string Default: "_id" |
| offset | number >= 0 Default: 0 |
| page | number >= 1 Default: 1 |
| pageSize | number [ 1 .. 2000 ] Default: 20 |
| limit | number [ 0 .. 2000 ] Default: 20 |
| search | string |
| query required | string |
| position | Array of strings |
header Parameters
| x-workspace-id | any Provide to identify the specific workspace from request |
| x-subaccount-id | any Provide to identify the specific subaccount from request |
| x-language | any Provide to identify the locale from the content |
Responses
Response samples
- 200
{- "docs": [
- {
- "_id": "6501d432afe2730012f74d68",
- "displayName": "John Doe",
- "email": "john.doe@example.com",
- "roles": [
- "user",
- "manager"
], - "status": "active",
- "last_login": "2019-08-24T14:15:22Z",
- "invited_date": "2019-08-24T14:15:22Z",
- "created": "2019-08-24T14:15:22Z",
- "position": "Senior Developer",
- "track": "Engineering Track",
- "skills_count": 5,
- "status_formatted": {
- "value": "active",
- "label": "Active"
}, - "roles_formatted": [
- {
- "value": "active",
- "label": "Active"
}
]
}
], - "totalDocs": 50,
- "limit": 10,
- "totalPages": 5,
- "page": 1,
- "pagingCounter": 1,
- "hasPrevPage": false,
- "hasNextPage": true,
- "prevPage": null,
- "nextPage": 2
}FindUserController_handle
Authorizations:
path Parameters
| id required | string Example: 1661452472991 |
| userId required | string Example: 1661452472991 |
header Parameters
| x-workspace-id | any Provide to identify the specific workspace from request |
| x-subaccount-id | any Provide to identify the specific subaccount from request |
| x-language | any Provide to identify the locale from the content |
Responses
Response samples
- 200
{- "_id": "6501d432afe2730012f74d68",
- "displayName": "John Doe",
- "email": "john.doe@example.com",
- "roles": [
- "user",
- "manager"
], - "status": "active",
- "last_login": "2019-08-24T14:15:22Z",
- "invited_date": "2019-08-24T14:15:22Z",
- "created": "2019-08-24T14:15:22Z",
- "position": "Senior Developer",
- "track": "Engineering Track",
- "skills_count": 0,
- "status_formatted": {
- "value": "active",
- "label": "Active"
}, - "roles_formatted": [
- {
- "value": "active",
- "label": "Active"
}
]
}Delete user from team
Authorizations:
path Parameters
| id required | string Example: 61b8e9bb2300e80010c0bcc2 |
header Parameters
| x-workspace-id | any Provide to identify the specific workspace from request |
| x-subaccount-id | any Provide to identify the specific subaccount from request |
| x-language | any Provide to identify the locale from the content |
Request Body schema: application/jsonrequired
| ids required | Array of objects (ObjectId) Array of ids |
Responses
Request samples
- Payload
{- "ids": [
- { }
]
}Create a track for a career team
Authorizations:
path Parameters
| id required | string Example: 1661452472991 |
header Parameters
| x-workspace-id | any Provide to identify the specific workspace from request |
| x-subaccount-id | any Provide to identify the specific subaccount from request |
| x-language | any Provide to identify the locale from the content |
Request Body schema: application/jsonrequired
required | object Translated content for track |
| assessment_id required | object Assessment id |
Responses
Request samples
- Payload
{- "translated_content": {
- "pt": {
- "name": "string",
- "description": "string"
}, - "en": {
- "name": "string",
- "description": "string"
}, - "es": {
- "name": "string",
- "description": "string"
}
}, - "assessment_id": { }
}Delete team track and related data
Authorizations:
path Parameters
| id required | string Example: 61b8e9bb2300e80010c0bcc2 |
header Parameters
| x-workspace-id | any Provide to identify the specific workspace from request |
| x-subaccount-id | any Provide to identify the specific subaccount from request |
| x-language | any Provide to identify the locale from the content |
Request Body schema: application/jsonrequired
| ids required | Array of objects (ObjectId) Array of ids |
Responses
Request samples
- Payload
{- "ids": [
- { }
]
}FindTrackController_handle
Authorizations:
path Parameters
| id required | string Example: 1661452472991 |
| trackId required | object (ObjectId) |
header Parameters
| x-workspace-id | any Provide to identify the specific workspace from request |
| x-subaccount-id | any Provide to identify the specific subaccount from request |
| x-language | any Provide to identify the locale from the content |
Responses
Response samples
- 200
{- "_id": "6501d432afe2730012f74d68",
- "team": "6501d432afe2730012f74d68",
- "name": "Engineering Track",
- "order": 1,
- "description": "Technical career progression",
- "translated_content": {
- "pt": {
- "name": "Trilha de Engenharia",
- "description": "Progressao..."
}
}, - "assessment_id": "6501d432afe2730012f74d68",
- "positions": [
- "6501d432afe2730012f74d68",
- "6501d432afe2730012f74d69"
]
}UpdateTrackController_handle
Authorizations:
path Parameters
| id required | string Example: 61b8e9bb2300e80010c0bcc2 |
| trackId required | string Example: 61b8e9bb2300e80010c0bcc2 |
header Parameters
| x-workspace-id | any Provide to identify the specific workspace from request |
| x-subaccount-id | any Provide to identify the specific subaccount from request |
| x-language | any Provide to identify the locale from the content |
Request Body schema: application/jsonrequired
required | object Translated content for track |
| assessment_id required | object Assessment id |
| _id required | object Track id |
Responses
Request samples
- Payload
{- "translated_content": {
- "pt": {
- "name": "string",
- "description": "string"
}, - "en": {
- "name": "string",
- "description": "string"
}, - "es": {
- "name": "string",
- "description": "string"
}
}, - "assessment_id": { },
- "_id": { }
}Create a position for a career team track
Authorizations:
path Parameters
| id required | string Example: 1661452472991 |
header Parameters
| x-workspace-id | any Provide to identify the specific workspace from request |
| x-subaccount-id | any Provide to identify the specific subaccount from request |
| x-language | any Provide to identify the locale from the content |
Request Body schema: application/jsonrequired
| seniority_level required | number >= 1 Seniority level |
| vertical_level required | number >= 1 Vertical level |
| track required | object Track id |
required | object Translated content for position |
| skill_variants | Array of objects (ObjectId) Position skills |
Responses
Request samples
- Payload
{- "seniority_level": 3,
- "vertical_level": 1,
- "track": { },
- "translated_content": {
- "pt": {
- "name": "string",
- "description": "string"
}, - "en": {
- "name": "string",
- "description": "string"
}, - "es": {
- "name": "string",
- "description": "string"
}
}, - "skill_variants": [
- { }
]
}Delete track position and related data
Authorizations:
path Parameters
| id required | string Example: 61b8e9bb2300e80010c0bcc2 |
header Parameters
| x-workspace-id | any Provide to identify the specific workspace from request |
| x-subaccount-id | any Provide to identify the specific subaccount from request |
| x-language | any Provide to identify the locale from the content |
Request Body schema: application/jsonrequired
| ids required | Array of objects (ObjectId) Array of ids |
Responses
Request samples
- Payload
{- "ids": [
- { }
]
}FindTrackPositionController_handle
Authorizations:
path Parameters
| id required | string Example: 1661452472991 |
| positionId required | object (ObjectId) |
query Parameters
| locale required | string |
header Parameters
| x-workspace-id | any Provide to identify the specific workspace from request |
| x-subaccount-id | any Provide to identify the specific subaccount from request |
| x-language | any Provide to identify the locale from the content |
Responses
Response samples
- 200
{- "position": {
- "_id": "6501d432afe2730012f74d68",
- "name": "Senior Developer",
- "label": "Sr. Dev",
- "description": "Lead technical initiatives",
- "translated_content": { },
- "order": 1,
- "track": "6501d432afe2730012f74d68",
- "assessment_id": "6501d432afe2730012f74d68",
- "seniority_level": 3,
- "vertical_level": 2,
- "salary": {
- "min": 50000,
- "max": 80000,
- "currency": "USD"
}, - "skills": [
- {
- "_id": "6501d432afe2730012f74d68",
- "requirement": {
- "_id": "6501d432afe2730012f74d68",
- "position": "6501d432afe2730012f74d68",
- "skill_variant": "6501d432afe2730012f74d68",
- "skill_level": "6501d432afe2730012f74d68",
- "order": 1
}, - "skill": {
- "_id": "6501d432afe2730012f74d68",
- "name": "JavaScript",
- "description": "Programming language",
- "translated_content": { }
}, - "skill_level": {
- "_id": "6501d432afe2730012f74d68",
- "level": 1,
- "description": "Basic understanding",
- "events": [
- "Completed training"
], - "translated_content": { }
}
}
]
}
}UpdateTrackPositionController_handle
Authorizations:
path Parameters
| id required | string Example: 61b8e9bb2300e80010c0bcc2 |
| positionId required | string Example: 61b8e9bb2300e80010c0bcc2 |
header Parameters
| x-workspace-id | any Provide to identify the specific workspace from request |
| x-subaccount-id | any Provide to identify the specific subaccount from request |
| x-language | any Provide to identify the locale from the content |
Request Body schema: application/jsonrequired
| _id required | object Team ID |
| seniority_level required | number >= 1 Seniority level |
| vertical_level required | number >= 1 Vertical level |
| label required | string <= 50 characters Position label |
| hiring_link | string <uri> Hiring link |
| assessment_id required | object Assessment id |
object Salary | |
object Translated content for position | |
Array of objects (SkillRequirementDto) Skill variants with updated levels | |
Array of objects (SkillRequirementDto) New skill variants with levels |
Responses
Request samples
- Payload
{- "_id": "62b384d70309831f9c13c87d",
- "seniority_level": 3,
- "vertical_level": 1,
- "label": "Position 1 label",
- "assessment_id": { },
- "salary": {
- "from": 1000,
- "to": 2000,
- "currency": "USD"
}, - "translated_content": {
- "pt": {
- "name": "string",
- "description": "string"
}, - "en": {
- "name": "string",
- "description": "string"
}, - "es": {
- "name": "string",
- "description": "string"
}
}, - "requirements": [
- {
- "requirement": "62b384d70309831f9c13c87d",
- "level": "62b384d70309831f9c13c87d"
}
], - "new_skills": [
- {
- "requirement": "62b384d70309831f9c13c87d",
- "level": "62b384d70309831f9c13c87d"
}
]
}Create a category for a career team
Authorizations:
path Parameters
| id required | string Example: 1661452472991 |
header Parameters
| x-workspace-id | any Provide to identify the specific workspace from request |
| x-subaccount-id | any Provide to identify the specific subaccount from request |
| x-language | any Provide to identify the locale from the content |
Request Body schema: application/jsonrequired
required | object Translated content for category |
Responses
Request samples
- Payload
{- "translated_content": {
- "pt": {
- "name": "string",
- "description": "string"
}, - "en": {
- "name": "string",
- "description": "string"
}, - "es": {
- "name": "string",
- "description": "string"
}
}
}Delete team category and related data
Authorizations:
path Parameters
| id required | string Example: 61b8e9bb2300e80010c0bcc2 |
header Parameters
| x-workspace-id | any Provide to identify the specific workspace from request |
| x-subaccount-id | any Provide to identify the specific subaccount from request |
| x-language | any Provide to identify the locale from the content |
Request Body schema: application/jsonrequired
| ids required | Array of objects (ObjectId) Array of ids |
Responses
Request samples
- Payload
{- "ids": [
- { }
]
}FindTeamCategoryController_handle
Authorizations:
path Parameters
| id required | string Example: 1661452472991 |
| categoryId required | object (ObjectId) |
header Parameters
| x-workspace-id | any Provide to identify the specific workspace from request |
| x-subaccount-id | any Provide to identify the specific subaccount from request |
| x-language | any Provide to identify the locale from the content |
Responses
Response samples
- 200
{- "_id": "6501d432afe2730012f74d68",
- "name": "Engineering",
- "description": "Engineering department category",
- "translated_content": {
- "pt": {
- "name": "Engenharia",
- "description": "Categoria do departamento..."
}
}, - "order": 1
}UpdateTeamCategoryController_handle
Authorizations:
path Parameters
| id required | string Example: 61b8e9bb2300e80010c0bcc2 |
| categoryId required | string Example: 61b8e9bb2300e80010c0bcc2 |
header Parameters
| x-workspace-id | any Provide to identify the specific workspace from request |
| x-subaccount-id | any Provide to identify the specific subaccount from request |
| x-language | any Provide to identify the locale from the content |
Request Body schema: application/jsonrequired
required | object Translated content for category |
| _id required | object Category id |
Responses
Request samples
- Payload
{- "translated_content": {
- "pt": {
- "name": "string",
- "description": "string"
}, - "en": {
- "name": "string",
- "description": "string"
}, - "es": {
- "name": "string",
- "description": "string"
}
}, - "_id": { }
}Update a category skills
This endpoint allows you to update a category skills from a team. Any skill that is not present in the request will be removed from the category.
Authorizations:
path Parameters
| id required | string Example: 61b8e9bb2300e80010c0bcc2 |
| categoryId required | string Example: 61b8e9bb2300e80010c0bcc2 |
header Parameters
| x-workspace-id | any Provide to identify the specific workspace from request |
| x-subaccount-id | any Provide to identify the specific subaccount from request |
| x-language | any Provide to identify the locale from the content |
Request Body schema: application/jsonrequired
| ids required | Array of objects (ObjectId) Array of ids |
Responses
Request samples
- Payload
{- "ids": [
- { }
]
}Remove skills from a category
Authorizations:
path Parameters
| id required | string Example: 61b8e9bb2300e80010c0bcc2 |
| categoryId required | string Example: 61b8e9bb2300e80010c0bcc2 |
header Parameters
| x-workspace-id | any Provide to identify the specific workspace from request |
| x-subaccount-id | any Provide to identify the specific subaccount from request |
| x-language | any Provide to identify the locale from the content |
Request Body schema: application/jsonrequired
| ids required | Array of objects (ObjectId) Array of ids |
Responses
Request samples
- Payload
{- "ids": [
- { }
]
}Create a requirement for a career team
Authorizations:
path Parameters
| id required | string Example: 61b8e9bb2300e80010c0bcc2 |
header Parameters
| x-workspace-id | any Provide to identify the specific workspace from request |
| x-subaccount-id | any Provide to identify the specific subaccount from request |
| x-language | any Provide to identify the locale from the content |
Request Body schema: application/jsonrequired
| skill_variant required | object Skill variant id |
| position required | object Position id |
| skill_level required | number Level id |
| fill required | boolean Fill out the remaining positions with the same requirement |
Responses
Request samples
- Payload
{- "skill_variant": { },
- "position": { },
- "skill_level": 0,
- "fill": true
}Delete team requirements
Authorizations:
path Parameters
| id required | string Example: 61b8e9bb2300e80010c0bcc2 |
header Parameters
| x-workspace-id | any Provide to identify the specific workspace from request |
| x-subaccount-id | any Provide to identify the specific subaccount from request |
| x-language | any Provide to identify the locale from the content |
Request Body schema: application/jsonrequired
| ids required | Array of objects (ObjectId) Array of ids |
Responses
Request samples
- Payload
{- "ids": [
- { }
]
}UpdateRequirementController_handle
Authorizations:
path Parameters
| id required | string Example: 61b8e9bb2300e80010c0bcc2 |
| requirementId required | string Example: 61b8e9bb2300e80010c0bcc2 |
header Parameters
| x-workspace-id | any Provide to identify the specific workspace from request |
| x-subaccount-id | any Provide to identify the specific subaccount from request |
| x-language | any Provide to identify the locale from the content |
Request Body schema: application/jsonrequired
| _id required | object Requirement id |
| skill_variant required | object Skill variant id |
| skill_level required | number Level id |
Responses
Request samples
- Payload
{- "_id": { },
- "skill_variant": { },
- "skill_level": 0
}AttachSkillVariantController_handle
Authorizations:
path Parameters
| id required | string Example: 61b8e9bb2300e80010c0bcc2 |
header Parameters
| x-workspace-id | any Provide to identify the specific workspace from request |
| x-subaccount-id | any Provide to identify the specific subaccount from request |
| x-language | any Provide to identify the locale from the content |
Request Body schema: application/jsonrequired
Responses
Request samples
- Payload
[- "string"
]Delete team skill and related data
Authorizations:
path Parameters
| id required | string Example: 61b8e9bb2300e80010c0bcc2 |
header Parameters
| x-workspace-id | any Provide to identify the specific workspace from request |
| x-subaccount-id | any Provide to identify the specific subaccount from request |
| x-language | any Provide to identify the locale from the content |
Request Body schema: application/jsonrequired
| ids required | Array of objects (ObjectId) Array of ids |
Responses
Request samples
- Payload
{- "ids": [
- { }
]
}FindCategorySkillsController_handle
Authorizations:
query Parameters
| team | string |
| locale required | string |
header Parameters
| x-workspace-id | any Provide to identify the specific workspace from request |
| x-subaccount-id | any Provide to identify the specific subaccount from request |
| x-language | any Provide to identify the locale from the content |
Responses
Response samples
- 200
{- "categories": [
- {
- "_id": "6501d432afe2730012f74d68",
- "name": "Programming Languages",
- "skill_variants": [
- {
- "_id": "6501d432afe2730012f74d68",
- "name": "JavaScript",
- "level": "6501d432afe2730012f74d68",
- "category": "6501d432afe2730012f74d68"
}
]
}
]
}Sync analysis plans for all teams in the workspace
Authorizations:
header Parameters
| x-workspace-id | any Provide to identify the specific workspace from request |
| x-subaccount-id | any Provide to identify the specific subaccount from request |
| x-language | any Provide to identify the locale from the content |
Responses
ExportCareersController_list
Authorizations:
query Parameters
| author | Array of any |
| order | string Default: "desc" Enum: "asc" "desc" |
| orderBy | string Default: "_id" |
| offset | number >= 0 Default: 0 |
| page | number >= 1 Default: 1 Example: page=1 |
| pageSize | number [ 1 .. 2000 ] Default: 20 Example: pageSize=10 |
| limit | number [ 0 .. 2000 ] Default: 20 |
| status | string Example: status=published |
| grouping | string Enum: "results" "invited" Grouping by status. Cannot be used with status query |
| search | string |
| query | string Base64-encoded JSONLogic filter tree. Supported fields: status, author. |
| locale | string Examples:
Locale override (e.g. en, pt, es). Has priority over team.default_locale |
header Parameters
| x-workspace-id | any Provide to identify the specific workspace from request |
| x-subaccount-id | any Provide to identify the specific subaccount from request |
| x-language | any Provide to identify the locale from the content |
Responses
Response samples
- 200
{- "docs": [
- {
- "id": "6501d432afe2730012f74d68",
- "name": "Career name",
- "status": "published",
- "status_formatted": "Publicado",
- "author": "John Doe",
- "users_count": 5,
- "created": "2024-01-01 12:00:00",
- "archived_date": "2024-02-01 12:00:00"
}
], - "limit": 10,
- "page": 1,
- "totalPages": 3,
- "totalDocs": 25,
- "hasNextPage": true,
- "hasPrevPage": false,
- "prevPage": null,
- "nextPage": 2
}ExportCareersController_exportCsv
Authorizations:
header Parameters
| x-workspace-id | any Provide to identify the specific workspace from request |
| x-subaccount-id | any Provide to identify the specific subaccount from request |
| x-language | any Provide to identify the locale from the content |
Request Body schema: application/jsonrequired
| search | string Full-text search across team name/description |
| query | string Base64-encoded JSONLogic filter tree. Supported fields: status, author. |
| author | Array of strings Filter by author ids |
| status | Array of strings Filter by status |
| locale | string Locale override (e.g. en, pt, es). Has priority over team.default_locale |
Responses
Request samples
- Payload
{- "search": "string",
- "query": "string",
- "author": [
- "string"
], - "status": [
- "string"
], - "locale": "string"
}Response samples
- 200
[- {
- "filename": "export.csv",
- "data": "id;name;status"
}
]Talents Fields
Handle GET search_fields.
header Parameters
| x-workspace-id | any |
| x-subaccount-id | any |
| x-language | any |
Responses
Response samples
- 200
{- "type": [
- {
- "value": "backend",
- "label": "Back-end"
}
], - "looking_for": [
- {
- "value": "backend",
- "label": "Back-end"
}
], - "home_office": [
- {
- "value": "backend",
- "label": "Back-end"
}
], - "steps": [
- {
- "value": "backend",
- "label": "Back-end"
}
], - "status": [
- {
- "value": "backend",
- "label": "Back-end"
}
], - "languages": [
- {
- "value": "backend",
- "label": "Back-end"
}
], - "skills": [
- {
- "value": "backend",
- "label": "Back-end"
}
]
}Get Fields For Invite
Handle GET invite/fields.
header Parameters
| x-workspace-id | any |
| x-subaccount-id | any |
| x-language | any |
Responses
Response samples
- 200
{- "jobName": "Job title",
- "username": "Candidate's name",
- "companyName": "Company name",
- "inviteLink": "Vacancy URL on the Coodesh platform"
}Get all DISC personalities
Returns all 112 DISC personality traits used in test questions. Each personality has a term and is mapped to DISC dimensions (D, I, S, C).
header Parameters
| x-workspace-id | any Provide to identify the specific workspace from request |
| x-subaccount-id | any Provide to identify the specific subaccount from request |
| x-language | any Provide to identify the locale from the content |
Responses
Response samples
- 200
[- {
- "id": 1,
- "no": 1,
- "term": "Enthusiastic",
- "most": "C",
- "least": "C"
}
]Get all DISC patterns
Returns all 14 DISC personality patterns. These are the result types that describe complete personality profiles.
header Parameters
| x-workspace-id | any Provide to identify the specific workspace from request |
| x-subaccount-id | any Provide to identify the specific subaccount from request |
| x-language | any Provide to identify the locale from the content |
Responses
Response samples
- 200
[- {
- "id": 1,
- "name": "Dominante",
- "emotions": "Determinação, urgência, foco em resultados",
- "goal": "Alcançar metas e obter resultados rápidos",
- "judges_others": "Julgam pelo desempenho e resultados",
- "influences_others": "Impõem decisões e definem diretrizes",
- "organization_value": "Fornece direção e acelerações estratégicas",
- "overuses": "Pode parecer insensível ou impaciente",
- "under_pressure": "Sob pressão tende a ser autoritário e agressivo",
- "fear": "Perder o controle ou falhar nas metas",
- "effectiveness": "Mais eficaz com autonomia e objetivos claros",
- "description": "Perfil direto, rápido a tomar decisões; prefere ação à análise detalhada."
}
]FindAssessmentsController_handle
Authorizations:
query Parameters
| _id | Array of strings |
| skills | Array of any |
| author | Array of any |
| language | Array of any |
| career required | Array of strings |
| order | string Default: "desc" Enum: "asc" "desc" |
| orderBy | string Default: "_id" |
| offset | number >= 0 Default: 0 |
| page | number >= 1 Default: 1 Example: page=1 |
| pageSize | number [ 1 .. 2000 ] Default: 20 Example: pageSize=10 |
| limit | number [ 0 .. 2000 ] Default: 20 |
| status | string Example: status=published |
| search | string |
| query | string Base64-encoded JSONLogic filter tree. Supported fields: status, author, skills, language, career, company. |
header Parameters
| x-workspace-id | any Provide to identify the specific workspace from request |
| x-subaccount-id | any Provide to identify the specific subaccount from request |
| x-language | any Provide to identify the locale from the content |
Responses
Response samples
- 200
{- "docs": [
- {
- "_id": "6501d432afe2730012f74d68",
- "name": "Frontend Developer Assessment",
- "slug": "frontend-developer-assessment",
- "status": "published",
- "created": "2019-08-24T14:15:22Z",
- "archived_date": "2019-08-24T14:15:22Z",
- "last_update": "2019-08-24T14:15:22Z",
- "usage_count": 10,
- "questions_count": 5,
- "duration": 60,
- "duration_unit": "minutes",
- "author": {
- "_id": "6501d432afe2730012f74d68",
- "displayName": "Jane Smith"
}, - "career": "string",
- "company": "string",
- "settings": {
- "invites_expiration": 0,
- "assess_team": true,
- "is_public": "string",
- "locales": [
- "string"
]
}, - "links": [
- { }
], - "language": "English"
}
], - "totalDocs": 50,
- "limit": 10,
- "totalPages": 5,
- "page": 1,
- "pagingCounter": 1,
- "hasPrevPage": false,
- "hasNextPage": true,
- "prevPage": null,
- "nextPage": 2
}Delete assessments
Delete assessments
Authorizations:
header Parameters
| x-workspace-id | any Provide to identify the specific workspace from request |
| x-subaccount-id | any Provide to identify the specific subaccount from request |
| x-language | any Provide to identify the locale from the content |
Request Body schema: application/jsonrequired
| ids required | Array of objects (ObjectId) Array of ids |
Responses
Request samples
- Payload
{- "ids": [
- { }
]
}UploadMediaController_uploadFile
Authorizations:
path Parameters
| id required | string Example: 61b8e9bb2300e80010c0bcc2 |
header Parameters
| x-workspace-id | any Provide to identify the specific workspace from request |
| x-subaccount-id | any Provide to identify the specific subaccount from request |
| x-language | any Provide to identify the locale from the content |
Responses
UploadMediaController_deleteFile
Authorizations:
path Parameters
| id required | string Example: 61b8e9bb2300e80010c0bcc2 |
header Parameters
| x-workspace-id | any Provide to identify the specific workspace from request |
| x-subaccount-id | any Provide to identify the specific subaccount from request |
| x-language | any Provide to identify the locale from the content |
Responses
UpdateAssessmentController_handle
Authorizations:
path Parameters
| id required | string Example: 61b8e9bb2300e80010c0bcc2 |
header Parameters
| x-workspace-id | any Provide to identify the specific workspace from request |
| x-subaccount-id | any Provide to identify the specific subaccount from request |
| x-language | any Provide to identify the locale from the content |
Request Body schema: application/jsonrequired
| company required | object Indicates which company owns the assessment |
| name required | string Internal name of assessment |
| skills required | object Indicates the skills covered in the assessment |
| career required | object Related career code |
required | Array of objects (IQuestionDto) List of questions/challenges and respective settings |
required | object (SettingsDto) |
| last_interaction required | string <date-time> Date of last sending of invitations |
| duration required | number Sum of assessments_questoins |
| duration_unit | string Enum: "minute" "hour" "day" Duration unit |
| status required | string Enum: "draft" "published" "archived" Assessment status |
| author required | object User that created this Assessment |
| subaccount_ids required | Array of objects (ObjectId) Workspaces that this assessment belongs to |
Responses
Request samples
- Payload
{- "company": "62b5faff5a80481c2cba4669",
- "name": "Coodesh Assessment",
- "skills": [
- "62b384d70309831f9c13c87d",
- "62b5faff5a80481c2cba4669"
], - "career": "62b5faff5a80481c2cba4669",
- "questions": [
- {
- "question": "string",
- "weight": 0,
- "min_score": 0,
- "max_score": 0,
- "random_questions": 0,
- "duration": 0,
- "has_video": true,
- "enable_network": true,
- "shuffle_questions": true,
- "adaptative_testing": true,
- "accepted_languages": [
- "string"
]
}
], - "settings": {
- "invites_expiration": 120,
- "retry_interval": "15",
- "keep_tags": true,
- "assess_team": true,
- "is_public": "hidden",
- "hidden_results": true,
- "shuffle_questions": true,
- "hidden_question_titles": true,
- "tags": [
- "62b384d70309831f9c13c87d",
- "62b5faff5a80481c2cba4669"
], - "grade_tags": [
- {
- "threshold_high": 0,
- "threshold_low": 0,
- "tag": { }
}
], - "reminder_emails": {
- "title": "string",
- "key": "string",
- "subject": "string",
- "message": "string",
- "value": "string"
}, - "reminder_emails_schedule": {
- "template": "string",
- "value": "string",
- "unit": "days"
}, - "design": {
- "custom_name": "Coodesh Assessment",
- "initial_message": "string",
- "final_message": "string",
- "mobile_support": true
}, - "anticheat": {
- "track_copy_paste": true,
- "track_copy_paste_warn_examinee": true,
- "track_tab_switch": true,
- "track_tab_switch_warn_examinee": true,
- "track_fullscreen_switch": true,
- "photo_identification": true,
- "ia_webcam_image_detection": true,
- "webcam_proctoring": true,
- "audio_proctoring": true,
- "ia_plagiarism_detection": true,
- "detect_monitors": true,
- "screen_proctoring": true
}, - "timezone": "string",
- "goals": "string",
- "email_sender": "62b5faff5a80481c2cba4669",
- "locales": { },
- "callback_url": "string",
- "redirect_timeout": 30,
- "job_id": "string",
- "disable_email_notification": true,
- "generate_certificate": true,
- "generate_certificate_threshold": 0,
- "notification_recipients": [
- "user@example.com"
], - "time_open_enabled": true,
- "time_open": "2019-08-24T14:15:22Z",
- "time_close_enabled": true,
- "time_close": "2019-08-24T14:15:22Z",
- "enable_new_attempt_previous_answers": true,
- "enable_simultaneous_answers_start": true,
- "tools": { }
}, - "last_interaction": "Thu, 25 Aug 2022 11:25:35 GMT",
- "duration": 60,
- "duration_unit": "minute",
- "status": "published",
- "author": "62b5faff5a80481c2cba4669",
- "subaccount_ids": [
- "62b384d70309831f9c13c87d",
- "62b5faff5a80481c2cba4669"
]
}FindLinksByIdAssessmentController_handle
path Parameters
| id required | string Example: 61b8e9bb2300e80010c0bcc2 |
header Parameters
| x-workspace-id | any Provide to identify the specific workspace from request |
| x-subaccount-id | any Provide to identify the specific subaccount from request |
| x-language | any Provide to identify the locale from the content |
Responses
Response samples
- 200
[- {
- "name": "John Doe",
- "email": "john.doe@example.com",
- "status": "invited",
- "invite_date": "2019-08-24T14:15:22Z",
}
]DuplicateAssessmentsController_handle
Authorizations:
path Parameters
| id required | string Example: 61b8e9bb2300e80010c0bcc2 |
header Parameters
| x-workspace-id | any Provide to identify the specific workspace from request |
| x-subaccount-id | any Provide to identify the specific subaccount from request |
| x-language | any Provide to identify the locale from the content |
Request Body schema: application/jsonrequired
| name required | string |
| description required | string |
Responses
Request samples
- Payload
{- "name": "string",
- "description": "string"
}FindAssessmentsStatisticsController_handle
Authorizations:
header Parameters
| x-workspace-id | any Provide to identify the specific workspace from request |
| x-subaccount-id | any Provide to identify the specific subaccount from request |
| x-language | any Provide to identify the locale from the content |
Responses
Response samples
- 200
{- "metrics": {
- "total": 150,
- "week": 25,
- "month": 80,
- "average_score": 72.5,
- "average_time": 45
}, - "updated": "2019-08-24T14:15:22Z",
- "group_by": "date",
- "graph": [
- {
- "_id": "2024-01-15",
- "count": 10,
- "month": 1,
- "year": 2024,
- "day": 15,
- "date": "2024-01-15",
- "monthYear": "2024-01"
}
]
}FindStatisticByIdAssessmentController_handle
Authorizations:
path Parameters
| id required | string Example: 61b8e9bb2300e80010c0bcc2 |
header Parameters
| x-workspace-id | any Provide to identify the specific workspace from request |
| x-subaccount-id | any Provide to identify the specific subaccount from request |
| x-language | any Provide to identify the locale from the content |
Responses
Response samples
- 200
{- "metrics": {
- "total": 150,
- "week": 25,
- "month": 80,
- "average_score": 72.5,
- "average_time": 45
}, - "updated": "2019-08-24T14:15:22Z",
- "group_by": "date",
- "graph": [
- {
- "_id": "2024-01-15",
- "count": 10,
- "month": 1,
- "year": 2024,
- "day": 15,
- "date": "2024-01-15",
- "monthYear": "2024-01"
}
]
}Find assessment attempt result
Display assessment attempt result for assessment managers
Authorizations:
path Parameters
| attemptId required | string Example: 61b8e9bb2300e80010c0bcc2 |
| id required | string Example: 61b8e9bb2300e80010c0bcc2 |
query Parameters
| access_token | string |
header Parameters
| x-workspace-id | any Provide to identify the specific workspace from request |
| x-subaccount-id | any Provide to identify the specific subaccount from request |
| x-language | any Provide to identify the locale from the content |
Responses
Response samples
- 200
{- "_id": "6501d432afe2730012f74d68",
- "score": 85.5,
- "tags": [
- "string"
], - "answers": [
- {
- "_id": "6501d432afe2730012f74d68",
- "access_token": "abc123-access-token",
- "token": "abc123-token",
- "score": 85.5,
- "score_type": "percentage",
- "type": "coding",
- "started": "2019-08-24T14:15:22Z",
- "status": "finished",
- "finished": "2019-08-24T14:15:22Z",
- "finishedIn": 25,
- "level": "intermediate",
- "weight": 1,
- "duration": 30,
- "duration_unit": "minutes",
- "questions_count": 5,
- "can_open": true,
- "score_formatted": "85.5%",
- "type_formatted": "Coding",
- "has_certificate": true,
- "has_video": true,
- "question": {
- "_id": "6501d432afe2730012f74d68",
- "slug": "javascript-basics",
- "author": "string",
- "locale": "pt",
- "company": "string",
- "duration": 30,
- "duration_unit": "minutes",
- "level": "intermediate",
- "weight": 1,
- "level_formatted": "Intermediate",
- "questions_count": 5
}
}
], - "user": {
- "_id": "6501d432afe2730012f74d68",
- "displayName": "John Doe",
- "email": "john.doe@example.com",
}, - "assessment": {
- "_id": "6501d432afe2730012f74d68",
- "name": "Frontend Developer Assessment",
- "countQuestions": 10,
- "settings": { },
- "duration": 60,
- "duration_unit": "minutes",
- "status": "published"
}, - "proficiency": {
- "label": "Junior Developer",
- "team_id": "6501d432afe2730012f74d68",
- "track_id": "6501d432afe2730012f74d68",
- "position_id": "6501d432afe2730012f74d68",
- "recommendation_count": 5
}, - "certificate_status": "issued",
- "status": "finished",
- "started": "2019-08-24T14:15:22Z",
- "terms": "2019-08-24T14:15:22Z",
- "stage": "review",
- "invitation_date": "2019-08-24T14:15:22Z",
- "invitation_token": "abc123-invitation-token",
- "inviter": "string",
- "created": "2019-08-24T14:15:22Z",
- "updated": "2019-08-24T14:15:22Z",
- "access_token": "abc123-access-token",
- "finished": "2019-08-24T14:15:22Z",
- "totalScore": 100,
- "reopen_date": "2019-08-24T14:15:22Z",
- "finishedIn": 45,
- "proctoring": {
- "type": "snapshots",
- "content_removed_at": "2019-08-24T14:15:22Z",
- "snapshots": [
]
}, - "whitelabel": {
- "_id": "6501d432afe2730012f74d68",
- "name": "Company Name",
- "primaryColor": "#3B82F6"
}, - "can_export": true
}
Find assessment attempt result
Display assessment attempt result for assessment managers
Authorizations:
path Parameters
| attemptId required | string Example: 61b8e9bb2300e80010c0bcc2 |
| id required | string Example: 61b8e9bb2300e80010c0bcc2 |
query Parameters
| access_token | string |
header Parameters
| x-workspace-id | any Provide to identify the specific workspace from request |
| x-subaccount-id | any Provide to identify the specific subaccount from request |
| x-language | any Provide to identify the locale from the content |
Responses
Response samples
- 200
{- "_id": "6501d432afe2730012f74d68",
- "score": 85.5,
- "tags": [
- "string"
], - "answers": [
- {
- "_id": "6501d432afe2730012f74d68",
- "access_token": "abc123-access-token",
- "token": "abc123-token",
- "score": 85.5,
- "score_type": "percentage",
- "type": "coding",
- "started": "2019-08-24T14:15:22Z",
- "status": "finished",
- "finished": "2019-08-24T14:15:22Z",
- "finishedIn": 25,
- "level": "intermediate",
- "weight": 1,
- "duration": 30,
- "duration_unit": "minutes",
- "questions_count": 5,
- "can_open": true,
- "score_formatted": "85.5%",
- "type_formatted": "Coding",
- "has_certificate": true,
- "has_video": true,
- "question": {
- "_id": "6501d432afe2730012f74d68",
- "slug": "javascript-basics",
- "author": "string",
- "locale": "pt",
- "company": "string",
- "duration": 30,
- "duration_unit": "minutes",
- "level": "intermediate",
- "weight": 1,
- "level_formatted": "Intermediate",
- "questions_count": 5
}
}
], - "user": {
- "_id": "6501d432afe2730012f74d68",
- "displayName": "John Doe",
- "email": "john.doe@example.com",
}, - "assessment": {
- "_id": "6501d432afe2730012f74d68",
- "name": "Frontend Developer Assessment",
- "countQuestions": 10,
- "settings": { },
- "duration": 60,
- "duration_unit": "minutes",
- "status": "published"
}, - "proficiency": {
- "label": "Junior Developer",
- "team_id": "6501d432afe2730012f74d68",
- "track_id": "6501d432afe2730012f74d68",
- "position_id": "6501d432afe2730012f74d68",
- "recommendation_count": 5
}, - "certificate_status": "issued",
- "status": "finished",
- "started": "2019-08-24T14:15:22Z",
- "terms": "2019-08-24T14:15:22Z",
- "stage": "review",
- "invitation_date": "2019-08-24T14:15:22Z",
- "invitation_token": "abc123-invitation-token",
- "inviter": "string",
- "created": "2019-08-24T14:15:22Z",
- "updated": "2019-08-24T14:15:22Z",
- "access_token": "abc123-access-token",
- "finished": "2019-08-24T14:15:22Z",
- "totalScore": 100,
- "reopen_date": "2019-08-24T14:15:22Z",
- "finishedIn": 45,
- "proctoring": {
- "type": "snapshots",
- "content_removed_at": "2019-08-24T14:15:22Z",
- "snapshots": [
]
}, - "whitelabel": {
- "_id": "6501d432afe2730012f74d68",
- "name": "Company Name",
- "primaryColor": "#3B82F6"
}, - "can_export": true
}Please use bulk send email endpoint instead of this endpoint Deprecated
Send invite to participants by assessment id. The attempts had been created before, using CreateAssessmentAttempts endpoint.
Authorizations:
path Parameters
| id required | string Example: 61b8e9bb2300e80010c0bcc2 |
header Parameters
| x-workspace-id | any Provide to identify the specific workspace from request |
| x-subaccount-id | any Provide to identify the specific subaccount from request |
| x-language | any Provide to identify the locale from the content |
Request Body schema: application/jsonrequired
| participants required | Array of strings Indicates the users that will receveid invite email |
Responses
Request samples
- Payload
{- "participants": [
- "62b384d70309831f9c13c87d",
- "62b5faff5a80481c2cba4669"
]
}Response samples
- 201
{ }ExportAssessmentResultsController_handle
Authorizations:
header Parameters
| x-workspace-id | any Provide to identify the specific workspace from request |
| x-subaccount-id | any Provide to identify the specific subaccount from request |
| x-language | any Provide to identify the locale from the content |
Request Body schema: application/jsonrequired
| startDate | string |
| endDate | string |
| action | string |
Responses
Request samples
- Payload
{- "startDate": "string",
- "endDate": "string",
- "action": "string"
}FindAssessmentsAuthorsController_handle
Authorizations:
header Parameters
| x-workspace-id | any Provide to identify the specific workspace from request |
| x-subaccount-id | any Provide to identify the specific subaccount from request |
| x-language | any Provide to identify the locale from the content |
Responses
Response samples
- 200
[- {
- "_id": "6501d432afe2730012f74d68",
- "label": "Jane Smith",
- "value": "6501d432afe2730012f74d68"
}
]FindAssessmentsSkillsController_handle
Authorizations:
query Parameters
| status | string Grouping by content ownership. Cannot be used with grouping |
| page | number Example: page=1 |
| pageSize | number Example: pageSize=10 |
| search | string |
header Parameters
| x-workspace-id | any Provide to identify the specific workspace from request |
| x-subaccount-id | any Provide to identify the specific subaccount from request |
| x-language | any Provide to identify the locale from the content |
Responses
Response samples
- 200
{- "docs": [
- {
- "_id": "6501d432afe2730012f74d68",
- "value": "6501d432afe2730012f74d68",
- "label": "JavaScript",
- "count": 15
}
], - "totalDocs": 50,
- "limit": 10,
- "totalPages": 5,
- "page": 1,
- "pagingCounter": 1,
- "hasPrevPage": false,
- "hasNextPage": true,
- "prevPage": null,
- "nextPage": 2
}FindAssessmentsListController_handle
Authorizations:
query Parameters
| order | string Default: "desc" Enum: "asc" "desc" |
| orderBy | string Default: "_id" |
| offset | number >= 0 Default: 0 |
| page | number >= 1 Default: 1 Example: page=1 |
| pageSize | number [ 1 .. 2000 ] Default: 20 Example: pageSize=10 |
| limit | number [ 0 .. 2000 ] Default: 20 |
| id | string |
| search | string |
| status | string Example: status=published |
header Parameters
| x-workspace-id | any Provide to identify the specific workspace from request |
| x-subaccount-id | any Provide to identify the specific subaccount from request |
| x-language | any Provide to identify the locale from the content |
Responses
Response samples
- 200
{- "docs": [
- {
- "_id": "6501d432afe2730012f74d68",
- "name": "Frontend Developer Assessment"
}
], - "totalDocs": 50,
- "limit": 10,
- "totalPages": 5,
- "page": 1,
- "pagingCounter": 1,
- "hasPrevPage": false,
- "hasNextPage": true,
- "prevPage": null,
- "nextPage": 2
}FindAssessmentsPeopleController_handle
Authorizations:
query Parameters
| order | string Default: "desc" Enum: "asc" "desc" |
| orderBy | string Default: "_id" |
| offset | number >= 0 Default: 0 |
| page | number >= 1 Default: 1 Example: page=1 |
| pageSize | number [ 1 .. 2000 ] Default: 20 Example: pageSize=10 |
| limit | number [ 0 .. 2000 ] Default: 20 |
| search | string |
| query required | string |
| status | string Example: status=invited |
| tags | Array of arrays |
header Parameters
| x-workspace-id | any Provide to identify the specific workspace from request |
| x-subaccount-id | any Provide to identify the specific subaccount from request |
| x-language | any Provide to identify the locale from the content |
Responses
Response samples
- 200
{- "docs": [
- {
- "_id": "6501d432afe2730012f74d68",
- "user": {
- "_id": "6501d432afe2730012f74d68",
- "displayName": "John Doe",
- "email": "john.doe@example.com",
}, - "assessment": {
- "_id": "6501d432afe2730012f74d68",
- "name": "Frontend Developer Assessment"
}, - "status": "invited",
- "status_formatted": "Invited",
- "stage": "review",
- "stage_formatted": "Review",
- "created": "2019-08-24T14:15:22Z",
- "started": "2019-08-24T14:15:22Z",
- "deadline": "2019-08-24T14:15:22Z",
- "invitation_date": "2019-08-24T14:15:22Z",
- "invitation_date_expire": "2019-08-24T14:15:22Z",
- "scheduled_date": "2019-08-24T14:15:22Z",
- "finished": "2019-08-24T14:15:22Z",
- "tags": [
- "string"
], - "unlock": true,
- "invite_email_sent": true,
- "score": 85.5,
- "custom_time_open": "2019-08-24T14:15:22Z",
- "custom_time_close": "2019-08-24T14:15:22Z",
- "severity_formatted": "low"
}
], - "totalDocs": 50,
- "limit": 10,
- "totalPages": 5,
- "page": 1,
- "pagingCounter": 1,
- "hasPrevPage": false,
- "hasNextPage": true,
- "prevPage": null,
- "nextPage": 2
}FindAssessmentAttemptsTagsController_handle
Authorizations:
query Parameters
| assessment required | Array of strings |
| status | string |
| page | number Example: page=1 |
| pageSize | number Example: pageSize=10 |
| search | string |
| grouping required | string |
header Parameters
| x-workspace-id | any Provide to identify the specific workspace from request |
| x-subaccount-id | any Provide to identify the specific subaccount from request |
| x-language | any Provide to identify the locale from the content |
Responses
Response samples
- 200
{- "docs": [
- {
- "_id": "6501d432afe2730012f74d68",
- "value": "6501d432afe2730012f74d68",
- "label": "Junior",
- "count": 10
}
], - "totalDocs": 50,
- "limit": 10,
- "totalPages": 5,
- "page": 1,
- "pagingCounter": 1,
- "hasPrevPage": false,
- "hasNextPage": true,
- "prevPage": null,
- "nextPage": 2
}Bulk delete assessment attempts
Company admins can delete only owned attempts.
Authorizations:
header Parameters
| x-workspace-id | any Provide to identify the specific workspace from request |
| x-subaccount-id | any Provide to identify the specific subaccount from request |
| x-language | any Provide to identify the locale from the content |
Request Body schema: application/jsonrequired
| ids required | Array of strings Array of assessment attempt IDs to delete |
Responses
Request samples
- Payload
{- "ids": [
- "507f1f77bcf86cd799439011",
- "507f191e810c19729de860ea"
]
}Send invite to participants
Send invite to participants by assessment id. The attempts had been created before, using CreateAssessmentAttempts endpoint.
Authorizations:
header Parameters
| x-workspace-id | any Provide to identify the specific workspace from request |
| x-subaccount-id | any Provide to identify the specific subaccount from request |
| x-language | any Provide to identify the locale from the content |
Request Body schema: application/jsonrequired
| ids required | Array of strings Indicates the users that will receveid invite email |
| send_at | string <date-time> (Notify date) Date to send email notification to users |
Responses
Request samples
- Payload
{- "ids": [
- "62b384d70309831f9c13c87d",
- "62b5faff5a80481c2cba4669"
], - "send_at": "2019-08-24T14:15:22Z"
}BulkUnlockAttemptsController_handle
Authorizations:
header Parameters
| x-workspace-id | any Provide to identify the specific workspace from request |
| x-subaccount-id | any Provide to identify the specific subaccount from request |
| x-language | any Provide to identify the locale from the content |
Request Body schema: application/jsonrequired
| ids required | Array of strings (Assessment attempt ids) |
Responses
Request samples
- Payload
{- "ids": [
- "string"
]
}Response samples
- 201
{ }Bulk recalculate assessment attempt scores
Recalculates scores for finished or blocked assessment attempts by their IDs or assessment IDs.
Authorizations:
header Parameters
| x-workspace-id | any Provide to identify the specific workspace from request |
| x-subaccount-id | any Provide to identify the specific subaccount from request |
| x-language | any Provide to identify the locale from the content |
Request Body schema: application/jsonrequired
| ids required | Array of strings (Assessment attempt ids) |
Responses
Request samples
- Payload
{- "ids": [
- "string"
]
}Bulk reopen assessment attempts
Authorizations:
header Parameters
| x-workspace-id | any Provide to identify the specific workspace from request |
| x-subaccount-id | any Provide to identify the specific subaccount from request |
| x-language | any Provide to identify the locale from the content |
Request Body schema: application/jsonrequired
| ids required | Array of strings (Assessment attempt ids) List of assessment attempt ids |
| duration required | number (Duration) >= 0 Duration in minutes |
| duration_unit | string (Duration unit) Enum: "minute" "hour" "day" Duration unit |
| keep_answers | boolean (Keep answers) Default: true Keep answers from previous attempt |
| reason | string (Reason) Reason for reopening attempts |
| notify | boolean (Send email notification) Send email notification to users |
| send_at | string <date-time> (Notify date) Date to send email notification to users |
Responses
Request samples
- Payload
{- "ids": [
- "string"
], - "duration": 0,
- "duration_unit": "minute",
- "keep_answers": true,
- "reason": "string",
- "notify": true,
- "send_at": "2019-08-24T14:15:22Z"
}Bulk send hidden assessment results to participants
Authorizations:
header Parameters
| x-workspace-id | any Provide to identify the specific workspace from request |
| x-subaccount-id | any Provide to identify the specific subaccount from request |
| x-language | any Provide to identify the locale from the content |
Request Body schema: application/jsonrequired
| ids required | Array of strings (Assessment attempt ids) non-empty List of assessment attempt ids to send results |
Responses
Request samples
- Payload
{- "ids": [
- "507f1f77bcf86cd799439011",
- "507f191e810c19729de860ea"
]
}Bulk update assessment attempts
Company admins can update only owned attempts.
Authorizations:
header Parameters
| x-workspace-id | any Provide to identify the specific workspace from request |
| x-subaccount-id | any Provide to identify the specific subaccount from request |
| x-language | any Provide to identify the locale from the content |
Request Body schema: application/jsonrequired
| ids required | Array of strings (Assessment attempt ids) |
| stage | string (Stage) Enum: "none" "evaluating" "completed" "reviewed" "invited" "interviewed" "offer_sent" "offer_declined" "dropout" "disqualified" "hired" ATS stage |
| invitation_date_expire | string <date-time> (Expiration invite date) |
| deadline | string <date-time> (Deadline) Deadline for the assessment attempt |
| custom_time_open | string <date-time> (Custom time open) |
| custom_time_close | string <date-time> (Custom time close) |
| reason | string (Reason) Reason for reopening attempts |
| integrity_settings | object (Integrity settings) |
| hidden_results | boolean (Hide results) |
Responses
Request samples
- Payload
{- "ids": [
- "string"
], - "stage": "none",
- "invitation_date_expire": "2019-08-24T14:15:22Z",
- "deadline": "2019-08-24T14:15:22Z",
- "custom_time_open": "2019-08-24T14:15:22Z",
- "custom_time_close": "2019-08-24T14:15:22Z",
- "reason": "string",
- "integrity_settings": { },
- "hidden_results": true
}FindAttemptsIdsByAssessmentCursorController_handle
Authorizations:
path Parameters
| assessmentId required | string Example: 61b8e9bb2300e80010c0bcc2 |
query Parameters
| status | string Example: status=invited Filter by status. Cannot be used with grouping query |
| grouping | string Enum: "results" "invited" Grouping by status. Cannot be used with status query |
| pageSize | number Example: pageSize=10 |
| page | number Example: page=1 |
header Parameters
| x-workspace-id | any Provide to identify the specific workspace from request |
| x-subaccount-id | any Provide to identify the specific subaccount from request |
| x-language | any Provide to identify the locale from the content |
Responses
Response samples
- 200
{- "docs": [
- {
- "_id": "6501d432afe2730012f74d68"
}
]
}FindAssessmentAttemptsInvitersController_handle
Authorizations:
query Parameters
| assessment required | Array of strings Example: assessment=61b8e9bb2300e80010c0bcc2 |
| status required | Array of strings |
| grouping required | string |
| search required | string |
header Parameters
| x-workspace-id | any Provide to identify the specific workspace from request |
| x-subaccount-id | any Provide to identify the specific subaccount from request |
| x-language | any Provide to identify the locale from the content |
Responses
Response samples
- 200
[- { }
]Close expired assessment attempts
Finds and closes all expired assessment attempts and answers. Super admin only.
Authorizations:
header Parameters
| x-workspace-id | any Provide to identify the specific workspace from request |
| x-subaccount-id | any Provide to identify the specific subaccount from request |
| x-language | any Provide to identify the locale from the content |
Responses
FindAttemptsByAssessmentController_handle
Authorizations:
path Parameters
| id required | string Example: 61b8e9bb2300e80010c0bcc2 |
query Parameters
| grouping | string Enum: "results" "invited" Grouping by status. Cannot be used with status query |
| search | string |
| query required | string |
| order | string Default: "desc" Enum: "asc" "desc" |
| orderBy | string Default: "_id" |
| offset | number >= 0 Default: 0 |
| page | number >= 1 Default: 1 Example: page=1 |
| pageSize | number [ 1 .. 2000 ] Default: 20 Example: pageSize=10 |
| limit | number [ 0 .. 2000 ] Default: 20 |
| status | string Example: status=invited Filter by status. Cannot be used with grouping query |
header Parameters
| x-workspace-id | any Provide to identify the specific workspace from request |
| x-subaccount-id | any Provide to identify the specific subaccount from request |
| x-language | any Provide to identify the locale from the content |
Responses
Response samples
- 200
{- "docs": [
- {
- "_id": "6501d432afe2730012f74d68",
- "user": {
- "_id": "6501d432afe2730012f74d68",
- "displayName": "John Doe",
- "email": "john.doe@example.com",
}, - "status": "finished",
- "status_formatted": "Finished",
- "stage": "review",
- "stage_formatted": "Review",
- "created": "2019-08-24T14:15:22Z",
- "started": "2019-08-24T14:15:22Z",
- "deadline": "2019-08-24T14:15:22Z",
- "invitation_date": "2019-08-24T14:15:22Z",
- "invitation_date_expire": "2019-08-24T14:15:22Z",
- "scheduled_date": "2019-08-24T14:15:22Z",
- "finished": "2019-08-24T14:15:22Z",
- "tags": [
- "string"
], - "unlock": true,
- "invite_email_sent": true,
- "score": 85.5,
- "custom_time_open": "2019-08-24T14:15:22Z",
- "custom_time_close": "2019-08-24T14:15:22Z",
- "severity_formatted": "low"
}
], - "totalDocs": 50,
- "limit": 10,
- "totalPages": 5,
- "page": 1,
- "pagingCounter": 1,
- "hasPrevPage": false,
- "hasNextPage": true,
- "prevPage": null,
- "nextPage": 2
}Bulk cancel scheduled assessment attempts
Authorizations:
header Parameters
| x-workspace-id | any Provide to identify the specific workspace from request |
| x-subaccount-id | any Provide to identify the specific subaccount from request |
| x-language | any Provide to identify the locale from the content |
Request Body schema: application/jsonrequired
| ids required | Array of strings (Assessment attempt ids) |
Responses
Request samples
- Payload
{- "ids": [
- "string"
]
}Bulk mark assessment attempts as finished
Authorizations:
header Parameters
| x-workspace-id | any Provide to identify the specific workspace from request |
| x-subaccount-id | any Provide to identify the specific subaccount from request |
| x-language | any Provide to identify the locale from the content |
Request Body schema: application/jsonrequired
| ids required | Array of strings (Assessment attempt ids) |
Responses
Request samples
- Payload
{- "ids": [
- "string"
]
}FindAttemptRecommendationController_handle
path Parameters
| attemptId required | string Example: 674f75b818637312ec70a6b6 |
query Parameters
| answerId | string Example: answerId=674f75b818637312ec70a6b6 |
header Parameters
| x-workspace-id | any Provide to identify the specific workspace from request |
| x-subaccount-id | any Provide to identify the specific subaccount from request |
| x-language | any Provide to identify the locale from the content |
Responses
Response samples
- 200
{- "recommendations": [
- {
- "_id": "6501d432afe2730012f74d68",
- "title": "Advanced JavaScript Course",
- "description": "Learn advanced JS concepts",
- "type": "course",
- "skills": [
- {
- "_id": "6501d432afe2730012f74d68",
- "name": "JavaScript"
}
]
}
], - "total": 5
}Save review for assessment answer
Used on dashboard to save the manual score on the assessment answer
Authorizations:
path Parameters
| id required | object (ObjectId) |
| token required | string Example: 19dbdf0e56e00123456789ab |
header Parameters
| x-workspace-id | any Provide to identify the specific workspace from request |
| x-subaccount-id | any Provide to identify the specific subaccount from request |
| x-language | any Provide to identify the locale from the content |
Request Body schema: application/jsonrequired
| review_notes | string Human or machine made review |
| comment | string Textual comment about the answer |
| score | object >= 0 Score given to the answer |
| repository_url | string <uri> Repository URL for project type answers |
Responses
Request samples
- Payload
{- "review_notes": "",
- "comment": "string",
- "score": 0,
}Response samples
- 200
{ }FindAttemptAnswersController_handle
Authorizations:
path Parameters
| attemptId required | string Example: 61b8e9bb2300e80010c0bcc2 |
query Parameters
| access_token | string Access token to access the answers, if missing authorization header |
header Parameters
| x-workspace-id | any Provide to identify the specific workspace from request |
| x-subaccount-id | any Provide to identify the specific subaccount from request |
| x-language | any Provide to identify the locale from the content |
Responses
UploadMediaController_uploadFile
path Parameters
| token required | string |
header Parameters
| x-workspace-id | any Provide to identify the specific workspace from request |
| x-subaccount-id | any Provide to identify the specific subaccount from request |
| x-language | any Provide to identify the locale from the content |
Request Body schema: application/jsonrequired
| isLast required | boolean Default: false Are we on the last part of the upload? |
| recordId required | string Record ID |
| partNumber required | number Part number |
| totalChunks | number Total chunks |
Responses
Request samples
- Payload
{- "isLast": false,
- "recordId": "string",
- "partNumber": 0,
- "totalChunks": 0
}Response samples
- 201
{ }UploadMediaController_deleteFile
path Parameters
| token required | string |
header Parameters
| x-workspace-id | any Provide to identify the specific workspace from request |
| x-subaccount-id | any Provide to identify the specific subaccount from request |
| x-language | any Provide to identify the locale from the content |
Responses
FindSkillRadarByAttemptController_handle
Authorizations:
path Parameters
| attemptId required | string Example: 61b8e9bb2300e80010c0bcc2 |
header Parameters
| x-workspace-id | any Provide to identify the specific workspace from request |
| x-subaccount-id | any Provide to identify the specific subaccount from request |
| x-language | any Provide to identify the locale from the content |
Responses
GetScorecardFieldsController_handle
query Parameters
| type | string Example: type=team |
header Parameters
| x-workspace-id | any Provide to identify the specific workspace from request |
| x-subaccount-id | any Provide to identify the specific subaccount from request |
| x-language | any Provide to identify the locale from the content |
Responses
FindAssessmentQuestionsSkillsController_handle
query Parameters
| page | number Example: page=1 |
| pageSize | number Example: pageSize=10 |
| search | string |
| ids required | Array of strings |
header Parameters
| x-workspace-id | any Provide to identify the specific workspace from request |
| x-subaccount-id | any Provide to identify the specific subaccount from request |
| x-language | any Provide to identify the locale from the content |
Responses
Response samples
- 200
{- "docs": [
- {
- "_id": "6501d432afe2730012f74d68",
- "name": "JavaScript",
- "taxonomy": "skill"
}
], - "totalDocs": 50,
- "limit": 10,
- "totalPages": 5,
- "page": 1,
- "pagingCounter": 1,
- "hasPrevPage": false,
- "hasNextPage": true,
- "prevPage": null,
- "nextPage": 2
}FindAssessmentQuestionsLibrarySkillsController_handle
Authorizations:
query Parameters
| skills | Array of arrays |
| _id required | Array of strings |
| type | Array of strings Items Enum: "fast" "coding" "project" |
| status | string Grouping by content ownership. Cannot be used with grouping |
| grouping | string Enum: "public" "company" Grouping by content ownership. Cannot be used with status |
| page | number Example: page=1 |
| pageSize | number Example: pageSize=10 |
| search | string |
header Parameters
| x-workspace-id | any Provide to identify the specific workspace from request |
| x-subaccount-id | any Provide to identify the specific subaccount from request |
| x-language | any Provide to identify the locale from the content |
Responses
Response samples
- 200
{- "docs": [
- {
- "_id": "6501d432afe2730012f74d68",
- "name": "JavaScript"
}
], - "totalDocs": 50,
- "limit": 10,
- "totalPages": 5,
- "page": 1,
- "pagingCounter": 1,
- "hasPrevPage": false,
- "hasNextPage": true,
- "prevPage": null,
- "nextPage": 2
}FindAssessmentQuestionSkillsController_handle
path Parameters
| id required | string Example: 61b8e9bb2300e80010c0bcc2 |
header Parameters
| x-workspace-id | any Provide to identify the specific workspace from request |
| x-subaccount-id | any Provide to identify the specific subaccount from request |
| x-language | any Provide to identify the locale from the content |
Responses
Response samples
- 200
{- "docs": [
- {
- "_id": "6501d432afe2730012f74d68",
- "name": "JavaScript"
}
]
}Generate auto login link
This endpoint creates invite links with user token to reduce the number of clicks to access the assessment.
Authorizations:
header Parameters
| x-workspace-id | any Provide to identify the specific workspace from request |
| x-subaccount-id | any Provide to identify the specific subaccount from request |
| x-language | any Provide to identify the locale from the content |
Request Body schema: application/jsonrequired
| analyses required | Array of objects (ObjectId) Analysis ids to generate autologin links |
| analysis_plan required | object Analysis Plan |
Responses
Request samples
- Payload
{- "analyses": [
- "62b384d70309831f9c13c87d",
- "62b5faff5a80481c2cba4669"
], - "analysis_plan": "62b384d70309831f9c13c87d"
}RecalculateAssessmentParticipantController_handle
Authorizations:
path Parameters
| participantId required | string Example: 61b8e9bb2300e80010c0bcc2 |
header Parameters
| x-workspace-id | any Provide to identify the specific workspace from request |
| x-subaccount-id | any Provide to identify the specific subaccount from request |
| x-language | any Provide to identify the locale from the content |
Responses
SyncAssessmentAttemptController_handle
Authorizations:
path Parameters
| attemptId required | string Example: 61b8e9bb2300e80010c0bcc2 |
header Parameters
| x-workspace-id | any Provide to identify the specific workspace from request |
| x-subaccount-id | any Provide to identify the specific subaccount from request |
| x-language | any Provide to identify the locale from the content |
Responses
Generate analysis attempts for users.
This endpoint will generate attempts based on scorecard form data. Is required to generate the scorecard using a workspace that has published teams. No need to send any data, the scorecards will be fetched from database.
Authorizations:
header Parameters
| x-workspace-id | any Provide to identify the specific workspace from request |
| x-subaccount-id | any Provide to identify the specific subaccount from request |
| x-language | any Provide to identify the locale from the content |
Request Body schema: application/jsonrequired
| ids required | Array of strings (User ids) |
Responses
Request samples
- Payload
{- "ids": [
- "string"
]
}HandleAttemptNotesController_getNotes
path Parameters
| id required | string Example: 61b8e9bb2300e80010c0bcc2 |
header Parameters
| x-workspace-id | any Provide to identify the specific workspace from request |
| x-subaccount-id | any Provide to identify the specific subaccount from request |
| x-language | any Provide to identify the locale from the content |
Responses
Response samples
- 200
{ }HandleAttemptNotesController_saveNotes
path Parameters
| id required | string Example: 61b8e9bb2300e80010c0bcc2 |
header Parameters
| x-workspace-id | any Provide to identify the specific workspace from request |
| x-subaccount-id | any Provide to identify the specific subaccount from request |
| x-language | any Provide to identify the locale from the content |
Responses
UploadProctoringImageController_uploadFile
path Parameters
| id required | string Example: 61b8e9bb2300e80010c0bcc2 |
header Parameters
| user-agent required | string |
| x-workspace-id | any Provide to identify the specific workspace from request |
| x-subaccount-id | any Provide to identify the specific subaccount from request |
| x-language | any Provide to identify the locale from the content |
Responses
UploadProctoringRecordingController_uploadFile
path Parameters
| id required | string Example: 61b8e9bb2300e80010c0bcc2 |
header Parameters
| x-workspace-id | any Provide to identify the specific workspace from request |
| x-subaccount-id | any Provide to identify the specific subaccount from request |
| x-language | any Provide to identify the locale from the content |
Responses
UploadProctoringSessionRecordingController_handle
path Parameters
| id required | string Example: 61b8e9bb2300e80010c0bcc2 |
header Parameters
| Content-Encoding required | string |
| x-workspace-id | any Provide to identify the specific workspace from request |
| x-subaccount-id | any Provide to identify the specific subaccount from request |
| x-language | any Provide to identify the locale from the content |
Responses
FindCertificateByTokenController_handle
path Parameters
| token required | string Example: 19dbdf0e-56e0-11ec-9234-0123456789ab |
header Parameters
| x-workspace-id | any Provide to identify the specific workspace from request |
| x-subaccount-id | any Provide to identify the specific subaccount from request |
| x-language | any Provide to identify the locale from the content |
Responses
Response samples
- 200
{- "type": "fast",
- "token": "abc123-token",
- "finished": "2019-08-24T14:15:22Z",
- "user": "6501d432afe2730012f74d68",
- "person": "John Doe",
- "assessment": "Frontend Developer Assessment",
- "subject": "JavaScript Fundamentals",
- "description": "Certificate description",
- "about_test": {
- "title": "JavaScript Fundamentals",
- "duration": 30,
- "size": 10,
- "level": "intermediate",
- "type_formatted": "Fast Question",
- "level_formatted": "Intermediate",
}, - "whitelabel": {
- "_id": "6501d432afe2730012f74d68",
- "name": "Company Name",
- "primaryColor": "#3B82F6"
}
}FindAssessmentAnswerByIdController_handle
Authorizations:
path Parameters
| id required | string |
query Parameters
| access_token required | string |
header Parameters
| x-workspace-id | any Provide to identify the specific workspace from request |
| x-subaccount-id | any Provide to identify the specific subaccount from request |
| x-language | any Provide to identify the locale from the content |
Responses
FindCertificateByTokenController_handle
path Parameters
| token required | string Example: 19dbdf0e-56e0-11ec-9234-0123456789ab |
header Parameters
| x-workspace-id | any Provide to identify the specific workspace from request |
| x-subaccount-id | any Provide to identify the specific subaccount from request |
| x-language | any Provide to identify the locale from the content |
Responses
Response samples
- 200
{- "type": "fast",
- "token": "abc123-token",
- "score": 85.5,
- "finished": "2019-08-24T14:15:22Z",
- "user": "6501d432afe2730012f74d68",
- "person": "John Doe",
- "assessment": "Frontend Developer Assessment",
- "can_access_question_link": true,
- "subject": "JavaScript Fundamentals",
- "description": "Certificate description",
- "question": {
- "title": "JavaScript Fundamentals",
- "slug": "javascript-fundamentals",
- "size": 10,
- "level_formatted": "Intermediate"
}
}UploadMediaController_uploadFile
path Parameters
| id required | string |
header Parameters
| user-agent required | string |
| x-workspace-id | any Provide to identify the specific workspace from request |
| x-subaccount-id | any Provide to identify the specific subaccount from request |
| x-language | any Provide to identify the locale from the content |
Responses
Response samples
- 201
{ }UploadVideoPresentationController_uploadFile_v2
path Parameters
| token required | string |
header Parameters
| x-workspace-id | any Provide to identify the specific workspace from request |
| x-subaccount-id | any Provide to identify the specific subaccount from request |
| x-language | any Provide to identify the locale from the content |
Request Body schema: application/jsonrequired
| isLast required | boolean Default: false Are we on the last part of the upload? |
| recordId required | string Record ID |
| partNumber required | number Part number |
| totalChunks | number Total chunks |
Responses
Request samples
- Payload
{- "isLast": false,
- "recordId": "string",
- "partNumber": 0,
- "totalChunks": 0
}Response samples
- 201
{ }UploadVideoPresentationController_deleteFile_v2
path Parameters
| token required | string |
header Parameters
| x-workspace-id | any Provide to identify the specific workspace from request |
| x-subaccount-id | any Provide to identify the specific subaccount from request |
| x-language | any Provide to identify the locale from the content |
Responses
Response samples
- 200
{ }Find assessment questions catalog
Find public assessment questions catalog and company questions
Authorizations:
query Parameters
| page | number Example: page=1 |
| pageSize | number Example: pageSize=10 |
| categories | Array of arrays |
| type | Array of type |
| level | Array of level |
| _id | Array of arrays Array of ids to highlight |
| search | string |
| skills | Array of arrays |
| question_domains | string Term _id or slug from taxonomy |
| hl | string |
| query | string Base64-encoded JSONLogic filter tree. Supported fields: status, author, type, level, skills, company. |
header Parameters
| x-workspace-id | any Provide to identify the specific workspace from request |
| x-subaccount-id | any Provide to identify the specific subaccount from request |
| x-language | any Provide to identify the locale from the content |
Responses
Response samples
- 200
{- "docs": [
- {
- "question": "6501d432afe2730012f74d68",
- "weight": 0,
- "min_score": 0,
- "max_score": 100,
- "accepted_languages": [
- "string"
]
}
], - "totalDocs": 50,
- "limit": 10,
- "totalPages": 5,
- "page": 1,
- "pagingCounter": 1,
- "hasPrevPage": false,
- "hasNextPage": true,
- "prevPage": null,
- "nextPage": 2
}CreateAssessmentQuestionController_handle
Authorizations:
header Parameters
| x-workspace-id | any Provide to identify the specific workspace from request |
| x-subaccount-id | any Provide to identify the specific subaccount from request |
| x-language | any Provide to identify the locale from the content |
Responses
Bulk delete challenges/questions with status `created`
Authorizations:
header Parameters
| x-workspace-id | any Provide to identify the specific workspace from request |
| x-subaccount-id | any Provide to identify the specific subaccount from request |
| x-language | any Provide to identify the locale from the content |
Request Body schema: application/jsonrequired
Array of question IDs to delete
Responses
Request samples
- Payload
[- "string"
]FindByIdAssessmentQuestionController_handle
Authorizations:
path Parameters
| id required | string Example: 61b8e9bb2300e80010c0bcc2 |
query Parameters
| include | string Comma-separated list of fields to include (author, skills, company) |
header Parameters
| x-workspace-id | any Provide to identify the specific workspace from request |
| x-subaccount-id | any Provide to identify the specific subaccount from request |
| x-language | any Provide to identify the locale from the content |
Responses
Response samples
- 200
{- "_id": "6501d432afe2730012f74d68",
- "slug": "javascript-fundamentals",
- "type": "coding",
- "status": "published",
- "level": "intermediate",
- "duration": 30,
- "duration_unit": "minutes",
- "author": {
- "_id": "6501d432afe2730012f74d68",
- "displayName": "John Doe"
}, - "skills": [
- {
- "_id": "6501d432afe2730012f74d68",
- "name": "JavaScript"
}
], - "question_domains": [
- {
- "_id": "6501d432afe2730012f74d68",
- "name": "JavaScript"
}
], - "company": {
- "_id": "6501d432afe2730012f74d68",
- "company_name": "Acme Corp"
}, - "locale": [
- {
- "_id": "62b5faff5a80481c2cba4669",
- "lang": "pt",
- "title": "Calcular o IMC",
- "description": "Calcular o IMC baseado na massa corporal e altura."
}
], - "coding": {
- "max_execution_time": 4000,
- "stub": {
- "name": "string",
- "returnType": "string",
- "returnDescription": "string",
- "functionParams": [
- {
- "name": "string",
- "type": "string",
- "description": "string",
- "_id": { }
}
]
}, - "tests": [
- {
- "hidden": true,
- "params": [
- {
- "value": "12",
- "name": "height",
- "type": "string"
}
], - "output": {
- "value": "12",
- "type": "number"
}, - "_id": { }
}
], - "supported_languages": [
- {
- "language": "string",
- "stub": "string",
- "correct_code": "string",
- "updated": "2019-08-24T14:15:22Z",
- "_id": { },
- "created": "2019-08-24T14:15:22Z"
}
], - "available_languages": [
- "string"
], - "visible_tests_counter": 0,
- "visible_tests_half": true,
- "enable_network": true
}, - "fast": {
- "mainSkill": { },
- "questions": [
- { }
], - "shuffle_questions": true,
- "adaptative_testing": true,
- "random_questions": 0,
- "grade_type": "mcq",
- "groups": [
- { }
]
}, - "project": { },
- "settings": { },
- "recommendations": [
- "string"
], - "topics": [
- "string"
], - "categories": [
- "string"
], - "deleted": true
}UpdateAssessmentQuestionController_handle
Authorizations:
path Parameters
| id required | string Example: 61b8e9bb2300e80010c0bcc2 |
header Parameters
| x-workspace-id | any Provide to identify the specific workspace from request |
| x-subaccount-id | any Provide to identify the specific subaccount from request |
| x-language | any Provide to identify the locale from the content |
Request Body schema: application/jsonrequired
| status required | string Enum: "created" "published" "archived" AssessmentQuestion status |
| level required | string Enum: "beginner" "intermediate" "advanced" Indicates the level of technical skill to solve the questions |
Array of objects (ILocaleDto) Indicates the heading of the questions translated into their respective languages | |
| type | string Enum: "fast" "coding" "sql" "project" "question" "softskill" "video" "essay" "audio" "file" "whiteboard" "freecoding" Indicates the type of assessmentQuestion the must be: fast,coding,sql,project,question,softskill,video,essay,audio,file,whiteboard,freecoding |
| weight | number Question weight |
| categories required | Array of objects (ObjectId) Indicates the skills covered in the assessmentQuestion |
| career required | object Indicates the skills covered in the assessmentQuestion |
| question_domains required | Array of objects (ObjectId) [ items ] |
object Additional properties when assessment Question is fast type | |
object Additional properties when assessment Question is coding type | |
object Additional properties when assessment Question is question type | |
object Additional properties when assessment Question is project type | |
object (InternalNotesDto) | |
| duration_unit | object (Duration unit) Duration unit |
| author required | object User creator |
| subaccount_ids required | Array of objects (ObjectId) Workspaces that this assessment belongs to |
object Arbitrary settings for the assessment question | |
| _id required | object (ObjectId) |
| scope required | string |
| duration required | number |
| skills required | Array of objects (ObjectId) |
Responses
Request samples
- Payload
{- "status": "created",
- "level": "beginner",
- "locale": [
- {
- "_id": "62b5faff5a80481c2cba4669",
- "lang": "pt",
- "title": "Calcular o IMC",
- "description": "Calcular o IMC baseado na massa corporal e altura."
}
], - "type": "coding",
- "weight": 4,
- "categories": [
- "62b384d70309831f9c13c87d",
- "62b5faff5a80481c2cba4669"
], - "career": "62b5faff5a80481c2cba4669",
- "question_domains": [
- [
- "62b384d70309831f9c13c87d"
]
], - "fast": {
- "mainSkill": { },
- "questions": [
- { }
], - "shuffle_questions": true,
- "adaptative_testing": true,
- "random_questions": 0,
- "grade_type": "mcq",
- "groups": [
- { }
]
}, - "coding": {
- "max_execution_time": 4000,
- "stub": {
- "name": "string",
- "returnType": "string",
- "returnDescription": "string",
- "functionParams": [
- {
- "name": "string",
- "type": "string",
- "description": "string",
- "_id": { }
}
]
}, - "tests": [
- {
- "hidden": true,
- "params": [
- {
- "value": "12",
- "name": "height",
- "type": "string"
}
], - "output": {
- "value": "12",
- "type": "number"
}, - "_id": { }
}
], - "supported_languages": [
- {
- "language": "string",
- "stub": "string",
- "correct_code": "string",
- "updated": "2019-08-24T14:15:22Z",
- "_id": { },
- "created": "2019-08-24T14:15:22Z"
}
], - "available_languages": [
- "string"
], - "visible_tests_counter": 0,
- "visible_tests_half": true,
- "enable_network": true
}, - "question": {
- "type": "radio_multiple",
- "grade_type": "mcq",
- "locale": [
- {
- "title": "Audio Question",
- "description": "Record your answer"
}
], - "shuffle_choices": "none"
}, - "project": {
- "has_video": true,
- "artifact_tags": [
- { }
], - "checklist": { },
- "origin": "string",
}, - "internal_notes": {
- "goal": "Goal of the assessmentQuestion",
- "evaluation": "Evaluate of the assessmentQuestion",
- "steps": [
- {
- "name": "Movie Listing with Details",
- "description": "Verify the application lists movies correctly with required information (image, title, release year, duration, synopsis, director and producer, rating).",
- "weight": 1,
- "extra": false
}
]
}, - "duration_unit": { },
- "author": "5ce1d6bb8fef73750f97e941",
- "subaccount_ids": [
- "62b384d70309831f9c13c87d",
- "62b5faff5a80481c2cba4669"
], - "settings": {
- "timeLimit": 30,
- "randomize": true
}, - "_id": { },
- "scope": "string",
- "duration": 0,
- "skills": [
- { }
]
}FindBySlugAssessmentQuestionController_handle
path Parameters
| slug required | string Example: b4cad3f5-234d-43f8-bbed-e2af98bdc4f6 |
header Parameters
| x-workspace-id | any Provide to identify the specific workspace from request |
| x-subaccount-id | any Provide to identify the specific subaccount from request |
| x-language | any Provide to identify the locale from the content |
Responses
Response samples
- 200
{- "id": "6501d432afe2730012f74d68",
- "_id": "6501d432afe2730012f74d68",
- "locale": {
- "lang": "en",
- "title": "JavaScript Fundamentals",
- "description": "Test your JavaScript knowledge"
}, - "level": "intermediate",
- "level_formatted": "Intermediate",
- "duration": 30,
- "topics": [
- {
- "_id": "6501d432afe2730012f74d68",
- "name": "Frontend",
- "slug": "frontend",
- "taxonomy": "topic"
}
], - "question_domains": [
- {
- "_id": "6501d432afe2730012f74d68",
- "name": "Frontend",
- "slug": "frontend",
- "taxonomy": "topic"
}
]
}Questions library
Manage assessment questions catalog, filtering by type, level, search and pagination
Authorizations:
query Parameters
| _id required | Array of strings |
| skills required | Array of strings |
| author required | Array of strings |
| page | number Example: page=1 |
| pageSize | number Example: pageSize=10 |
| type | Array of strings Items Enum: "coding" "freecoding" "fast" "project" "essay" "audio" "video" |
| level | Array of level |
| locale required | Array of strings |
| search | string |
| status | string Grouping by content ownership. Cannot be used with grouping |
| grouping | string Enum: "public" "company" Grouping by content ownership. Cannot be used with status |
| query | string Base64-encoded JSONLogic filter tree. Supported fields: status, author, type, level, skills, company. |
| order | string Default: "desc" Enum: "asc" "desc" |
| orderBy | string Default: "_id" |
| offset | number >= 0 Default: 0 |
| limit | number [ 0 .. 2000 ] Default: 20 |
header Parameters
| x-workspace-id | any Provide to identify the specific workspace from request |
| x-subaccount-id | any Provide to identify the specific subaccount from request |
| x-language | any Provide to identify the locale from the content |
Responses
Response samples
- 200
{- "docs": [
- {
- "_id": "6501d432afe2730012f74d68",
- "locale": {
- "lang": "en",
- "title": "JavaScript Fundamentals",
- "description": "Test your JavaScript knowledge"
}, - "locales": [
- "English",
- "Portuguese"
], - "author": {
- "_id": "6501d432afe2730012f74d68",
- "displayName": "John Doe"
}, - "company": {
- "_id": "6501d432afe2730012f74d68",
- "company_name": "Acme Corp"
}, - "level": "intermediate",
- "type": "coding",
- "slug": "javascript-fundamentals",
- "duration": 30,
- "duration_unit": "minutes",
- "status": "published",
- "skills": [
- {
- "_id": "6501d432afe2730012f74d68",
- "name": "JavaScript"
}
], - "weight": 1,
- "accepted_languages": [
- "string"
], - "grouping": "company",
- "questions_count": 5,
- "level_formatted": "Intermediate",
- "type_formatted": "Coding Challenge",
- "can_edit": true,
- "can_delete": true,
- "can_duplicate": true,
- "can_view": true,
- "can_archive": true,
- "settings": {
- "shuffle_questions": true,
- "random_questions": 0,
- "adaptative_testing": true,
- "weight": 0,
- "duration": 0,
- "duration_unit": "string",
- "accepted_languages": [
- "string"
], - "min_score": 0,
- "max_score": 100,
- "has_certificate": true,
- "has_video": true
}
}
], - "totalDocs": 50,
- "limit": 10,
- "totalPages": 5,
- "page": 1,
- "pagingCounter": 1,
- "hasPrevPage": false,
- "hasNextPage": true,
- "prevPage": null,
- "nextPage": 2
}Questions library
Lists questions from the library. This endpoint dont fetch challenges
Authorizations:
query Parameters
| _id required | Array of strings |
| page | number Example: page=1 |
| pageSize | number Example: pageSize=10 |
| type | Array of strings Items Enum: "radio_multiple" "checkbox_multiple" "freecoding" "link" "video" "essay" "audio" |
| level | Array of strings |
| search | string |
| skills | Array of arrays |
| author required | Array of strings |
| query | string Base64-encoded JSONLogic filter tree. Supported fields: status, author, type, level, skills, company. |
header Parameters
| x-workspace-id | any Provide to identify the specific workspace from request |
| x-subaccount-id | any Provide to identify the specific subaccount from request |
| x-language | any Provide to identify the locale from the content |
Responses
Response samples
- 200
{- "docs": [
- {
- "_id": "6501d432afe2730012f74d68",
- "type": "question",
- "status": "answered",
- "is_correct": true
}
], - "totalDocs": 50,
- "limit": 10,
- "totalPages": 5,
- "page": 1,
- "pagingCounter": 1,
- "hasPrevPage": false,
- "hasNextPage": true,
- "prevPage": null,
- "nextPage": 2
}Bulk change status for challenges/questions
Authorizations:
header Parameters
| x-workspace-id | any Provide to identify the specific workspace from request |
| x-subaccount-id | any Provide to identify the specific subaccount from request |
| x-language | any Provide to identify the locale from the content |
Request Body schema: application/jsonrequired
Responses
Request samples
- Payload
[- "string"
]Bulk change status for challenges/questions
Authorizations:
path Parameters
| id required | string Example: 61b8e9bb2300e80010c0bcc2 |
header Parameters
| x-workspace-id | any Provide to identify the specific workspace from request |
| x-subaccount-id | any Provide to identify the specific subaccount from request |
| x-language | any Provide to identify the locale from the content |
Request Body schema: application/jsonrequired
Array of challenge/question IDs to unarchive
Responses
Request samples
- Payload
[- "61b8e9bb2300e80010c0bcc2"
]DuplicateAssessmentQuestionController_handle
Authorizations:
path Parameters
| id required | string Example: 61b8e9bb2300e80010c0bcc2 |
header Parameters
| x-workspace-id | any Provide to identify the specific workspace from request |
| x-subaccount-id | any Provide to identify the specific subaccount from request |
| x-language | any Provide to identify the locale from the content |
Responses
Generate coding stub based on body data
This endpoint will generate a coding stub based on body data. Meant to be used on coding editing dashboard
Authorizations:
path Parameters
| id required | string Example: 61b8e9bb2300e80010c0bcc2 |
| language required | number Example: 1 |
header Parameters
| x-workspace-id | any Provide to identify the specific workspace from request |
| x-subaccount-id | any Provide to identify the specific subaccount from request |
| x-language | any Provide to identify the locale from the content |
Responses
Response samples
- 200
{ }RunCodingQuestionController_handle
Authorizations:
path Parameters
| id required | string Example: 61b8e9bb2300e80010c0bcc2 |
header Parameters
| x-workspace-id | any Provide to identify the specific workspace from request |
| x-subaccount-id | any Provide to identify the specific subaccount from request |
| x-language | any Provide to identify the locale from the content |
Request Body schema: application/jsonrequired
Payload for running coding question
| code | string |
| language | string |
| solution | string |
| stub | string |
Array of objects | |
| max_execution_time | number |
Responses
Request samples
- Payload
{- "code": "print(\"Hello World\")",
- "language": "python",
- "solution": "def sum(a, b): return a + b",
- "stub": "def sum(a, b):",
- "tests": [
- {
- "_id": "61b8e9bb2300e80010c0bcc3",
- "input": "1,2",
- "output": "3"
}
], - "max_execution_time": 10
}FindAssessmentQuestionsAuthorsController_handle
Authorizations:
query Parameters
| _id | Array of strings |
| search | string |
header Parameters
| x-workspace-id | any Provide to identify the specific workspace from request |
| x-subaccount-id | any Provide to identify the specific subaccount from request |
| x-language | any Provide to identify the locale from the content |
Responses
Response samples
- 200
{- "docs": [
- {
- "value": "6501d432afe2730012f74d68",
- "label": "John Doe"
}
], - "totalDocs": 50,
- "limit": 10,
- "totalPages": 5,
- "page": 1,
- "pagingCounter": 1,
- "hasPrevPage": false,
- "hasNextPage": true,
- "prevPage": null,
- "nextPage": 2
}UploadMediaController_uploadFile
Authorizations:
path Parameters
| id required | string Example: 61b8e9bb2300e80010c0bcc2 |
header Parameters
| x-workspace-id | any Provide to identify the specific workspace from request |
| x-subaccount-id | any Provide to identify the specific subaccount from request |
| x-language | any Provide to identify the locale from the content |
Responses
UploadMediaController_deleteFile
Authorizations:
path Parameters
| id required | string Example: 61b8e9bb2300e80010c0bcc2 |
header Parameters
| x-workspace-id | any Provide to identify the specific workspace from request |
| x-subaccount-id | any Provide to identify the specific subaccount from request |
| x-language | any Provide to identify the locale from the content |
Responses
FindRecommendationByIdController_handle
Authorizations:
path Parameters
| id required | string Example: 1661452472991 |
header Parameters
| x-workspace-id | any Provide to identify the specific workspace from request |
| x-subaccount-id | any Provide to identify the specific subaccount from request |
| x-language | any Provide to identify the locale from the content |
Responses
Response samples
- 200
[- {
- "_id": "6501d432afe2730012f74d68",
- "title": "JavaScript Course",
- "description": "Learn JavaScript from scratch",
- "provider": "Udemy",
- "type": "course",
- "usage": "paid",
- "company": {
- "_id": "6501d432afe2730012f74d68",
- "company_name": "Acme Corp"
}, - "main_language": "en",
- "locales": [
- "string"
], - "type_formatted": "Course",
- "status_formatted": "Published"
}
]UploadQuestionBootstrapController_uploadFile
Authorizations:
path Parameters
| id required | string Example: 61b8e9bb2300e80010c0bcc2 |
header Parameters
| x-workspace-id | any Provide to identify the specific workspace from request |
| x-subaccount-id | any Provide to identify the specific subaccount from request |
| x-language | any Provide to identify the locale from the content |
Responses
UploadQuestionBootstrapController_deleteFile
Authorizations:
path Parameters
| id required | string Example: 61b8e9bb2300e80010c0bcc2 |
header Parameters
| x-workspace-id | any Provide to identify the specific workspace from request |
| x-subaccount-id | any Provide to identify the specific subaccount from request |
| x-language | any Provide to identify the locale from the content |
Responses
FieldsCodingLanguagesController_handle
query Parameters
| type | string Enum: "coding" "freecoding" |
header Parameters
| x-workspace-id | any Provide to identify the specific workspace from request |
| x-subaccount-id | any Provide to identify the specific subaccount from request |
| x-language | any Provide to identify the locale from the content |
Responses
Translate assessment question title/description/choices
Authorizations:
path Parameters
| id required | string Example: 61b8e9bb2300e80010c0bcc2 |
header Parameters
| x-workspace-id | any Provide to identify the specific workspace from request |
| x-subaccount-id | any Provide to identify the specific subaccount from request |
| x-language | any Provide to identify the locale from the content |
Request Body schema: application/jsonrequired
| targetLocales required | Array of strings non-empty Target language codes for translation (e.g. ["en","pt"]). |
Responses
Request samples
- Payload
{- "targetLocales": [
- "string"
]
}Generate criteria for an assessment question
Authorizations:
path Parameters
| id required | string Example: 61b8e9bb2300e80010c0bcc2 |
header Parameters
| x-workspace-id | any Provide to identify the specific workspace from request |
| x-subaccount-id | any Provide to identify the specific subaccount from request |
| x-language | any Provide to identify the locale from the content |
Responses
RunSqlQuestionController_handle
Authorizations:
path Parameters
| id required | string Example: 61b8e9bb2300e80010c0bcc2 |
header Parameters
| x-workspace-id | any Provide to identify the specific workspace from request |
| x-subaccount-id | any Provide to identify the specific subaccount from request |
| x-language | any Provide to identify the locale from the content |
Request Body schema: application/jsonrequired
Payload for running SQL question
| code required | string |
| dataset_id | string Dataset id used for file-based SQL questions (overrides settings.dataset_id) |
| script | string SQL script used when settings.format = script (overrides settings.script) |
| solution | string Optional solution SQL; when provided the expected output will contain its result set |
| language | string |
| mode | string Enum: "default" "json" |
Responses
Request samples
- Payload
{- "code": "select 1",
- "dataset_id": "61b8e9bb2300e80010c0bcc2",
- "script": "CREATE TABLE test (id INT); INSERT INTO test VALUES (1);",
- "solution": "select 1",
- "language": "82",
- "mode": "default"
}CreateRecommendationController_handle
Authorizations:
header Parameters
| x-workspace-id | any Provide to identify the specific workspace from request |
| x-subaccount-id | any Provide to identify the specific subaccount from request |
| x-language | any Provide to identify the locale from the content |
Request Body schema: application/jsonrequired
| title required | string <= 100 characters Action Plan title |
| description required | string <= 2000 characters Action Plan description |
| url required | string URL |
| type required | string Action Plan type |
| provider required | string Provider |
Responses
Request samples
- Payload
{- "title": "Action Plan 1",
- "description": "Action Plan 1 description",
- "type": "course",
- "provider": "coodesh"
}FindRecommendationByIdController_handle
Authorizations:
path Parameters
| id required | string Example: 1661452472991 |
header Parameters
| x-workspace-id | any Provide to identify the specific workspace from request |
| x-subaccount-id | any Provide to identify the specific subaccount from request |
| x-language | any Provide to identify the locale from the content |
Responses
Response samples
- 200
{- "_id": "6501d432afe2730012f74d68",
- "title": "Course Title",
- "description": "Course Description",
- "type": "course",
- "status": "published",
- "main_language": "pt",
- "languages": { },
- "company": "6501d432afe2730012f74d68",
- "created": "2023-10-01T00:00:00.000Z",
- "updated": "2023-10-15T00:00:00.000Z"
}UpdateRecommendationByIdController_handle
Authorizations:
path Parameters
| id required | string Example: 61b8e9bb2300e80010c0bcc2 |
header Parameters
| x-workspace-id | any Provide to identify the specific workspace from request |
| x-subaccount-id | any Provide to identify the specific subaccount from request |
| x-language | any Provide to identify the locale from the content |
Request Body schema: application/jsonrequired
| title required | string <= 100 characters Action Plan title |
| description required | string <= 2000 characters Action Plan description |
| url required | string URL |
| type required | string Action Plan type |
| provider required | string Provider |
| _id required | object Recommendation ID |
| question required | object Question ID |
Responses
Request samples
- Payload
{- "title": "Action Plan 1",
- "description": "Action Plan 1 description",
- "type": "course",
- "provider": "coodesh",
- "_id": "60f5a4e2f4e6e1001f5a4e2f",
- "question": "60f5a4e2f4e6e1001f5a4e2f"
}FindRecommendationsLibraryController_handle
Authorizations:
query Parameters
| author | Array of any |
| order | string Default: "desc" Enum: "asc" "desc" |
| orderBy | string Default: "_id" |
| offset | number >= 0 Default: 0 |
| page | number >= 1 Default: 1 Example: page=1 |
| pageSize | number [ 1 .. 2000 ] Default: 20 Example: pageSize=10 |
| limit | number [ 0 .. 2000 ] Default: 20 |
| status required | string |
| search | string |
| type | string Example: type=course |
| language | string Example: language=pt |
header Parameters
| x-workspace-id | any Provide to identify the specific workspace from request |
| x-subaccount-id | any Provide to identify the specific subaccount from request |
| x-language | any Provide to identify the locale from the content |
Responses
Response samples
- 200
{- "docs": [
- {
- "_id": "6501d432afe2730012f74d68",
- "title": "Course Title",
- "description": "Course Description",
- "status": "published",
- "status_formatted": {
- "value": "published",
- "label": "Published"
}, - "type": "course",
- "type_formatted": {
- "value": "published",
- "label": "Published"
}, - "usage": 5,
- "locales": [
- "Portuguese",
- "English"
], - "created": "2023-10-01T00:00:00.000Z",
- "archived_date": "2023-10-15T00:00:00.000Z",
- "company": { }
}
], - "totalDocs": 50,
- "limit": 10,
- "totalPages": 5,
- "page": 1,
- "pagingCounter": 1,
- "hasPrevPage": false,
- "hasNextPage": true,
- "prevPage": null,
- "nextPage": 2
}BulkAttachRecommendationToQuestionController_handle
Authorizations:
path Parameters
| questionId required | string Example: 61b8e9bb2300e80010c0bcc2 |
header Parameters
| x-workspace-id | any Provide to identify the specific workspace from request |
| x-subaccount-id | any Provide to identify the specific subaccount from request |
| x-language | any Provide to identify the locale from the content |
Request Body schema: application/jsonrequired
| ids required | Array of objects (ObjectId) Array of ids |
Responses
Request samples
- Payload
{- "ids": [
- { }
]
}Unattach multiple recommendations from question
Authorizations:
path Parameters
| questionId required | string Example: 61b8e9bb2300e80010c0bcc2 |
header Parameters
| x-workspace-id | any Provide to identify the specific workspace from request |
| x-subaccount-id | any Provide to identify the specific subaccount from request |
| x-language | any Provide to identify the locale from the content |
Request Body schema: application/jsonrequired
| ids required | Array of objects (ObjectId) Array of ids |
Responses
Request samples
- Payload
{- "ids": [
- { }
]
}Questions library
Manage assessment questions catalog, filtering by type, level, search and pagination
Authorizations:
query Parameters
| _id required | Array of strings |
| skills required | Array of strings |
| author required | Array of strings |
| page | number Example: page=1 |
| pageSize | number Example: pageSize=10 |
| type | Array of strings Items Enum: "coding" "freecoding" "fast" "project" "essay" "audio" "video" |
| level | Array of level |
| locale required | Array of strings |
| search | string |
| status | string Grouping by content ownership. Cannot be used with grouping |
| grouping | string Enum: "public" "company" Grouping by content ownership. Cannot be used with status |
| query | string Base64-encoded JSONLogic filter tree. Supported fields: status, author, type, level, skills, company. |
| order | string Default: "desc" Enum: "asc" "desc" |
| orderBy | string Default: "_id" |
| offset | number >= 0 Default: 0 |
| limit | number [ 0 .. 2000 ] Default: 20 |
header Parameters
| x-workspace-id | any Provide to identify the specific workspace from request |
| x-subaccount-id | any Provide to identify the specific subaccount from request |
| x-language | any Provide to identify the locale from the content |
Responses
Response samples
- 200
{- "docs": [
- {
- "_id": "6501d432afe2730012f74d68",
- "locale": {
- "lang": "en",
- "title": "JavaScript Fundamentals",
- "description": "Test your JavaScript knowledge"
}, - "locales": [
- "English",
- "Portuguese"
], - "author": {
- "_id": "6501d432afe2730012f74d68",
- "displayName": "John Doe"
}, - "company": {
- "_id": "6501d432afe2730012f74d68",
- "company_name": "Acme Corp"
}, - "level": "intermediate",
- "type": "coding",
- "slug": "javascript-fundamentals",
- "duration": 30,
- "duration_unit": "minutes",
- "status": "published",
- "skills": [
- {
- "_id": "6501d432afe2730012f74d68",
- "name": "JavaScript"
}
], - "weight": 1,
- "accepted_languages": [
- "string"
], - "grouping": "company",
- "questions_count": 5,
- "level_formatted": "Intermediate",
- "type_formatted": "Coding Challenge",
- "can_edit": true,
- "can_delete": true,
- "can_duplicate": true,
- "can_view": true,
- "can_archive": true,
- "settings": {
- "shuffle_questions": true,
- "random_questions": 0,
- "adaptative_testing": true,
- "weight": 0,
- "duration": 0,
- "duration_unit": "string",
- "accepted_languages": [
- "string"
], - "min_score": 0,
- "max_score": 100,
- "has_certificate": true,
- "has_video": true
}
}
], - "totalDocs": 50,
- "limit": 10,
- "totalPages": 5,
- "page": 1,
- "pagingCounter": 1,
- "hasPrevPage": false,
- "hasNextPage": true,
- "prevPage": null,
- "nextPage": 2
}Questions library
Lists questions from the library. This endpoint dont fetch challenges
Authorizations:
query Parameters
| _id required | Array of strings |
| page | number Example: page=1 |
| pageSize | number Example: pageSize=10 |
| type | Array of strings Items Enum: "radio_multiple" "checkbox_multiple" "freecoding" "link" "video" "essay" "audio" |
| level | Array of strings |
| search | string |
| skills | Array of arrays |
| author required | Array of strings |
| query | string Base64-encoded JSONLogic filter tree. Supported fields: status, author, type, level, skills, company. |
header Parameters
| x-workspace-id | any Provide to identify the specific workspace from request |
| x-subaccount-id | any Provide to identify the specific subaccount from request |
| x-language | any Provide to identify the locale from the content |
Responses
Response samples
- 200
{- "docs": [
- {
- "_id": "6501d432afe2730012f74d68",
- "type": "question",
- "status": "answered",
- "is_correct": true
}
], - "totalDocs": 50,
- "limit": 10,
- "totalPages": 5,
- "page": 1,
- "pagingCounter": 1,
- "hasPrevPage": false,
- "hasNextPage": true,
- "prevPage": null,
- "nextPage": 2
}FindAssessmentQuestionsAuthorsController_handle
Authorizations:
query Parameters
| _id | Array of strings |
| search | string |
header Parameters
| x-workspace-id | any Provide to identify the specific workspace from request |
| x-subaccount-id | any Provide to identify the specific subaccount from request |
| x-language | any Provide to identify the locale from the content |
Responses
Response samples
- 200
{- "docs": [
- {
- "value": "6501d432afe2730012f74d68",
- "label": "John Doe"
}
], - "totalDocs": 50,
- "limit": 10,
- "totalPages": 5,
- "page": 1,
- "pagingCounter": 1,
- "hasPrevPage": false,
- "hasNextPage": true,
- "prevPage": null,
- "nextPage": 2
}ListDatasetsController_handle
Authorizations:
header Parameters
| x-workspace-id | any Provide to identify the specific workspace from request |
| x-subaccount-id | any Provide to identify the specific subaccount from request |
| x-language | any Provide to identify the locale from the content |
Responses
Response samples
- 200
[- { }
]CreateDatasetController_handle
Authorizations:
header Parameters
| x-workspace-id | any Provide to identify the specific workspace from request |
| x-subaccount-id | any Provide to identify the specific subaccount from request |
| x-language | any Provide to identify the locale from the content |
Request Body schema: multipart/form-datarequired
| name required | string Dataset name |
| description | string Dataset description |
Responses
FindDatasetController_handle
Authorizations:
path Parameters
| id required | string Example: 6501d432afe2730012f74d68 |
header Parameters
| x-workspace-id | any Provide to identify the specific workspace from request |
| x-subaccount-id | any Provide to identify the specific subaccount from request |
| x-language | any Provide to identify the locale from the content |
Responses
Response samples
- 200
{- "_id": "6501d432afe2730012f74d68",
- "name": "Employees Database",
- "description": "A sample employee database",
- "path": "/path/to/dataset",
- "driver": "sqlite",
- "table_names": [
- "employees",
- "departments"
], - "table_count": 5,
- "company": "6501d432afe2730012f74d68",
- "status": "published",
- "created": "2023-10-01T00:00:00.000Z",
- "updated": "2023-10-15T00:00:00.000Z"
}Bulk delete assessment attempts
Company admins can delete only owned attempts.
Authorizations:
header Parameters
| x-workspace-id | any Provide to identify the specific workspace from request |
| x-subaccount-id | any Provide to identify the specific subaccount from request |
| x-language | any Provide to identify the locale from the content |
Request Body schema: application/jsonrequired
| ids required | Array of strings Array of assessment attempt IDs to delete |
Responses
Request samples
- Payload
{- "ids": [
- "507f1f77bcf86cd799439011",
- "507f191e810c19729de860ea"
]
}Send invite to participants
Send invite to participants by assessment id. The attempts had been created before, using CreateAssessmentAttempts endpoint.
Authorizations:
header Parameters
| x-workspace-id | any Provide to identify the specific workspace from request |
| x-subaccount-id | any Provide to identify the specific subaccount from request |
| x-language | any Provide to identify the locale from the content |
Request Body schema: application/jsonrequired
| ids required | Array of strings Indicates the users that will receveid invite email |
| send_at | string <date-time> (Notify date) Date to send email notification to users |
Responses
Request samples
- Payload
{- "ids": [
- "62b384d70309831f9c13c87d",
- "62b5faff5a80481c2cba4669"
], - "send_at": "2019-08-24T14:15:22Z"
}BulkUnlockAttemptsController_handle
Authorizations:
header Parameters
| x-workspace-id | any Provide to identify the specific workspace from request |
| x-subaccount-id | any Provide to identify the specific subaccount from request |
| x-language | any Provide to identify the locale from the content |
Request Body schema: application/jsonrequired
| ids required | Array of strings (Assessment attempt ids) |
Responses
Request samples
- Payload
{- "ids": [
- "string"
]
}Response samples
- 201
{ }Bulk recalculate assessment attempt scores
Recalculates scores for finished or blocked assessment attempts by their IDs or assessment IDs.
Authorizations:
header Parameters
| x-workspace-id | any Provide to identify the specific workspace from request |
| x-subaccount-id | any Provide to identify the specific subaccount from request |
| x-language | any Provide to identify the locale from the content |
Request Body schema: application/jsonrequired
| ids required | Array of strings (Assessment attempt ids) |
Responses
Request samples
- Payload
{- "ids": [
- "string"
]
}Bulk reopen assessment attempts
Authorizations:
header Parameters
| x-workspace-id | any Provide to identify the specific workspace from request |
| x-subaccount-id | any Provide to identify the specific subaccount from request |
| x-language | any Provide to identify the locale from the content |
Request Body schema: application/jsonrequired
| ids required | Array of strings (Assessment attempt ids) List of assessment attempt ids |
| duration required | number (Duration) >= 0 Duration in minutes |
| duration_unit | string (Duration unit) Enum: "minute" "hour" "day" Duration unit |
| keep_answers | boolean (Keep answers) Default: true Keep answers from previous attempt |
| reason | string (Reason) Reason for reopening attempts |
| notify | boolean (Send email notification) Send email notification to users |
| send_at | string <date-time> (Notify date) Date to send email notification to users |
Responses
Request samples
- Payload
{- "ids": [
- "string"
], - "duration": 0,
- "duration_unit": "minute",
- "keep_answers": true,
- "reason": "string",
- "notify": true,
- "send_at": "2019-08-24T14:15:22Z"
}Bulk send hidden assessment results to participants
Authorizations:
header Parameters
| x-workspace-id | any Provide to identify the specific workspace from request |
| x-subaccount-id | any Provide to identify the specific subaccount from request |
| x-language | any Provide to identify the locale from the content |
Request Body schema: application/jsonrequired
| ids required | Array of strings (Assessment attempt ids) non-empty List of assessment attempt ids to send results |
Responses
Request samples
- Payload
{- "ids": [
- "507f1f77bcf86cd799439011",
- "507f191e810c19729de860ea"
]
}Bulk update assessment attempts
Company admins can update only owned attempts.
Authorizations:
header Parameters
| x-workspace-id | any Provide to identify the specific workspace from request |
| x-subaccount-id | any Provide to identify the specific subaccount from request |
| x-language | any Provide to identify the locale from the content |
Request Body schema: application/jsonrequired
| ids required | Array of strings (Assessment attempt ids) |
| stage | string (Stage) Enum: "none" "evaluating" "completed" "reviewed" "invited" "interviewed" "offer_sent" "offer_declined" "dropout" "disqualified" "hired" ATS stage |
| invitation_date_expire | string <date-time> (Expiration invite date) |
| deadline | string <date-time> (Deadline) Deadline for the assessment attempt |
| custom_time_open | string <date-time> (Custom time open) |
| custom_time_close | string <date-time> (Custom time close) |
| reason | string (Reason) Reason for reopening attempts |
| integrity_settings | object (Integrity settings) |
| hidden_results | boolean (Hide results) |
Responses
Request samples
- Payload
{- "ids": [
- "string"
], - "stage": "none",
- "invitation_date_expire": "2019-08-24T14:15:22Z",
- "deadline": "2019-08-24T14:15:22Z",
- "custom_time_open": "2019-08-24T14:15:22Z",
- "custom_time_close": "2019-08-24T14:15:22Z",
- "reason": "string",
- "integrity_settings": { },
- "hidden_results": true
}Bulk cancel scheduled assessment attempts
Authorizations:
header Parameters
| x-workspace-id | any Provide to identify the specific workspace from request |
| x-subaccount-id | any Provide to identify the specific subaccount from request |
| x-language | any Provide to identify the locale from the content |
Request Body schema: application/jsonrequired
| ids required | Array of strings (Assessment attempt ids) |
Responses
Request samples
- Payload
{- "ids": [
- "string"
]
}Bulk mark assessment attempts as finished
Authorizations:
header Parameters
| x-workspace-id | any Provide to identify the specific workspace from request |
| x-subaccount-id | any Provide to identify the specific subaccount from request |
| x-language | any Provide to identify the locale from the content |
Request Body schema: application/jsonrequired
| ids required | Array of strings (Assessment attempt ids) |
Responses
Request samples
- Payload
{- "ids": [
- "string"
]
}Handle
Handle POST companies.
header Parameters
| x-workspace-id | any |
| x-subaccount-id | any |
| x-language | any |
Request Body schema: application/jsonrequired
| company_name required | string Company name |
required | object Representative contact information |
| tech_size | string Technology team size range |
| origin | string Traffic source / origin |
| medium | string Traffic medium |
Responses
Request samples
- Payload
{- "company_name": "Acme Corp",
- "representative": {
- "displayName": "Jane Doe",
- "email": "jane@acme.com",
- "city": "San Francisco",
- "phone": "+14155551234",
- "job_position": "CTO",
- "subject": "Request a demo"
}, - "tech_size": "51-200",
- "origin": "google",
- "medium": "cpc"
}FieldsController_handle
header Parameters
| x-workspace-id | any Provide to identify the specific workspace from request |
| x-subaccount-id | any Provide to identify the specific subaccount from request |
| x-language | any Provide to identify the locale from the content |
Responses
Response samples
- 200
{- "status": [
- {
- "value": "draft",
- "label": "Draft"
}, - {
- "value": "published",
- "label": "Published"
}, - {
- "value": "archived",
- "label": "Archived"
}
]
}FindWorkforcePlanningsController_handle
Authorizations:
query Parameters
| order | string Default: "desc" Enum: "asc" "desc" |
| orderBy | string Default: "_id" |
| offset | number >= 0 Default: 0 |
| page | number >= 1 Default: 1 Example: page=1 |
| pageSize | number [ 1 .. 2000 ] Default: 20 Example: pageSize=10 |
| limit | number [ 0 .. 2000 ] Default: 20 |
| status | string Example: status=published |
| search | string |
| query | string Example: query=eyI9PSI6W3sidmFyIjoiZXh0ZXJuYWxfaWQifSwiMTExIl1dfQ== Base64-encoded JSONLogic filter tree. Supported fields: leads, belongs, external_id, tags |
| author | Array of any |
header Parameters
| x-workspace-id | any Provide to identify the specific workspace from request |
| x-subaccount-id | any Provide to identify the specific subaccount from request |
| x-language | any Provide to identify the locale from the content |
Responses
Response samples
- 200
{- "docs": [
- {
- "_id": "6501d432afe2730012f74d68",
- "name": "Engineering Team Planning",
- "description": "Planning for Q1 2024",
- "people_count": 15,
- "last_users": [
- {
- "_id": "6501d432afe2730012f74d68",
- "displayName": "John Doe",
}
], - "author": {
- "_id": "6501d432afe2730012f74d68",
- "displayName": "Jane Smith",
}, - "status": "published",
- "status_formatted": "Published",
- "subaccount_ids": [
- "6501d432afe2730012f74d68"
]
}
], - "totalDocs": 50,
- "limit": 10,
- "totalPages": 5,
- "page": 1,
- "pagingCounter": 1,
- "hasPrevPage": false,
- "hasNextPage": true,
- "prevPage": null,
- "nextPage": 2
}Create a new workforce planning
Authorizations:
header Parameters
| x-workspace-id | any Provide to identify the specific workspace from request |
| x-subaccount-id | any Provide to identify the specific subaccount from request |
| x-language | any Provide to identify the locale from the content |
Request Body schema: application/jsonrequired
| name required | string |
| customer | string |
| description | string |
| startDate | string |
| endDate | string |
| links | Array of strings <uri> [ items <uri > ] |
| owners required | object Indicates the people that owns the workforce planning |
| author required | object User that created this workforce planning |
| subaccount_ids required | Array of objects (ObjectId) Subaccounts that this workforce planning belongs to |
| external_id | string External integration identifier for the team |
| tags | Array of strings Tags for the workforce planning |
Responses
Request samples
- Payload
{- "name": "string",
- "customer": "string",
- "description": "string",
- "startDate": "string",
- "endDate": "string",
- "owners": [
- "62b384d70309831f9c13c87d",
- "62b5faff5a80481c2cba4669"
], - "author": "62b5faff5a80481c2cba4669",
- "subaccount_ids": [
- "62b384d70309831f9c13c87d",
- "62b5faff5a80481c2cba4669"
], - "external_id": "string",
- "tags": [
- "string"
]
}Delete workforce plannings
Authorizations:
header Parameters
| x-workspace-id | any Provide to identify the specific workspace from request |
| x-subaccount-id | any Provide to identify the specific subaccount from request |
| x-language | any Provide to identify the locale from the content |
Request Body schema: application/jsonrequired
| ids required | Array of objects (ObjectId) Array of ids |
Responses
Request samples
- Payload
{- "ids": [
- { }
]
}FindWorkforcePlanningController_handle
Authorizations:
path Parameters
| id required | string Example: 1661452472991 |
header Parameters
| x-workspace-id | any Provide to identify the specific workspace from request |
| x-subaccount-id | any Provide to identify the specific subaccount from request |
| x-language | any Provide to identify the locale from the content |
Responses
Response samples
- 200
{- "_id": "6501d432afe2730012f74d68",
- "name": "Engineering Team Planning",
- "description": "Planning for Q1 2024",
- "status": "published",
- "startDate": "2024-01-01",
- "endDate": "2024-03-31",
- "distribution": {
- "arrangement": [
- {
- "_id": "6501d432afe2730012f74d68",
- "name": "Developer Role",
- "skills": [
- {
- "_id": "6501d432afe2730012f74d68",
- "name": "React",
- "level": 3,
- "level_formatted": "Intermediate",
- "color": "#4CAF50"
}
]
}
], - "users": [
- { }
]
}, - "created": "2019-08-24T14:15:22Z"
}UpdateWorkforcePlanningController_handle
Authorizations:
path Parameters
| id required | string Example: 61b8e9bb2300e80010c0bcc2 |
header Parameters
| x-workspace-id | any Provide to identify the specific workspace from request |
| x-subaccount-id | any Provide to identify the specific subaccount from request |
| x-language | any Provide to identify the locale from the content |
Request Body schema: application/jsonrequired
| name required | string |
| customer | string |
| description | string |
| startDate | string |
| endDate | string |
| links | Array of strings <uri> [ items <uri > ] |
| owners required | object Indicates the people that owns the workforce planning |
| author required | object User that created this workforce planning |
| subaccount_ids required | Array of objects (ObjectId) Subaccounts that this workforce planning belongs to |
| external_id | string External integration identifier for the team |
| tags | Array of strings Tags for the workforce planning |
| status required | string Enum: "draft" "published" "archived" |
Responses
Request samples
- Payload
{- "name": "string",
- "customer": "string",
- "description": "string",
- "startDate": "string",
- "endDate": "string",
- "owners": [
- "62b384d70309831f9c13c87d",
- "62b5faff5a80481c2cba4669"
], - "author": "62b5faff5a80481c2cba4669",
- "subaccount_ids": [
- "62b384d70309831f9c13c87d",
- "62b5faff5a80481c2cba4669"
], - "external_id": "string",
- "tags": [
- "string"
], - "status": "draft"
}FindWorkspacePlanningsStatisticsController_handle
Authorizations:
header Parameters
| x-workspace-id | any Provide to identify the specific workspace from request |
| x-subaccount-id | any Provide to identify the specific subaccount from request |
| x-language | any Provide to identify the locale from the content |
Responses
Response samples
- 200
{- "metrics": {
- "teams": 10,
- "leads": 5,
- "belongs": 8,
- "people_count": 150
}, - "updated": "2019-08-24T14:15:22Z"
}MoveWorkforcePlanningToArchivedController_handle
Authorizations:
path Parameters
| id required | string Example: 61b8e9bb2300e80010c0bcc2 |
header Parameters
| x-workspace-id | any Provide to identify the specific workspace from request |
| x-subaccount-id | any Provide to identify the specific subaccount from request |
| x-language | any Provide to identify the locale from the content |
Responses
MoveWorkforcePlanningToUnarchivedController_handle
Authorizations:
path Parameters
| id required | string Example: 61b8e9bb2300e80010c0bcc2 |
header Parameters
| x-workspace-id | any Provide to identify the specific workspace from request |
| x-subaccount-id | any Provide to identify the specific subaccount from request |
| x-language | any Provide to identify the locale from the content |
Responses
DuplicateWorkforcePlanningController_handle
Authorizations:
path Parameters
| id required | string Example: 61b8e9bb2300e80010c0bcc2 |
header Parameters
| x-workspace-id | any Provide to identify the specific workspace from request |
| x-subaccount-id | any Provide to identify the specific subaccount from request |
| x-language | any Provide to identify the locale from the content |
Request Body schema: application/jsonrequired
| name required | string |
| description required | string |
Responses
Request samples
- Payload
{- "name": "string",
- "description": "string"
}FindUsersBySkillsController_handle
Authorizations:
query Parameters
| order | string Default: "desc" Enum: "asc" "desc" |
| orderBy | string Default: "_id" |
| offset | number >= 0 Default: 0 |
| page | number >= 1 Default: 1 Example: page=1 |
| pageSize | number [ 1 .. 2000 ] Default: 20 Example: pageSize=10 |
| limit | number [ 0 .. 2000 ] Default: 20 |
| search | string |
| ids | Array of strings Example: ids=61b8e9bb2300e80010c0bcc2 |
| minimumMatch | number Example: minimumMatch=1 |
| query required | string |
header Parameters
| x-workspace-id | any Provide to identify the specific workspace from request |
| x-subaccount-id | any Provide to identify the specific subaccount from request |
| x-language | any Provide to identify the locale from the content |
Responses
Response samples
- 200
{- "docs": [
- {
- "_id": "6501d432afe2730012f74d68",
- "displayName": "John Doe",
- "email": "john.doe@example.com",
- "skills": [
- {
- "_id": "6501d432afe2730012f74d68",
- "name": "React",
- "answer": "3",
- "level": 3,
- "color": "#4CAF50",
- "level_formatted": "Intermediate",
- "is_missed": false,
- "is_vetted": false
}
], - "position_name": "Engineer",
- "track_name": "Backend",
- "radar": {
- "max": 5,
- "value": 4
}
}
], - "totalDocs": 50,
- "limit": 10,
- "totalPages": 5,
- "page": 1,
- "pagingCounter": 1,
- "hasPrevPage": false,
- "hasNextPage": true,
- "prevPage": null,
- "nextPage": 2
}WorkforcePlanningAttachSkillController_handle
Authorizations:
path Parameters
| id required | string Example: 61b8e9bb2300e80010c0bcc2 |
header Parameters
| x-workspace-id | any Provide to identify the specific workspace from request |
| x-subaccount-id | any Provide to identify the specific subaccount from request |
| x-language | any Provide to identify the locale from the content |
Request Body schema: application/jsonrequired
| skillId | string |
Responses
Request samples
- Payload
{- "skillId": "61b8e9bb2300e80010c0bcc2"
}FindUsersByWorkforceController_handle
Authorizations:
path Parameters
| id required | string Example: 61b8e9bb2300e80010c0bcc2 |
query Parameters
| order | string Default: "desc" Enum: "asc" "desc" |
| orderBy | string Default: "_id" |
| offset | number >= 0 Default: 0 |
| page | number >= 1 Default: 1 Example: page=1 |
| pageSize | number [ 1 .. 2000 ] Default: 20 Example: pageSize=10 |
| limit | number [ 0 .. 2000 ] Default: 20 |
| search | string |
| query | string |
header Parameters
| x-workspace-id | any Provide to identify the specific workspace from request |
| x-subaccount-id | any Provide to identify the specific subaccount from request |
| x-language | any Provide to identify the locale from the content |
Responses
Response samples
- 200
{- "docs": [
- {
- "_id": "6501d432afe2730012f74d68",
- "displayName": "John Doe",
- "email": "john.doe@example.com",
- "roles": [
- "user"
], - "status": "active",
- "last_login": "2019-08-24T14:15:22Z",
- "created": "2019-08-24T14:15:22Z",
- "invited_date": "2019-08-24T14:15:22Z",
- "external_id": "ext-123",
- "position_name": "Engineer",
- "track_name": "Backend",
- "team_name": "Team Alpha",
- "position": "6501d432afe2730012f74d69",
- "track": "6501d432afe2730012f74d70",
- "career": "6501d432afe2730012f74d71",
- "team": "6501d432afe2730012f74d72",
- "status_formatted": "Active",
- "roles_formatted": [
- [
- "User"
]
]
}
], - "totalDocs": 50,
- "limit": 10,
- "totalPages": 5,
- "page": 1,
- "pagingCounter": 1,
- "hasPrevPage": false,
- "hasNextPage": true,
- "prevPage": null,
- "nextPage": 2
}Add users to team
Authorizations:
path Parameters
| id required | string Example: 61b8e9bb2300e80010c0bcc2 |
header Parameters
| x-workspace-id | any Provide to identify the specific workspace from request |
| x-subaccount-id | any Provide to identify the specific subaccount from request |
| x-language | any Provide to identify the locale from the content |
Request Body schema: application/jsonrequired
| ids required | Array of objects (ObjectId) Array of user IDs to add to team |
| ownerIds | Array of objects (ObjectId) Array of user IDs to set as owners |
Responses
Request samples
- Payload
{- "ids": [
- { }
], - "ownerIds": [
- { }
]
}UpdateTeamUsersController_handle
Authorizations:
path Parameters
| id required | string |
header Parameters
| x-workspace-id | any Provide to identify the specific workspace from request |
| x-subaccount-id | any Provide to identify the specific subaccount from request |
| x-language | any Provide to identify the locale from the content |
Request Body schema: application/jsonrequired
| ids | Array of objects (ObjectId) Array of existing user IDs |
Responses
Request samples
- Payload
{- "ids": [
- { }
]
}Delete users from team
Authorizations:
path Parameters
| id required | string Example: 61b8e9bb2300e80010c0bcc2 |
header Parameters
| x-workspace-id | any Provide to identify the specific workspace from request |
| x-subaccount-id | any Provide to identify the specific subaccount from request |
| x-language | any Provide to identify the locale from the content |
Request Body schema: application/jsonrequired
| ids required | Array of objects (ObjectId) Array of ids |
Responses
Request samples
- Payload
{- "ids": [
- { }
]
}ExportWorkforcePlanningsController_list
Authorizations:
query Parameters
| order | string Default: "desc" Enum: "asc" "desc" |
| orderBy | string Default: "_id" |
| offset | number >= 0 Default: 0 |
| page | number >= 1 Default: 1 Example: page=1 |
| pageSize | number [ 1 .. 2000 ] Default: 20 Example: pageSize=10 |
| limit | number [ 0 .. 2000 ] Default: 20 |
| status | string Example: status=published |
| search | string |
| query | string Base64-encoded JSONLogic filter tree. Supported fields: leads, belongs, external_id, tags |
header Parameters
| x-workspace-id | any Provide to identify the specific workspace from request |
| x-subaccount-id | any Provide to identify the specific subaccount from request |
| x-language | any Provide to identify the locale from the content |
Responses
Response samples
- 200
{- "docs": [
- {
- "id": "6501d432afe2730012f74d68",
- "name": "Team Alpha",
- "status": "published",
- "status_formatted": "Publicado",
- "author": "John Doe",
- "people_count": 12,
- "subaccount_ids": "6501d432afe2730012f74d71,6501d432afe2730012f74d72"
}
], - "limit": 10,
- "page": 1,
- "totalPages": 3,
- "totalDocs": 25,
- "hasNextPage": true,
- "hasPrevPage": false,
- "prevPage": null,
- "nextPage": 2
}ExportWorkforcePlanningsController_exportCsv
Authorizations:
header Parameters
| x-workspace-id | any Provide to identify the specific workspace from request |
| x-subaccount-id | any Provide to identify the specific subaccount from request |
| x-language | any Provide to identify the locale from the content |
Request Body schema: application/jsonrequired
| search | string Full-text search across team name |
| query | string Base64-encoded JSONLogic filter tree. Supported fields: leads, belongs, external_id, tags |
| status | string Filter by status |
Responses
Request samples
- Payload
{- "search": "string",
- "query": "string",
- "status": "string"
}Response samples
- 200
[- {
- "filename": "export.csv",
- "data": "id;name;status"
}
]FindTeamVariantsController_handle
Authorizations:
query Parameters
| order | string Default: "desc" Enum: "asc" "desc" |
| orderBy | string Default: "_id" |
| offset | number >= 0 Default: 0 |
| page | number >= 1 Default: 1 Example: page=1 |
| pageSize | number [ 1 .. 2000 ] Default: 20 Example: pageSize=10 |
| limit | number [ 0 .. 2000 ] Default: 20 |
| search | string |
| ids | Array of strings Example: ids=61b8e9bb2300e80010c0bcc2 |
header Parameters
| x-workspace-id | any Provide to identify the specific workspace from request |
| x-subaccount-id | any Provide to identify the specific subaccount from request |
| x-language | any Provide to identify the locale from the content |
Responses
Response samples
- 200
{- "docs": [
- {
- "_id": "6501d432afe2730012f74d68",
- "name": "React",
- "icon": "react-icon",
- "variant": "6501d432afe2730012f74d69",
- "level": "6501d432afe2730012f74d70"
}
], - "totalDocs": 50,
- "limit": 10,
- "totalPages": 5,
- "page": 1,
- "pagingCounter": 1,
- "hasPrevPage": false,
- "hasNextPage": true,
- "prevPage": null,
- "nextPage": 2
}FindTemplateVariantsController_handle
Authorizations:
query Parameters
| order | string Default: "desc" Enum: "asc" "desc" |
| orderBy | string Default: "_id" |
| offset | number >= 0 Default: 0 |
| page | number >= 1 Default: 1 Example: page=1 |
| pageSize | number [ 1 .. 2000 ] Default: 20 Example: pageSize=10 |
| limit | number [ 0 .. 2000 ] Default: 20 |
| search | string |
header Parameters
| x-workspace-id | any Provide to identify the specific workspace from request |
| x-subaccount-id | any Provide to identify the specific subaccount from request |
| x-language | any Provide to identify the locale from the content |
Responses
Response samples
- 200
{- "docs": [
- {
- "_id": "6501d432afe2730012f74d68",
- "name": "React",
- "icon": "react-icon",
- "variant": "6501d432afe2730012f74d69",
- "level": "6501d432afe2730012f74d70"
}
], - "totalDocs": 50,
- "limit": 10,
- "totalPages": 5,
- "page": 1,
- "pagingCounter": 1,
- "hasPrevPage": false,
- "hasNextPage": true,
- "prevPage": null,
- "nextPage": 2
}FindVariantSkillByIdController_handle
Authorizations:
path Parameters
| id required | string Example: 1661452472991 |
header Parameters
| x-workspace-id | any Provide to identify the specific workspace from request |
| x-subaccount-id | any Provide to identify the specific subaccount from request |
| x-language | any Provide to identify the locale from the content |
Responses
Response samples
- 200
{- "_id": "6501d432afe2730012f74d68",
- "skill": {
- "_id": "6501d432afe2730012f74d68",
- "name": "React",
- "description": "A JavaScript library for building UI",
- "icon": "react-icon",
- "translated_content": { }
}, - "levels": [
- {
- "_id": "6501d432afe2730012f74d68",
- "level": 1,
- "name": "Beginner",
- "description": "Can perform basic tasks"
}
], - "default_locale": "en",
- "translated_content": { },
- "company": "6501d432afe2730012f74d68",
- "created": "2019-08-24T14:15:22Z"
}UpdateSkillVariantController_handle
Authorizations:
path Parameters
| id required | string Example: 61b8e9bb2300e80010c0bcc2 |
header Parameters
| x-workspace-id | any Provide to identify the specific workspace from request |
| x-subaccount-id | any Provide to identify the specific subaccount from request |
| x-language | any Provide to identify the locale from the content |
Request Body schema: application/jsonrequired
| _id required | object Document ID |
| name required | string <= 50 characters Name of the skill variant |
required | Array of objects (LevelDto) |
object Skill | |
object Translated content for skill variant | |
| default_locale | string Default locale for the skill variant content |
| subaccount_ids | Array of objects (ObjectId) Subaccounts user belongs to |
Responses
Request samples
- Payload
{- "_id": { },
- "name": "string",
- "levels": [
- {
- "_id": { },
- "level": 0,
- "translated_content": {
- "pt": {
- "name": "string",
- "description": "string"
}, - "en": {
- "name": "string",
- "description": "string"
}, - "es": {
- "name": "string",
- "description": "string"
}
}
}
], - "skill": {
- "_id": { },
- "translated_content": {
- "pt": {
- "name": "string",
- "description": "string"
}, - "en": {
- "name": "string",
- "description": "string"
}, - "es": {
- "name": "string",
- "description": "string"
}
}, - "name": "string",
- "description": "string"
}, - "translated_content": {
- "pt": {
- "name": "string",
- "description": "string"
}, - "en": {
- "name": "string",
- "description": "string"
}, - "es": {
- "name": "string",
- "description": "string"
}
}, - "default_locale": "pt",
- "subaccount_ids": [
- "62b384d70309831f9c13c87d",
- "62b5faff5a80481c2cba4669"
]
}Translate variant name, description, levels and examples
Authorizations:
path Parameters
| id required | string Example: 61b8e9bb2300e80010c0bcc2 |
header Parameters
| x-workspace-id | any Provide to identify the specific workspace from request |
| x-subaccount-id | any Provide to identify the specific subaccount from request |
| x-language | any Provide to identify the locale from the content |
Request Body schema: application/jsonrequired
| targetLocales required | Array of strings non-empty Target language codes for translation (e.g. ["en","pt"]). |
Responses
Request samples
- Payload
{- "targetLocales": [
- "string"
]
}ExportSkillVariantsController_list
Authorizations:
query Parameters
| order | string Default: "desc" Enum: "asc" "desc" |
| orderBy | string Default: "_id" |
| offset | number >= 0 Default: 0 |
| page | number >= 1 Default: 1 Example: page=1 |
| pageSize | number [ 1 .. 2000 ] Default: 20 Example: pageSize=10 |
| limit | number [ 0 .. 2000 ] Default: 20 |
| search | string |
| ids | Array of strings Example: ids=61b8e9bb2300e80010c0bcc2 |
header Parameters
| x-workspace-id | any Provide to identify the specific workspace from request |
| x-subaccount-id | any Provide to identify the specific subaccount from request |
| x-language | any Provide to identify the locale from the content |
Responses
Response samples
- 200
{- "docs": [
- {
- "id": "61b8e9bb2300e80010c0bcc2",
- "name": "JavaScript",
- "variant": "6501d432afe2730012f74d70",
- "level": "6501d432afe2730012f74d71"
}
], - "limit": 10,
- "page": 1,
- "totalPages": 3,
- "totalDocs": 25,
- "hasNextPage": true,
- "hasPrevPage": false,
- "prevPage": null,
- "nextPage": 2
}ExportSkillVariantsController_exportCsv
Authorizations:
header Parameters
| x-workspace-id | any Provide to identify the specific workspace from request |
| x-subaccount-id | any Provide to identify the specific subaccount from request |
| x-language | any Provide to identify the locale from the content |
Request Body schema: application/jsonrequired
| search | string Full-text search on skill name |
| ids | Array of strings Filter by explicit skill ids |
Responses
Request samples
- Payload
{- "search": "string",
- "ids": [
- "string"
]
}Response samples
- 200
[- {
- "filename": "export.csv",
- "data": "id;name;status"
}
]FindEmployeesController_handle
Authorizations:
query Parameters
| order | string Default: "desc" Enum: "asc" "desc" |
| orderBy | string Default: "_id" |
| offset | number >= 0 Default: 0 |
| page | number >= 1 Default: 1 Example: page=1 |
| pageSize | number [ 1 .. 2000 ] Default: 20 Example: pageSize=10 |
| limit | number [ 0 .. 2000 ] Default: 20 |
| status | string Example: status=active |
| query | string Example: query=eyI9PSI6W3sidmFyIjoic3RhdHVzIn0sImFjdGl2ZSJdfQ== Base64-encoded JSONLogic filter tree. Supported fields: status, roles, external_id, educations.field_study, certifications.name, languages.code, address.full_location, projects.name. |
| search | string |
header Parameters
| x-workspace-id | any Provide to identify the specific workspace from request |
| x-subaccount-id | any Provide to identify the specific subaccount from request |
| x-language | any Provide to identify the locale from the content |
Responses
Response samples
- 200
{- "docs": [
- {
- "_id": "6501d432afe2730012f74d68",
- "displayName": "John Doe",
- "email": "john.doe@example.com",
- "roles": [
- "user"
], - "status": "active",
- "created": "2019-08-24T14:15:22Z",
- "last_login": "2019-08-24T14:15:22Z",
- "invited_date": "2019-08-24T14:15:22Z",
- "external_id": "ext-123",
- "tags": [
- [
- "backend",
- "remote"
]
], - "position": "6501d432afe2730012f74d69",
- "positionName": "Engineer",
- "track": "6501d432afe2730012f74d70",
- "trackName": "Backend",
- "team": "6501d432afe2730012f74d71",
- "teamName": "Team Alpha",
- "career": "6501d432afe2730012f74d73",
- "careerName": "Engineering",
- "subaccount_ids": [
- "6501d432afe2730012f74d72"
], - "status_formatted": "Active",
- "roles_formatted": [
- [
- "User"
]
]
}
], - "totalDocs": 100,
- "limit": 10,
- "totalPages": 10,
- "page": 1,
- "pagingCounter": 1,
- "hasPrevPage": false,
- "hasNextPage": true,
- "prevPage": null,
- "nextPage": 2
}CreateEmployeeController_handle
Authorizations:
header Parameters
| x-workspace-id | any Provide to identify the specific workspace from request |
| x-subaccount-id | any Provide to identify the specific subaccount from request |
| x-language | any Provide to identify the locale from the content |
Request Body schema: application/jsonrequired
required | Array of objects (CreateWorkspaceUserDto) non-empty List of users to add to workspace |
Responses
Request samples
- Payload
{- "users": [
- {
- "email": "john@example.com",
- "displayName": "John Doe",
- "permissions": [
- "list_jobs"
], - "roles": [
- "user"
], - "linkedin_url": "string",
- "position": "62b384d70309831f9c13c87d",
- "positionName": "string",
- "team": "62b...",
- "teamName": "string",
- "external_id": "string",
- "tags": [
- "string"
], - "active": true,
- "status": "draft"
}
]
}Response samples
- 200
- 201
[- {
- "_id": "string",
- "external_id": "string",
- "displayName": "string",
- "email": "string",
- "token": "string",
- "status": "draft",
- "status_formatted": "string",
- "inviteLink": "string",
- "roles": "user",
- "roles_formatted": "string",
- "permissions": [
- "list_jobs"
], - "linkedin_url": "string",
- "position": "string",
- "positionName": "string",
- "team": "string",
- "teamName": "string",
- "tags": [
- "string"
], - "created": "2019-08-24T14:15:22Z",
- "invited_date": "2019-08-24T14:15:22Z"
}
]RemoveEmployeesController_handle
Authorizations:
header Parameters
| x-workspace-id | any Provide to identify the specific workspace from request |
| x-subaccount-id | any Provide to identify the specific subaccount from request |
| x-language | any Provide to identify the locale from the content |
Request Body schema: application/jsonrequired
Bulk remove employees
required | Array of objects (RemoveEmployeeItemDto) non-empty List of users to remove |
Responses
Request samples
- Payload
{- "users": [
- {
- "id": "61b8e9bb2300e80010c0bcc2",
- "deleteAccount": false
}
]
}FindEmployeeController_handle
Authorizations:
path Parameters
| id required | string Example: 1661452472991 |
header Parameters
| x-workspace-id | any Provide to identify the specific workspace from request |
| x-subaccount-id | any Provide to identify the specific subaccount from request |
| x-language | any Provide to identify the locale from the content |
Responses
Response samples
- 200
{- "_id": "6501d432afe2730012f74d68",
- "displayName": "John Doe",
- "email": "john.doe@example.com",
- "roles": "user",
- "status": "active",
- "created": "2019-08-24T14:15:22Z",
- "last_login": "2019-08-24T14:15:22Z",
- "permissions": [
- "list_jobs"
], - "external_id": "ext-123",
- "tags": [
- [
- "backend",
- "remote"
]
], - "position": "6501d432afe2730012f74d69",
- "positionName": "Engineer",
- "trackName": "Backend",
- "team": "6501d432afe2730012f74d70",
- "teamName": "Team Alpha",
- "subaccount_ids": [
- "6501d432afe2730012f74d71"
], - "status_formatted": "Active",
- "roles_formatted": [
- [
- "User"
]
]
}UpdateEmployeeController_handle
Authorizations:
path Parameters
| id required | string Example: 61b8e9bb2300e80010c0bcc2 |
header Parameters
| x-workspace-id | any Provide to identify the specific workspace from request |
| x-subaccount-id | any Provide to identify the specific subaccount from request |
| x-language | any Provide to identify the locale from the content |
Request Body schema: application/jsonrequired
| displayName required | string <= 50 characters User name |
| email required | string <email> User email |
| roles required | string Default: "user" Enum: "user" "admin" "hunter" "manager" User role |
| permissions | Array of strings Items Enum: "list_jobs" "manage_jobs" "create_jobs" "edit_jobs" "delete_jobs" "edit_partners" "edit_followers" "list_assessments" "manage_assessments" "create_assessment" "edit_assessments" "delete_assessments" "list_attempts" "manage_attempts" "edit_attempts" "delete_attempts" "reopen_attempts" "read_question" "manage_question" "create_question" "update_question" "delete_question" "read_company" "manage_company" "create_company" "update_company" "delete_company" "read_user" "manage_user" "create_user" "update_user" "delete_user" "manage_permission" User permissions |
| position | object User's current position id |
| positionName | string User's current position name |
| team | object Team id to assign user into |
| teamName | string Team name to assign user into |
| active | boolean Default: true Indicates if the user can login on the platform |
| status | string Default: "active" Enum: "draft" "invited" "active" "paused" "inactive" Status of the user in the workspace |
| subaccount_ids required | Array of objects (ObjectId) Subaccounts user belongs to |
| external_id | string External integration identifier for the user |
| tags | Array of strings Tags for the user |
Responses
Request samples
- Payload
{- "displayName": "User 1",
- "email": "john@example.com",
- "roles": "user",
- "permissions": [
- "list_jobs"
], - "position": "62b384d70309831f9c13c87d",
- "positionName": "string",
- "team": "62b...",
- "teamName": "string",
- "active": true,
- "status": "draft",
- "subaccount_ids": [
- "62b384d70309831f9c13c87d",
- "62b5faff5a80481c2cba4669"
], - "external_id": "string",
- "tags": [
- "string"
]
}RemoveEmployeeController_handle
Authorizations:
path Parameters
| id required | string User ID to remove |
header Parameters
| x-workspace-id | any Provide to identify the specific workspace from request |
| x-subaccount-id | any Provide to identify the specific subaccount from request |
| x-language | any Provide to identify the locale from the content |
Request Body schema: application/jsonrequired
Payload with delete flag
| deleteAccount | boolean Default: false If true, also soft-delete the user account |
Responses
Request samples
- Payload
{- "deleteAccount": false
}FindSubaccountsController_handle
Authorizations:
query Parameters
| order | string Default: "desc" Enum: "asc" "desc" |
| orderBy | string Default: "_id" |
| offset | number >= 0 Default: 0 |
| page | number >= 1 Default: 1 Example: page=1 |
| pageSize | number [ 1 .. 2000 ] Default: 20 Example: pageSize=10 |
| limit | number [ 0 .. 2000 ] Default: 20 |
| search | string |
| _id required | Array of strings |
header Parameters
| x-workspace-id | any Provide to identify the specific workspace from request |
| x-subaccount-id | any Provide to identify the specific subaccount from request |
| x-language | any Provide to identify the locale from the content |
Responses
Response samples
- 200
{- "docs": [
- {
- "_id": "6501d432afe2730012f74d68",
- "name": "Engineering Team",
- "users_count": 15,
- "users": [
- {
- "_id": "6501d432afe2730012f74d68",
- "displayName": "John Doe",
}
], - "created": "2019-08-24T14:15:22Z"
}
], - "totalDocs": 50,
- "limit": 10,
- "totalPages": 5,
- "page": 1,
- "pagingCounter": 1,
- "hasPrevPage": false,
- "hasNextPage": true,
- "prevPage": null,
- "nextPage": 2
}CreateSubaccountController_handle
Authorizations:
header Parameters
| x-workspace-id | any Provide to identify the specific workspace from request |
| x-subaccount-id | any Provide to identify the specific subaccount from request |
| x-language | any Provide to identify the locale from the content |
Request Body schema: application/jsonrequired
| name required | string Subaccount name |
| department | string Department name |
| region | string Region name |
| user_ids | Array of strings unique List of user IDs to include in the subaccount |
Responses
Request samples
- Payload
{- "name": "Team A",
- "department": "string",
- "region": "string",
- "user_ids": [
- "string"
]
}FindSubaccountController_handle
Authorizations:
path Parameters
| subId required | string |
header Parameters
| x-workspace-id | any Provide to identify the specific workspace from request |
| x-subaccount-id | any Provide to identify the specific subaccount from request |
| x-language | any Provide to identify the locale from the content |
Responses
Response samples
- 200
{- "_id": "6501d432afe2730012f74d68",
- "name": "Engineering Team",
- "department": "Technology",
- "region": "North America",
- "created": "2019-08-24T14:15:22Z",
- "user_ids": [
- "6501d432afe2730012f74d68",
- "6501d432afe2730012f74d69"
], - "users": [
- {
- "_id": "6501d432afe2730012f74d68",
- "displayName": "John Doe",
- "email": "john.doe@example.com",
}
]
}Update a subaccount
Updates a subaccount and returns a JSON object with a redirect_to property.
Authorizations:
path Parameters
| subId required | string Workspace ID |
header Parameters
| x-workspace-id | any Provide to identify the specific workspace from request |
| x-subaccount-id | any Provide to identify the specific subaccount from request |
| x-language | any Provide to identify the locale from the content |
Request Body schema: application/jsonrequired
| name required | string Subaccount name |
| department | string Department name |
| region | string Region name |
| user_ids | Array of strings unique List of user IDs to include in the subaccount |
Responses
Request samples
- Payload
{- "name": "Team A",
- "department": "string",
- "region": "string",
- "user_ids": [
- "string"
]
}Response samples
- 200
{- "redirect_to": "/assessments/workspace/subaccounts/123"
}RemoveSubaccountController_handle
Authorizations:
path Parameters
| subId required | string Subaccount ID to remove |
header Parameters
| x-workspace-id | any Provide to identify the specific workspace from request |
| x-subaccount-id | any Provide to identify the specific subaccount from request |
| x-language | any Provide to identify the locale from the content |
Responses
FindSubaccountStatisticsController_handle
Authorizations:
path Parameters
| subId required | string |
header Parameters
| x-workspace-id | any Provide to identify the specific workspace from request |
| x-subaccount-id | any Provide to identify the specific subaccount from request |
| x-language | any Provide to identify the locale from the content |
Responses
Response samples
- 200
{- "assessments_count": 12,
- "questions_count": 50,
- "scorecards_count": 5,
- "skill_variants_count": 30,
- "teams_count": 3,
- "careers_count": 8,
- "users_count": 25
}FindUserSubaccountListController_handle
Authorizations:
query Parameters
| order | string Default: "desc" Enum: "asc" "desc" |
| orderBy | string Default: "_id" |
| offset | number >= 0 Default: 0 |
| page | number >= 1 Default: 1 Example: page=1 |
| pageSize | number [ 1 .. 2000 ] Default: 20 Example: pageSize=10 |
| limit | number [ 0 .. 2000 ] Default: 20 |
| search | string |
| _id required | Array of strings |
header Parameters
| x-workspace-id | any Provide to identify the specific workspace from request |
| x-subaccount-id | any Provide to identify the specific subaccount from request |
| x-language | any Provide to identify the locale from the content |
Responses
Response samples
- 200
{- "docs": [
- {
- "_id": "6501d432afe2730012f74d68",
- "name": "Engineering Team"
}
], - "totalDocs": 50,
- "totalPages": 5,
- "page": 1,
- "pageSize": 10
}FindUserTeamsController_handle
Authorizations:
path Parameters
| id required | string User id |
query Parameters
| order | string Default: "desc" Enum: "asc" "desc" |
| orderBy | string Default: "_id" |
| offset | number >= 0 Default: 0 |
| page | number >= 1 Default: 1 Example: page=1 |
| pageSize | number [ 1 .. 2000 ] Default: 20 Example: pageSize=10 |
| limit | number [ 0 .. 2000 ] Default: 20 |
header Parameters
| x-workspace-id | any Provide to identify the specific workspace from request |
| x-subaccount-id | any Provide to identify the specific subaccount from request |
| x-language | any Provide to identify the locale from the content |
Responses
Response samples
- 200
{- "docs": [
- {
- "_id": "62b384d70309831f9c13c87d",
- "name": "Engineering",
- "description": "Engineering team responsible for product development.",
- "external_id": "ext-xyz",
- "people_count": 5,
- "status": "active",
- "created": "2019-08-24T14:15:22Z"
}
], - "totalDocs": 0,
- "limit": 20,
- "page": 1,
- "totalPages": 0,
- "pagingCounter": 1,
- "hasPrevPage": false,
- "hasNextPage": false,
- "prevPage": null,
- "nextPage": null
}FindCreditsHistoryController_handle
Authorizations:
query Parameters
| order | string Default: "desc" Enum: "asc" "desc" |
| orderBy | string Default: "_id" |
| offset | number >= 0 Default: 0 |
| page | number >= 1 Default: 1 Example: page=1 |
| pageSize | number [ 1 .. 2000 ] Default: 20 Example: pageSize=10 |
| limit | number [ 0 .. 2000 ] Default: 20 |
| query | string Example: query=eyI9PSI6W3sidmFyIjoidHlwZSJ9LCJoYXJkX3NraWxscyJdfQ== Base64-encoded JSONLogic filter tree. Supported fields: author, action, type, created, expires |
header Parameters
| x-workspace-id | any Provide to identify the specific workspace from request |
| x-subaccount-id | any Provide to identify the specific subaccount from request |
| x-language | any Provide to identify the locale from the content |
Responses
Response samples
- 200
{- "docs": [
- {
- "_id": "6501d432afe2730012f74d68",
- "author": {
- "_id": "6501d432afe2730012f74d68",
- "displayName": "John Doe"
}, - "action": "credits",
- "quantity": 100,
- "type": "hard_skills",
- "usage": 5,
- "created": "2019-08-24T14:15:22Z",
- "expires": "2019-08-24T14:15:22Z",
- "description": "Monthly credit allocation",
- "type_formatted": "Hard Skills",
- "action_formatted": "Credits"
}
], - "totalDocs": 50,
- "limit": 10,
- "totalPages": 5,
- "page": 1,
- "pagingCounter": 1,
- "hasPrevPage": false,
- "hasNextPage": true,
- "prevPage": null,
- "nextPage": 2
}FindCreditsStatisticsController_handle
Authorizations:
header Parameters
| x-workspace-id | any Provide to identify the specific workspace from request |
| x-subaccount-id | any Provide to identify the specific subaccount from request |
| x-language | any Provide to identify the locale from the content |
Responses
Response samples
- 200
{- "total": 500,
- "totalDocs": 25,
- "hard_skills": {
- "balance": 100,
- "status": "sufficient"
}, - "soft_skills": {
- "balance": 100,
- "status": "sufficient"
}, - "usage": 150,
- "updated": "2019-08-24T14:15:22Z"
}FindCreditsFieldsController_handle
Authorizations:
header Parameters
| x-workspace-id | any Provide to identify the specific workspace from request |
| x-subaccount-id | any Provide to identify the specific subaccount from request |
| x-language | any Provide to identify the locale from the content |
Responses
Response samples
- 200
{- "action": [
- {
- "value": "credits",
- "label": "Credits"
}, - {
- "value": "unlock",
- "label": "Unlock"
}
], - "type": [
- {
- "value": "hard_skills",
- "label": "Hard Skills"
}, - {
- "value": "soft_skills",
- "label": "Soft Skills"
}
]
}FindCreditsHistoryUsersController_handle
Authorizations:
query Parameters
| search | string |
header Parameters
| x-workspace-id | any Provide to identify the specific workspace from request |
| x-subaccount-id | any Provide to identify the specific subaccount from request |
| x-language | any Provide to identify the locale from the content |
Responses
Response samples
- 200
{- "docs": [
- {
- "value": "6501d432afe2730012f74d68",
- "label": "John Doe"
}
], - "totalDocs": 20,
- "limit": 10,
- "totalPages": 2,
- "page": 1,
- "pagingCounter": 1,
- "hasPrevPage": false,
- "hasNextPage": true,
- "prevPage": null,
- "nextPage": 2
}ExportCreditsHistoryController_handle
Authorizations:
header Parameters
| x-workspace-id | any Provide to identify the specific workspace from request |
| x-subaccount-id | any Provide to identify the specific subaccount from request |
| x-language | any Provide to identify the locale from the content |
Request Body schema: application/jsonrequired
| startDate | string |
| endDate | string |
| action | string |
Responses
Request samples
- Payload
{- "startDate": "string",
- "endDate": "string",
- "action": "string"
}FindEmployeesStatisticsController_handle
Authorizations:
header Parameters
| x-workspace-id | any Provide to identify the specific workspace from request |
| x-subaccount-id | any Provide to identify the specific subaccount from request |
| x-language | any Provide to identify the locale from the content |
Responses
Response samples
- 200
{- "total": 42,
- "users_count": 35,
- "admins_count": 7
}ExportUsersController_handle
Authorizations:
query Parameters
| order | string Default: "desc" Enum: "asc" "desc" |
| orderBy | string Default: "_id" |
| offset | number >= 0 Default: 0 |
| page | number >= 1 Default: 1 Example: page=1 |
| pageSize | number [ 1 .. 2000 ] Default: 20 Example: pageSize=10 |
| limit | number [ 0 .. 2000 ] Default: 20 |
| status | string Example: status=active |
| query | string Base64-encoded JSONLogic filter tree. Supported fields align with /workspace/users. |
| search | string |
header Parameters
| x-workspace-id | any Provide to identify the specific workspace from request |
| x-subaccount-id | any Provide to identify the specific subaccount from request |
| x-language | any Provide to identify the locale from the content |
Responses
Response samples
- 200
{- "docs": [
- {
- "user": "6501d432afe2730012f74d68",
- "email": "user@example.com",
- "name": "John Doe",
- "completeness_index": 0.85,
- "status": "active",
- "linkedin": true,
- "onboarding": true,
- "last_interaction": true
}
], - "totalDocs": 25,
- "limit": 10,
- "page": 1,
- "totalPages": 3,
- "pagingCounter": 1,
- "hasPrevPage": false,
- "hasNextPage": true,
- "prevPage": null,
- "nextPage": 2
}ExportUsersController_exportCsv
Authorizations:
header Parameters
| x-workspace-id | any Provide to identify the specific workspace from request |
| x-subaccount-id | any Provide to identify the specific subaccount from request |
| x-language | any Provide to identify the locale from the content |
Request Body schema: application/jsonrequired
| query | string Base64-encoded JSONLogic filter tree. Supported fields align with /workspace/users. |
| search | string Full-text search across name/email |
| status | string Filter by status (active/inactive/pending) |
| startDate | string When provided with endDate, will download CSV for range |
| endDate | string When provided with startDate, will download CSV for range |
Responses
Request samples
- Payload
{- "query": "string",
- "search": "string",
- "status": "string",
- "startDate": "2024-01-01",
- "endDate": "2024-01-31"
}FindUserProfileController_handle
Authorizations:
path Parameters
| id required | string Example: 1661452472991 |
header Parameters
| x-workspace-id | any Provide to identify the specific workspace from request |
| x-subaccount-id | any Provide to identify the specific subaccount from request |
| x-language | any Provide to identify the locale from the content |
Responses
Response samples
- 200
{- "_id": "6501d432afe2730012f74d68",
- "displayName": "John Doe",
- "email": "john.doe@example.com",
- "status": "active",
- "roles": [
- "user"
], - "integrations": { },
- "social_medias": { },
- "headline": "Software Engineer @ Example Inc.",
- "bio": "Passionate about building scalable products.",
- "experiences": [
- [
- {
- "title": "Senior Engineer",
- "company_name": "Example Inc."
}, - {
- "title": "Engineer",
- "company_name": "Startup"
}
]
], - "social_causes": [
- [
- "Education",
- "Health"
]
], - "languages": [
- [
- {
- "code": "en",
- "level": "advanced"
}
]
], - "educations": [
- [
- {
- "school_name": "ABC University",
- "field_study": "CS"
}
]
], - "address": {
- "city": "Sao Paulo",
- "country": "BR",
- "full_location": "Sao Paulo, BR"
}, - "years_experience": 0,
- "last_onboarding_interaction": "2019-08-24T14:15:22Z",
- "completeness_index": 0.8,
- "created": "2019-08-24T14:15:22Z",
- "last_login": "2019-08-24T14:15:22Z",
- "external_id": "string",
- "tags": [
- [
- "backend",
- "remote"
]
], - "summary": "Seasoned engineer focused on platform reliability.",
- "skills": [
- "skillId1",
- "skillId2"
], - "highlighted_skills": [
- "skillId1"
], - "certifications": [
- [
- {
- "name": "AWS Certified Solutions Architect",
- "year": 2024
}
]
], - "position": "6501d432afe2730012f74d68",
- "positionName": "Engineer",
- "track": "6501d432afe2730012f74d69",
- "trackName": "Backend",
- "team": "6501d432afe2730012f74d70",
- "teamName": "Team Alpha"
}FindAnalysisPlansController_handle
Authorizations:
query Parameters
| order | string Default: "desc" Enum: "asc" "desc" |
| orderBy | string Default: "_id" |
| offset | number >= 0 Default: 0 |
| page | number >= 1 Default: 1 Example: page=1 |
| pageSize | number [ 1 .. 2000 ] Default: 20 Example: pageSize=10 |
| limit | number [ 0 .. 2000 ] Default: 20 |
| search | string |
| status | string Example: status=available |
| grouping | string Enum: "public" "company" Grouping by content status. Cannot be used with status |
header Parameters
| x-workspace-id | any Provide to identify the specific workspace from request |
| x-subaccount-id | any Provide to identify the specific subaccount from request |
| x-language | any Provide to identify the locale from the content |
Responses
FindAnalysisPlanController_handle
Authorizations:
path Parameters
| id required | string Example: 61b8e9bb2300e80010c0bcc2 |
header Parameters
| x-workspace-id | any Provide to identify the specific workspace from request |
| x-subaccount-id | any Provide to identify the specific subaccount from request |
| x-language | any Provide to identify the locale from the content |
Responses
UpdateAnalysisPlanController_handle
Authorizations:
path Parameters
| id required | string |
header Parameters
| x-workspace-id | any Provide to identify the specific workspace from request |
| x-subaccount-id | any Provide to identify the specific subaccount from request |
| x-language | any Provide to identify the locale from the content |
Request Body schema: application/jsonrequired
| company required | object Indicates which company owns the analysis |
| name required | string Analysis name |
| questions required | Array of objects List of questions |
| categories required | Array of objects (ObjectId) Related categoriess |
required | object (SettingsDto) |
| status required | string Enum: "draft" "pending" "invited" "available" "expired_invite" "disabled" "archived" "started" Assessment status |
Responses
Request samples
- Payload
{- "company": "62b5faff5a80481c2cba4669",
- "name": "Coodesh Analysis",
- "questions": [
- { }
], - "categories": "62b5faff5a80481c2cba4669",
- "settings": {
- "invites_expiration": 120,
- "retry_interval": "15",
- "keep_tags": true,
- "assess_team": true,
- "is_public": "hidden",
- "hidden_results": true,
- "shuffle_questions": true,
- "hidden_question_titles": true,
- "tags": [
- "62b384d70309831f9c13c87d",
- "62b5faff5a80481c2cba4669"
], - "grade_tags": [
- {
- "threshold_high": 0,
- "threshold_low": 0,
- "tag": { }
}
], - "reminder_emails": {
- "title": "string",
- "key": "string",
- "subject": "string",
- "message": "string",
- "value": "string"
}, - "reminder_emails_schedule": {
- "template": "string",
- "value": "string",
- "unit": "days"
}, - "design": {
- "custom_name": "Coodesh Assessment",
- "initial_message": "string",
- "final_message": "string",
- "mobile_support": true
}, - "anticheat": {
- "track_copy_paste": true,
- "track_copy_paste_warn_examinee": true,
- "track_tab_switch": true,
- "track_tab_switch_warn_examinee": true,
- "track_fullscreen_switch": true,
- "photo_identification": true,
- "ia_webcam_image_detection": true,
- "webcam_proctoring": true,
- "audio_proctoring": true,
- "ia_plagiarism_detection": true,
- "detect_monitors": true,
- "screen_proctoring": true
}, - "timezone": "string",
- "goals": "string",
- "email_sender": "62b5faff5a80481c2cba4669",
- "locales": { },
- "callback_url": "string",
- "redirect_timeout": 30,
- "job_id": "string",
- "disable_email_notification": true,
- "generate_certificate": true,
- "generate_certificate_threshold": 0,
- "notification_recipients": [
- "user@example.com"
], - "time_open_enabled": true,
- "time_open": "2019-08-24T14:15:22Z",
- "time_close_enabled": true,
- "time_close": "2019-08-24T14:15:22Z",
- "enable_new_attempt_previous_answers": true,
- "enable_simultaneous_answers_start": true,
- "tools": { }
}, - "status": "available"
}FindAnalysisResponsesController_handle
Authorizations:
path Parameters
| id required | string Example: 61b8e9bb2300e80010c0bcc2 |
query Parameters
| order | string Default: "desc" Enum: "asc" "desc" |
| orderBy | string Default: "_id" |
| offset | number >= 0 Default: 0 |
| page | number >= 1 Default: 1 Example: page=1 |
| pageSize | number [ 1 .. 2000 ] Default: 20 Example: pageSize=10 |
| limit | number [ 0 .. 2000 ] Default: 20 |
| search | string |
| status | string Example: status=invited Filter by status. Cannot be used with grouping query |
| grouping | string Enum: "results" "invited" Grouping by status. Cannot be used with status query |
header Parameters
| x-workspace-id | any Provide to identify the specific workspace from request |
| x-subaccount-id | any Provide to identify the specific subaccount from request |
| x-language | any Provide to identify the locale from the content |
Responses
FindAnalysesStatisticsController_handle
Authorizations:
path Parameters
| id required | string Example: 61b8e9bb2300e80010c0bcc2 |
header Parameters
| x-workspace-id | any Provide to identify the specific workspace from request |
| x-subaccount-id | any Provide to identify the specific subaccount from request |
| x-language | any Provide to identify the locale from the content |
Responses
FindAnalysisResponseController_handle
Authorizations:
path Parameters
| id required | string Example: 61b8e9bb2300e80010c0bcc2 |
| resultId required | string Example: 61b8e9bb2300e80010c0bcc2 |
header Parameters
| x-workspace-id | any Provide to identify the specific workspace from request |
| x-subaccount-id | any Provide to identify the specific subaccount from request |
| x-language | any Provide to identify the locale from the content |
Responses
UpdateAnalysisResponseController_handle
Authorizations:
path Parameters
| id required | object (ObjectId) |
| resultId required | object (ObjectId) |
header Parameters
| x-workspace-id | any Provide to identify the specific workspace from request |
| x-subaccount-id | any Provide to identify the specific subaccount from request |
| x-language | any Provide to identify the locale from the content |
Request Body schema: application/jsonrequired
| _id required | object ID |
| answers required | Array of objects non-empty List of answers |
Responses
Request samples
- Payload
{- "_id": { },
- "answers": [
- { }
]
}DeleteAnalysisResponseController_handle
Authorizations:
path Parameters
| id required | string Example: 61b8e9bb2300e80010c0bcc2 |
| resultId required | string Example: 61b8e9bb2300e80010c0bcc2 |
header Parameters
| x-workspace-id | any Provide to identify the specific workspace from request |
| x-subaccount-id | any Provide to identify the specific subaccount from request |
| x-language | any Provide to identify the locale from the content |
Responses
FindSkillsListController_handle
Authorizations:
query Parameters
| order | string Default: "desc" Enum: "asc" "desc" |
| orderBy | string Default: "_id" |
| offset | number >= 0 Default: 0 |
| page | number >= 1 Default: 1 Example: page=1 |
| pageSize | number [ 1 .. 2000 ] Default: 20 Example: pageSize=10 |
| limit | number [ 0 .. 2000 ] Default: 20 |
| search | string |
header Parameters
| x-workspace-id | any Provide to identify the specific workspace from request |
| x-subaccount-id | any Provide to identify the specific subaccount from request |
| x-language | any Provide to identify the locale from the content |
Responses
Generate auto login link
This endpoint creates invite links with user token to reduce the number of clicks to access the scorecard page.
Authorizations:
header Parameters
| x-workspace-id | any Provide to identify the specific workspace from request |
| x-subaccount-id | any Provide to identify the specific subaccount from request |
| x-language | any Provide to identify the locale from the content |
Request Body schema: application/jsonrequired
| analyses required | Array of objects (ObjectId) Analysis ids to generate autologin links |
| analysis_plan required | object Analysis Plan |
Responses
Request samples
- Payload
{- "analyses": [
- "62b384d70309831f9c13c87d",
- "62b5faff5a80481c2cba4669"
], - "analysis_plan": "62b384d70309831f9c13c87d"
}Generate analysis for employees
This endpoint can be used by admins to generate analysis for employees
Authorizations:
header Parameters
| x-workspace-id | any Provide to identify the specific workspace from request |
| x-subaccount-id | any Provide to identify the specific subaccount from request |
| x-language | any Provide to identify the locale from the content |
Request Body schema: application/jsonrequired
| users required | Array of objects (ObjectId) List of users |
| tracks required | Array of objects (ObjectId) List of team tracks |
| positions required | Array of objects (ObjectId) List of team positions |
| team required | object Team ID to filter the analysis |
Responses
Request samples
- Payload
{- "users": [
- { }
], - "tracks": [
- { }
], - "positions": [
- { }
], - "team": { }
}Response samples
- 201
[- { }
]Generate analysis for employees on onboarding process
This endpoint can be used by developers to generate analysis for themselves
Authorizations:
header Parameters
| x-workspace-id | any Provide to identify the specific workspace from request |
| x-subaccount-id | any Provide to identify the specific subaccount from request |
| x-language | any Provide to identify the locale from the content |
Request Body schema: application/jsonrequired
| users required | Array of objects (ObjectId) List of users |
| tracks required | Array of objects (ObjectId) List of team tracks |
| positions required | Array of objects (ObjectId) List of team positions |
| team required | object Team ID to filter the analysis |
Responses
Request samples
- Payload
{- "users": [
- { }
], - "tracks": [
- { }
], - "positions": [
- { }
], - "team": { }
}FindSkillRadarController_handle
Authorizations:
path Parameters
| resultId required | string Example: 61b8e9bb2300e80010c0bcc2 |
query Parameters
| attemptId required | string |
header Parameters
| x-workspace-id | any Provide to identify the specific workspace from request |
| x-subaccount-id | any Provide to identify the specific subaccount from request |
| x-language | any Provide to identify the locale from the content |
Responses
FindSkillRadarByAttemptController_handle
Authorizations:
path Parameters
| attemptId required | string Example: 61b8e9bb2300e80010c0bcc2 |
header Parameters
| x-workspace-id | any Provide to identify the specific workspace from request |
| x-subaccount-id | any Provide to identify the specific subaccount from request |
| x-language | any Provide to identify the locale from the content |
Responses
FindSkillRadarByTeamController_handle[0]
Authorizations:
path Parameters
| teamId required | string Example: 61b8e9bb2300e80010c0bcc2 |
| talentId required | string Example: 61b8e9bb2300e80010c0bcc2 |
header Parameters
| x-workspace-id | any Provide to identify the specific workspace from request |
| x-subaccount-id | any Provide to identify the specific subaccount from request |
| x-language | any Provide to identify the locale from the content |
Responses
FindSkillRadarByTeamController_handle[1]
Authorizations:
path Parameters
| teamId required | string Example: 61b8e9bb2300e80010c0bcc2 |
| talentId required | string Example: 61b8e9bb2300e80010c0bcc2 |
header Parameters
| x-workspace-id | any Provide to identify the specific workspace from request |
| x-subaccount-id | any Provide to identify the specific subaccount from request |
| x-language | any Provide to identify the locale from the content |
Responses
GetScorecardFieldsController_handle
query Parameters
| type | string Example: type=team |
header Parameters
| x-workspace-id | any Provide to identify the specific workspace from request |
| x-subaccount-id | any Provide to identify the specific subaccount from request |
| x-language | any Provide to identify the locale from the content |
Responses
SyncProfileToAnalysisResponsesController_handle
Authorizations:
header Parameters
| x-workspace-id | any Provide to identify the specific workspace from request |
| x-subaccount-id | any Provide to identify the specific subaccount from request |
| x-language | any Provide to identify the locale from the content |
Responses
Find Analysis Plan Insights
Group responses by skill, returning the users and their levels
Authorizations:
path Parameters
| id required | string Example: 61b8e9bb2300e80010c0bcc2 |
header Parameters
| x-workspace-id | any Provide to identify the specific workspace from request |
| x-subaccount-id | any Provide to identify the specific subaccount from request |
| x-language | any Provide to identify the locale from the content |
Responses
Get all assessments
This endpoint list all assessments from account
Authorizations:
query Parameters
| _id | Array of strings |
| search | string |
| order | string Default: "desc" Enum: "asc" "desc" |
| orderBy | string Default: "_id" |
| offset | number >= 0 Default: 0 |
| page | number >= 1 Default: 1 |
| pageSize | number [ 1 .. 2000 ] Default: 20 |
| limit | number [ 0 .. 2000 ] Default: 20 |
header Parameters
| x-workspace-id | any Provide to identify the specific workspace from request |
| x-subaccount-id | any Provide to identify the specific subaccount from request |
| x-language | any Provide to identify the locale from the content |
Responses
Response samples
- 200
[- {
- "limit": 150,
- "offset": 0,
- "total": 1,
- "payload": [
- {
- "assessment_id": "65a018780841da0012ca6273",
- "name": "Backend Node.js - JU81JV",
- "category": "string",
- "description": "Assessment from jobs 1",
- "level": "beginner",
- "level_formatted": "Basic",
- "default_locale": "pt",
- "duration": "60",
- "duration_unit": "minute",
- "questions": [
- { }
]
}
]
}
]Get attempt by Id
This endpoint get attempt using the ID for an given assessment.
Authorizations:
path Parameters
| attemptId required | string Example: 61b8e9bb2300e80010c0bcc2 |
header Parameters
| x-workspace-id | any Provide to identify the specific workspace from request |
| x-subaccount-id | any Provide to identify the specific subaccount from request |
| x-language | any Provide to identify the locale from the content |
Responses
Response samples
- 200
{- "attempt_id": "65dfa9f6feb036139eccce41",
- "title": "Backend Node.js",
- "assessment_id": "659cfcfe671ace001106dcaa",
- "description": "This is the result of your Backend Node.js assessment",
- "company_result_string": "User 1 scored 15% in the Backend Node.js assessment.\nTests:\n20% - BMI - Programming\n10% - Node.js - Quiz\nSuspicious actions: None\nSent at: 11:07 AM, April 11, 2024 GMT-03:00\nCompleted at: 6:25 PM, March 26, 2024 GMT-03:00\nReport: https://beta.coodesh.com/pt/share/assessments/66033c206c4a8c08e941513c?accessToken={token}",
- "status": "finished",
- "status_formatted": "Finished",
- "stage": "hired",
- "stage_formatted": "Hired",
- "score": 15,
- "score_type": "percentage",
- "results": [
- {
- "score": 15,
- "result_string": "string",
- "score_type": "percentage",
- "tier": "major",
- "title": "Backend Node.js",
- "description": "string",
- "date": "2024-03-26"
}
], - "provider_name": "Coodesh",
- "created": "2024-09-26T18:45:00.000Z",
- "invited": "2024-09-26T18:47:50.185Z",
- "updated": "2024-09-26T18:51:09.457Z",
- "started": "2024-09-26T18:47:50.179Z",
- "finished": "2024-09-26T18:50:25.575Z",
- "proctoring": {
- "devices": 1,
- "locations": 2,
- "fullscreen_exits": 0,
- "tab_exits": 3,
- "copy_paste_count": 0,
- "devtools_open_count": 0,
- "last_location": "BR",
- "last_device_type": "desktop",
- "last_browser": "Chrome",
- "last_os": "macOS",
- "severity_category": "none",
- "severity_category_formatted": "None"
}
}Create attempt
This endpoint creates attempt for an given assessment to the current requester. If an user with given email does not exist, it will be created.
Authorizations:
header Parameters
| x-workspace-id | any Provide to identify the specific workspace from request |
| x-subaccount-id | any Provide to identify the specific subaccount from request |
| x-language | any Provide to identify the locale from the content |
Request Body schema: application/jsonrequired
| name required | string Name of the candidate |
| email required | string <email> Email of the candidate |
| user_id required | string ID of the candidate |
| assessment_id required | string Test ID for the candidate to take |
| company_id required | string Company ID |
| job_id required | string Job ID associated with the test |
| callback_url required | string <uri> URL for callback after test completion |
| webhook_url required | string <uri> Webhook URL to send the test result to |
| disable_email required | boolean Default: true Disable invite email when creating the attempt |
Responses
Request samples
- Payload
{- "name": "Test User",
- "email": "test@example.com",
- "user_id": "6666c8a39641daa32b5f5443",
- "assessment_id": "659cfcfe671ace001106dcaa",
- "company_id": "6666c8c7e4421468fc1bcbb0",
- "job_id": "6666c8c2d944f09a35be0043",
- "disable_email": true
}Response samples
- 201
{- "attempt_id": "65dfa9f6feb036139eccce41",
}Sync attempt result
Recompute the score of an existing attempt, disable notifications by default
Authorizations:
path Parameters
| attemptId required | string Example: 61b8e9bb2300e80010c0bcc2 |
header Parameters
| x-workspace-id | any Provide to identify the specific workspace from request |
| x-subaccount-id | any Provide to identify the specific subaccount from request |
| x-language | any Provide to identify the locale from the content |
Request Body schema: application/jsonrequired
| disable_notification required | boolean Default: true Disable notifications when synchronizing |
| disable_ats_sync required | boolean Default: false Disable ats sync when synchronizing |
| disable_process_snapshots required | boolean Default: true Disable process snapshots when synchronizing |
| disable_calculate_traits required | boolean Default: false Disable calculate traits when synchronizing |
Responses
Request samples
- Payload
{- "disable_notification": true,
- "disable_ats_sync": true,
- "disable_process_snapshots": true,
- "disable_calculate_traits": true
}Response samples
- 201
{- "message": "Attempt synced successfully"
}Get all assessments
This endpoint list all assessments from account
Authorizations:
query Parameters
| searchString | string |
| order | string Default: "desc" Enum: "asc" "desc" |
| orderBy | string Default: "_id" |
| offset | number >= 0 Default: 0 |
| page | number >= 1 Default: 1 |
| pageSize | number [ 1 .. 2000 ] Default: 20 |
| limit | number [ 0 .. 2000 ] Default: 20 |
header Parameters
| x-workspace-id | any Provide to identify the specific workspace from request |
| x-subaccount-id | any Provide to identify the specific subaccount from request |
| x-language | any Provide to identify the locale from the content |
Responses
Response samples
- 200
[- {
- "limit": 150,
- "offset": 0,
- "total_tests": 1,
- "payload": [
- {
- "id": "65a018780841da0012ca6273",
- "name": "Backend Node.js - JU81JV",
- "category": "string",
- "description": "Assessment from jobs 1",
- "level": "advanced"
}
]
}
]Get attempt by Id
This endpoint get attempt using the ID for an given assessment.
Authorizations:
path Parameters
| attemptId required | string Example: 61b8e9bb2300e80010c0bcc2 |
header Parameters
| x-workspace-id | any Provide to identify the specific workspace from request |
| x-subaccount-id | any Provide to identify the specific subaccount from request |
| x-language | any Provide to identify the locale from the content |
Responses
Response samples
- 200
{- "attempt_id": "65dfa9f6feb036139eccce41",
- "title": "Backend Node.js",
- "testCode": "659cfcfe671ace001106dcaa",
- "description": "This is the result of your Backend Node.js assessment",
- "providerName": "Coodesh",
- "company_result_string": "User 1 scored 15% in the Backend Node.js assessment.\nTests:\n20% - BMI - Programming\n10% - Node.js - Quiz\nSent at: 11:07 AM, April 11, 2024 GMT-03:00\nCompleted at: 6:25 PM, March 26, 2024 GMT-03:00\nReport: https://beta.coodesh.com/pt/share/assessments/66033c206c4a8c08e941513c?accessToken={token}",
- "created": "2024-09-26T18:45:00.000Z",
- "status": "done",
- "result_page_url": "https://coodesh.com/share/assessments/65dfa9f6feb036139eccce41?accessToken={token}",
- "results": [
- {
- "score": 15,
- "score_type": "percentage",
- "result_string": "string",
- "type_result": "percentage",
- "tier": "major",
- "title": "Backend Node.js",
- "description": "string",
- "date": "2024-03-26",
- "other_informations": {
- "time": 0,
- "pause_count": 0,
- "test_type": "string",
- "factor": "string"
}
}
]
}Create attempt
This endpoint creates attempt for an given assessment to the current requester. If an user with given email does not exist, it will be created.
Authorizations:
header Parameters
| x-workspace-id | any Provide to identify the specific workspace from request |
| x-subaccount-id | any Provide to identify the specific subaccount from request |
| x-language | any Provide to identify the locale from the content |
Request Body schema: application/jsonrequired
| name required | string Name of the candidate |
| email required | string <email> Email of the candidate |
| document_id required | number ID of the candidate |
| birthdate required | string Birthdate of the candidate |
| gender required | string Enum: "male" "female" Gender of the candidate |
| test_id required | string Test ID for the candidate to take |
| company_id required | number Company ID |
| job_id required | number Job ID associated with the test |
| callback_url required | string <uri> URL for callback after test completion |
| candidate_type required | string Enum: "internal" "external" Type of the candidate |
| previous_result required | string or null Enum: "fail" null Previous result of the candidate |
| result_webhook_url required | string <uri> Webhook URL to send the test result to |
| disable_email required | boolean Default: true Disable invite email when creating the attempt |
Responses
Request samples
- Payload
{- "name": "Test User",
- "email": "test@example.com",
- "document_id": 10,
- "birthdate": "string",
- "gender": "male",
- "test_id": "659cfcfe671ace001106dcaa",
- "company_id": 0,
- "job_id": 2,
- "candidate_type": "internal",
- "previous_result": "fail",
- "disable_email": true
}Response samples
- 201
{- "test_result_id": "65dfa9f6feb036139eccce41",
}Create attempt
This endpoint creates attempt for an given assessment to the current requester. If an user with given email does not exist, it will be created.
Authorizations:
header Parameters
| x-workspace-id | any Provide to identify the specific workspace from request |
| x-subaccount-id | any Provide to identify the specific subaccount from request |
| x-language | any Provide to identify the locale from the content |
Request Body schema: application/jsonrequired
| account_id required | string Account Id |
| email required | string <email> Attempt Email to Invite |
| id required | string Attempt ID to Invite |
| job_code required | string Job Code from Invite |
| job_id required | string Job Id from Invite |
| name required | string Attempt Name to Invite |
| tags | Array of strings Attempt Invite tags |
| stage required | object Attempt Invite job Stage |
| disable_email required | boolean Default: false Disable invite email when creating the attempt |
Responses
Request samples
- Payload
{- "account_id": "d5cf6e60-f2f5-11e7-9747-838fbc80281c",
- "email": "user@example.com",
- "id": "b12002e0-afc4-11ee-ac51-1fb9ace11428",
- "job_code": "IVKM6M",
- "job_id": "54046020-aec4-11ee-a01d-174ac5115722",
- "name": "Glaydston Veloso",
- "tags": [
- "string"
], - "stage": { },
- "disable_email": false
}Get attempt by Id
This endpoint get attempt using the ID for an given assessment.
Authorizations:
path Parameters
| attemptId required | string Example: 61b8e9bb2300e80010c0bcc2 |
header Parameters
| x-workspace-id | any Provide to identify the specific workspace from request |
| x-subaccount-id | any Provide to identify the specific subaccount from request |
| x-language | any Provide to identify the locale from the content |
Responses
Response samples
- 200
{ }Get all assessments
This endpoint list all assessments from account
Authorizations:
query Parameters
| search | string |
| order | string Default: "desc" Enum: "asc" "desc" |
| orderBy | string Default: "_id" |
| offset | number >= 0 Default: 0 |
| page | number >= 1 Default: 1 |
| pageSize | number [ 1 .. 2000 ] Default: 20 |
| limit | number [ 0 .. 2000 ] Default: 20 |
header Parameters
| x-workspace-id | any Provide to identify the specific workspace from request |
| x-subaccount-id | any Provide to identify the specific subaccount from request |
| x-language | any Provide to identify the locale from the content |
Responses
Response samples
- 200
{ }RecalculateSoftSkillByIdController_handle
Authorizations:
path Parameters
| id required | string Example: 64dfa98a71a3460012d2d6b5 |
header Parameters
| x-workspace-id | any Provide to identify the specific workspace from request |
| x-subaccount-id | any Provide to identify the specific subaccount from request |
| x-language | any Provide to identify the locale from the content |
Responses
UnlockSoftSkillByIdController_handle
Authorizations:
path Parameters
| id required | string Example: 64dfa98a71a3460012d2d6b5 |
header Parameters
| x-workspace-id | any Provide to identify the specific workspace from request |
| x-subaccount-id | any Provide to identify the specific subaccount from request |
| x-language | any Provide to identify the locale from the content |
Responses
DownloadSoftSkillByIdController_handle
Authorizations:
path Parameters
| id required | string Example: 64dfa98a71a3460012d2d6b5 |
header Parameters
| x-workspace-id | any Provide to identify the specific workspace from request |
| x-subaccount-id | any Provide to identify the specific subaccount from request |
| x-language | any Provide to identify the locale from the content |
Responses
Handle
Handle GET root route.
header Parameters
| x-workspace-id | any |
| x-subaccount-id | any |
| x-language | any |
Responses
Response samples
- 200
- 500
{- "mongo": {
- "status": "OK",
- "read": "OK",
- "write": "OK"
}, - "redis": {
- "status": "OK",
- "read": "OK",
- "write": "OK"
}, - "server": {
- "uptime": 3600,
- "mem_total": 8192,
- "mem_free": 4096
}, - "api": {
- "version": "2026.2.0"
}
}Handle
Handle GET :zipCode.
path Parameters
| zipCode required | string Example: 01310100 Brazilian postal code (CEP) |
header Parameters
| x-workspace-id | any |
| x-subaccount-id | any |
| x-language | any |
Responses
Response samples
- 200
- 400
- 404
{- "cep": "01310100",
- "state": "SP",
- "city": "São Paulo",
- "street": "Avenida Paulista",
- "neighborhood": "Bela Vista",
- "service": "brasilapi"
}TimeController_handle
query Parameters
| tz required | string Example: tz=America/Sao_Paulo Time zone |
header Parameters
| x-workspace-id | any Provide to identify the specific workspace from request |
| x-subaccount-id | any Provide to identify the specific subaccount from request |
| x-language | any Provide to identify the locale from the content |
Responses
Response samples
- 200
{ }Handle
Handle GET posts.
query Parameters
| page | string Example: page=1 Page number for pagination |
| per_page | string Example: per_page=10 Number of items per page |
| search | string Example: search=nestjs Search term to filter results |
| categories | string Example: categories=3,5 Comma-separated list of category IDs to filter by |
| tags | string Example: tags=7,12 Comma-separated list of tag IDs to filter by |
| orderby | string Example: orderby=date Field to order results by |
| order | string Example: order=desc Sort direction (asc or desc) |
| slug | string Example: slug=my-blog-post Slug of the post or category to retrieve |
| _fields | string Example: _fields=id,title,link Comma-separated list of fields to include in the response |
| context | string Example: context=view Context for the request (view, embed, edit) |
header Parameters
| x-workspace-id | any |
| x-subaccount-id | any |
| x-language | any |
Responses
Response samples
- 200
[- {
- "id": 42,
- "date": "2024-06-15T10:30:00",
- "slug": "how-to-use-nestjs",
- "status": "publish",
- "type": "post",
- "title": {
- "rendered": "<p>Blog post content here...</p>",
- "protected": false
}, - "excerpt": {
- "rendered": "<p>Blog post content here...</p>",
- "protected": false
}, - "content": {
- "rendered": "<p>Blog post content here...</p>",
- "protected": false
}, - "author": 1,
- "featured_media": 128,
- "categories": [
- 3,
- 5
], - "tags": [
- 7,
- 12
]
}
]Handle
Handle GET categories.
query Parameters
| page | string Example: page=1 Page number for pagination |
| per_page | string Example: per_page=10 Number of items per page |
| search | string Example: search=nestjs Search term to filter results |
| categories | string Example: categories=3,5 Comma-separated list of category IDs to filter by |
| tags | string Example: tags=7,12 Comma-separated list of tag IDs to filter by |
| orderby | string Example: orderby=date Field to order results by |
| order | string Example: order=desc Sort direction (asc or desc) |
| slug | string Example: slug=my-blog-post Slug of the post or category to retrieve |
| _fields | string Example: _fields=id,title,link Comma-separated list of fields to include in the response |
| context | string Example: context=view Context for the request (view, embed, edit) |
header Parameters
| x-workspace-id | any |
| x-subaccount-id | any |
| x-language | any |
Responses
Response samples
- 200
[- {
- "id": 3,
- "count": 12,
- "description": "Articles about software engineering",
- "name": "Engineering",
- "slug": "engineering",
- "taxonomy": "category",
- "parent": 0
}
]