Coodesh API (2026.04.29)

Download OpenAPI specification:

Getting Started

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"

Authentication

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: []).

Common Headers

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.

Authentication

Validate API key

Validates the provided API key and returns its metadata.

header Parameters

X-Api-Key required	string API key to validate
x-workspace-id	any Workspace identifier to scope the request to a specific company workspace
x-subaccount-id	any Subaccount identifier for multi-tenant operations within a workspace
x-language	any Preferred language for response content (e.g. "pt", "en", "es")

Responses

Response samples

200

Content type

application/json

{"_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"
}

Validate Reset Token

Handle GET reset/:token.

path Parameters

token

required

string

header Parameters

x-workspace-id	any Workspace identifier to scope the request to a specific company workspace
x-subaccount-id	any Subaccount identifier for multi-tenant operations within a workspace
x-language	any Preferred language for response content (e.g. "pt", "en", "es")

Responses

Reset

Handle POST reset/:token.

path Parameters

token

required

string

header Parameters

x-workspace-id	any Workspace identifier to scope the request to a specific company workspace
x-subaccount-id	any Subaccount identifier for multi-tenant operations within a workspace
x-language	any Preferred language for response content (e.g. "pt", "en", "es")

Request Body schema: application/json
required

newPassword required	string New password for the account
confirmPassword required	string Confirm the new password (must match newPassword)

Responses

Request samples

Payload

Content type

application/json

{"newPassword": "N3wP@ssw0rd!",
"confirmPassword": "N3wP@ssw0rd!"
}

Response samples

200

Content type

application/json

{"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 Workspace identifier to scope the request to a specific company workspace
x-subaccount-id	any Subaccount identifier for multi-tenant operations within a workspace
x-language	any Preferred language for response content (e.g. "pt", "en", "es")

Request Body schema: application/json
required

email

required

string

User email address to check the authentication provider

Responses

Request samples

Payload

Content type

application/json

{"email": "john.doe@company.com"
}

Response samples

200

Content type

application/json

{"email": "john.doe@company.com",
"provider": "local",
"password": true
}

Sign In

Handle POST signin.

header Parameters

x-workspace-id	any Workspace identifier to scope the request to a specific company workspace
x-subaccount-id	any Subaccount identifier for multi-tenant operations within a workspace
x-language	any Preferred language for response content (e.g. "pt", "en", "es")

Request Body schema: application/json
required

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

Content type

application/json

{"email": "john.doe@company.com",
"password": "P@ssw0rd!",
"invite": "abc123def456"
}

Response samples

201

Content type

application/json

{"token": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiI1MDdmMWY3N2JjZjg2Y2Q3OTk0MzkwMTEiLCJpYXQiOjE3MDkwMDAwMDB9.abc123",
"user": {"_id": "507f1f77bcf86cd799439011",
"displayName": "John Doe",
"firstName": "John",
"lastName": "Doe",
"email": "john.doe@company.com",
"roles": "user",
"image": "https://assets.coodesh.com/avatars/507f1f77bcf86cd799439011.png",
"username": "john-doe"
},
"isNew": true,
"flow": "dashboard",
"provider": "local"
}

Sign Up

Handle POST signup.

header Parameters

x-workspace-id	any Workspace identifier to scope the request to a specific company workspace
x-subaccount-id	any Subaccount identifier for multi-tenant operations within a workspace
x-language	any Preferred language for response content (e.g. "pt", "en", "es")

Request Body schema: application/json
required

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" "business" "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

Content type

application/json

{"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

Content type

application/json

{"token": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiI1MDdmMWY3N2JjZjg2Y2Q3OTk0MzkwMTEiLCJpYXQiOjE3MDkwMDAwMDB9.abc123",
"user": {"_id": "507f1f77bcf86cd799439011",
"displayName": "John Doe",
"firstName": "John",
"lastName": "Doe",
"email": "john.doe@company.com",
"roles": "user",
"image": "https://assets.coodesh.com/avatars/507f1f77bcf86cd799439011.png",
"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 Workspace identifier to scope the request to a specific company workspace
x-subaccount-id	any Subaccount identifier for multi-tenant operations within a workspace
x-language	any Preferred language for response content (e.g. "pt", "en", "es")

Responses

Response samples

200

Content type

application/json

{"_id": "60d5ecb74e4d2a001f9a1234",
"whitelabel": {"name": "Acme Corp",
"image": "https://assets.coodesh.com/logos/acme.png",
"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 Workspace identifier to scope the request to a specific company workspace
x-subaccount-id	any Subaccount identifier for multi-tenant operations within a workspace
x-language	any Preferred language for response content (e.g. "pt", "en", "es")

Request Body schema: application/json
required

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" "business" "hunter" "manager" "admin" User role: user, admin, or manager
invite	string Workspace invite token
	object User address information (phone number)
	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

Content type

application/json

{"email": "john.doe@company.com",
"password": "P@ssw0rd!",
"displayName": "John Doe",
"firstName": "John",
"lastName": "Doe",
"roles": "user",
"invite": "abc123def456",
"address": {"phone": "+5531999999999"
},
"privacy": {"gdpr": true
},
"origin": "google",
"content": "banner-top",
"medium": "cpc",
"campaign": "spring-sale",
"term": "developer-hiring"
}

Response samples

201

Content type

application/json

{"token": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiI1MDdmMWY3N2JjZjg2Y2Q3OTk0MzkwMTEiLCJpYXQiOjE3MDkwMDAwMDB9.abc123",
"user": {"_id": "507f1f77bcf86cd799439011",
"displayName": "John Doe",
"firstName": "John",
"lastName": "Doe",
"email": "john.doe@company.com",
"roles": "user",
"image": "https://assets.coodesh.com/avatars/507f1f77bcf86cd799439011.png",
"username": "john-doe"
},
"isNew": true,
"flow": "dashboard",
"provider": "local"
}

Forgot

Handle POST forgot/password.

header Parameters

x-workspace-id	any Workspace identifier to scope the request to a specific company workspace
x-subaccount-id	any Subaccount identifier for multi-tenant operations within a workspace
x-language	any Preferred language for response content (e.g. "pt", "en", "es")

Request Body schema: application/json
required

email

required

string

Email address associated with the account to recover

Responses

Request samples

Payload

Content type

application/json

{"email": "john.doe@company.com"
}

Response samples

201

Content type

application/json

{"message": "Operation completed successfully"
}

Facebook

Handle POST facebook.

header Parameters

x-workspace-id	any Workspace identifier to scope the request to a specific company workspace
x-subaccount-id	any Subaccount identifier for multi-tenant operations within a workspace
x-language	any Preferred language for response content (e.g. "pt", "en", "es")

Request Body schema: application/json
required

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

Content type

application/json

{"code": "4/0AX4XfWh2...",
"access_token": "ya29.a0AfH6SM...",
"redirectUri": "https://app.coodesh.com/auth/callback",
"scope": "email profile"
}

Response samples

201

Content type

application/json

{"token": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiI1MDdmMWY3N2JjZjg2Y2Q3OTk0MzkwMTEiLCJpYXQiOjE3MDkwMDAwMDB9.abc123",
"user": {"_id": "507f1f77bcf86cd799439011",
"displayName": "John Doe",
"firstName": "John",
"lastName": "Doe",
"email": "john.doe@company.com",
"roles": "user",
"image": "https://assets.coodesh.com/avatars/507f1f77bcf86cd799439011.png",
"username": "john-doe"
},
"isNew": true,
"flow": "dashboard",
"provider": "local"
}

Google

Handle POST google.

header Parameters

x-workspace-id	any Workspace identifier to scope the request to a specific company workspace
x-subaccount-id	any Subaccount identifier for multi-tenant operations within a workspace
x-language	any Preferred language for response content (e.g. "pt", "en", "es")

Request Body schema: application/json
required

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

Content type

application/json

{"code": "4/0AX4XfWh2...",
"access_token": "ya29.a0AfH6SM...",
"redirectUri": "https://app.coodesh.com/auth/callback",
"scope": "email profile"
}

Response samples

201

Content type

application/json

{"token": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiI1MDdmMWY3N2JjZjg2Y2Q3OTk0MzkwMTEiLCJpYXQiOjE3MDkwMDAwMDB9.abc123",
"user": {"_id": "507f1f77bcf86cd799439011",
"displayName": "John Doe",
"firstName": "John",
"lastName": "Doe",
"email": "john.doe@company.com",
"roles": "user",
"image": "https://assets.coodesh.com/avatars/507f1f77bcf86cd799439011.png",
"username": "john-doe"
},
"isNew": true,
"flow": "dashboard",
"provider": "local"
}

Github

Handle POST github.

header Parameters

x-workspace-id	any Workspace identifier to scope the request to a specific company workspace
x-subaccount-id	any Subaccount identifier for multi-tenant operations within a workspace
x-language	any Preferred language for response content (e.g. "pt", "en", "es")

Request Body schema: application/json
required

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

Content type

application/json

{"code": "4/0AX4XfWh2...",
"access_token": "ya29.a0AfH6SM...",
"redirectUri": "https://app.coodesh.com/auth/callback",
"scope": "email profile"
}

Response samples

201

Content type

application/json

{"token": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiI1MDdmMWY3N2JjZjg2Y2Q3OTk0MzkwMTEiLCJpYXQiOjE3MDkwMDAwMDB9.abc123",
"user": {"_id": "507f1f77bcf86cd799439011",
"displayName": "John Doe",
"firstName": "John",
"lastName": "Doe",
"email": "john.doe@company.com",
"roles": "user",
"image": "https://assets.coodesh.com/avatars/507f1f77bcf86cd799439011.png",
"username": "john-doe"
},
"isNew": true,
"flow": "dashboard",
"provider": "local"
}

Linkedin

Handle POST linkedin.

header Parameters

x-workspace-id	any Workspace identifier to scope the request to a specific company workspace
x-subaccount-id	any Subaccount identifier for multi-tenant operations within a workspace
x-language	any Preferred language for response content (e.g. "pt", "en", "es")

Request Body schema: application/json
required

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

Content type

application/json

{"code": "4/0AX4XfWh2...",
"access_token": "ya29.a0AfH6SM...",
"redirectUri": "https://app.coodesh.com/auth/callback",
"scope": "email profile"
}

Response samples

201

Content type

application/json

{"token": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiI1MDdmMWY3N2JjZjg2Y2Q3OTk0MzkwMTEiLCJpYXQiOjE3MDkwMDAwMDB9.abc123",
"user": {"_id": "507f1f77bcf86cd799439011",
"displayName": "John Doe",
"firstName": "John",
"lastName": "Doe",
"email": "john.doe@company.com",
"roles": "user",
"image": "https://assets.coodesh.com/avatars/507f1f77bcf86cd799439011.png",
"username": "john-doe"
},
"isNew": true,
"flow": "dashboard",
"provider": "local"
}

Login Saml

Handle POST saml.

header Parameters

x-workspace-id	any Workspace identifier to scope the request to a specific company workspace
x-subaccount-id	any Subaccount identifier for multi-tenant operations within a workspace
x-language	any Preferred language for response content (e.g. "pt", "en", "es")

Request Body schema: application/json
required

email	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

Content type

application/json

{"email": "john.doe@company.com",
"id": "507f1f77bcf86cd799439011"
}

Saml

Handle POST saml/callback.

header Parameters

x-workspace-id	any Workspace identifier to scope the request to a specific company workspace
x-subaccount-id	any Subaccount identifier for multi-tenant operations within a workspace
x-language	any Preferred language for response content (e.g. "pt", "en", "es")

Request Body schema: application/json
required

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

Content type

application/json

{"SAMLResponse": "PHNhbWxwOlJlc3BvbnNl...",
"RelayState": "https://app.coodesh.com/dashboard"
}

Confirmation Account Resend

Handle POST confirmation.

header Parameters

x-workspace-id	any Workspace identifier to scope the request to a specific company workspace
x-subaccount-id	any Subaccount identifier for multi-tenant operations within a workspace
x-language	any Preferred language for response content (e.g. "pt", "en", "es")

Request Body schema: application/json
required

email

required

string

Email address of the account to resend the confirmation email to

Responses

Request samples

Payload

Content type

application/json

{"email": "john.doe@company.com"
}

Confirmation Account

Handle PUT confirmation/:token.

path Parameters

token

required

string

header Parameters

x-workspace-id	any Workspace identifier to scope the request to a specific company workspace
x-subaccount-id	any Subaccount identifier for multi-tenant operations within a workspace
x-language	any Preferred language for response content (e.g. "pt", "en", "es")

Responses

Response samples

200

Content type

application/json

{"message": "User account has been confirmed",
"user": {"_id": "507f1f77bcf86cd799439011",
"email": "john.doe@company.com",
"displayName": "John Doe",
"verified": true
}
}

Companies

Get company by slug

Returns company details using its public slug.

path Parameters

companySlug

required

string

header Parameters

x-workspace-id	any Workspace identifier to scope the request to a specific company workspace
x-subaccount-id	any Subaccount identifier for multi-tenant operations within a workspace
x-language	any Preferred language for response content (e.g. "pt", "en", "es")

Responses

Response samples

200

Content type

application/json

{"_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": {"url": "https://cdn.coodesh.com/companies/acme-logo.png",
"public_id": "companies/acme-logo"
},
"cover_image": {"url": "https://cdn.coodesh.com/companies/acme-logo.png",
"public_id": "companies/acme-logo"
},
"cover_video": {"id": "123456789",
"url": "https://vimeo.com/123456789",
"source": "vimeo"
},
"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,
"website": "https://acme.com",
"social": {"linkedin": "https://linkedin.com/company/acme",
"facebook": "https://facebook.com/acme",
"twitter": "https://twitter.com/acme",
"github": "https://github.com/acme",
"instagram": "https://instagram.com/acme",
"discord": "https://discord.gg/acme",
"glassdoor": "https://glassdoor.com/acme"
},
"address": {"city": "San Francisco",
"country": "US"
},
"related_companies": ["507f1f77bcf86cd799439012"
],
"reviews": [ ],
"offers": [ ],
"also_viewed": [ ]
}

Company Options

Returns companies in a compact label/value format for selectors.

header Parameters

x-workspace-id	any Workspace identifier to scope the request to a specific company workspace
x-subaccount-id	any Subaccount identifier for multi-tenant operations within a workspace
x-language	any Preferred language for response content (e.g. "pt", "en", "es")

Responses

Response samples

200

Content type

application/json

[{"value": "507f1f77bcf86cd799439011",
"label": "Acme Corp",
"meta": {"image": "https://cdn.coodesh.com/companies/acme-logo.png",
"slug": "acme-corp",
"website": "https://acme.com",
"demands_count": 3
}
}
]

List companies

Returns a paginated list of companies.

header Parameters

x-workspace-id	any Workspace identifier to scope the request to a specific company workspace
x-subaccount-id	any Subaccount identifier for multi-tenant operations within a workspace
x-language	any Preferred language for response content (e.g. "pt", "en", "es")

Responses

Response samples

200

Content type

application/json

{"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": {"image": "https://cdn.coodesh.com/companies/acme-logo.png",
"slug": "acme-corp",
"website": "https://acme.com",
"demands_count": 3
}
}
]
}

Find By Slug

Handle GET slug/:slug.

path Parameters

slug

required

string

header Parameters

x-workspace-id	any Workspace identifier to scope the request to a specific company workspace
x-subaccount-id	any Subaccount identifier for multi-tenant operations within a workspace
x-language	any Preferred language for response content (e.g. "pt", "en", "es")

Responses

Response samples

200

Content type

application/json

{"_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",
"website": "https://acme.com",
"active": true,
"deleted": false,
"founded_year": "2018",
"founded": "2018-01-15T00:00:00.000Z",
"views": 1234,
"warranty_days": 90,
"author": "507f1f77bcf86cd799439011",
"image": {"url": "https://cdn.coodesh.com/companies/acme-logo.png",
"public_id": "companies/acme-logo"
},
"cover_image": {"url": "https://cdn.coodesh.com/companies/acme-logo.png",
"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": {"linkedin": "https://linkedin.com/company/acme",
"facebook": "https://facebook.com/acme",
"twitter": "https://twitter.com/acme",
"github": "https://github.com/acme",
"instagram": "https://instagram.com/acme",
"discord": "https://discord.gg/acme",
"glassdoor": "https://glassdoor.com/acme"
},
"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
},
"report": {"enabled": true,
"url": "https://reports.coodesh.com/acme",
"hour": "08:00"
},
"suggestions_report": {"enabled": true,
"url": "https://reports.coodesh.com/acme",
"hour": "08:00"
},
"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,
"profile_skill_map": true,
"diversity": 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 Workspace identifier to scope the request to a specific company workspace
x-subaccount-id	any Subaccount identifier for multi-tenant operations within a workspace
x-language	any Preferred language for response content (e.g. "pt", "en", "es")

Responses

Response samples

200

Content type

application/json

{"created": "2024-01-15T10:30:00.000Z",
"jobs": {"created": 25,
"progress": 10,
"review": 3
},
"teams": {"created": 5,
"draft": 1,
"published": 4
}
}

Get all assessments

This endpoint list all assessments from account

Authorizations:

x-api-key

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

Content type

application/json

[{"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:

x-api-key

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

Content type

application/json

{"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",
"provider_link": "https://beta.coodesh.com",
"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",
"invite_link": "https://beta.coodesh.com/pt/assessments/invite/65dfa9f6feb036139eccce41",
"public_link": "https://beta.coodesh.com/pt/share/assessments/65dfa9f6feb036139eccce41?accessToken={token}",
"result_talent_link": "https://beta.coodesh.com/pt/assessments/results/65dfa9f6feb036139eccce41",
"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:

x-api-key

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/json
required

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: false Controls transactional emails sent to the candidate for this attempt. When `true`: (1) the invite email is NOT sent at attempt creation, and (2) the result email is NOT sent to the candidate when the attempt is finished. Recommended when the ATS already notifies the candidate on its own side. Does NOT affect: emails to the assessment author or custom recipients (controlled by the assessment setting `disable_email_notification`), reminder emails, or the certificate flow. Default: `false`.

Responses

Request samples

Payload

Content type

application/json

{"name": "Test User",
"email": "test@example.com",
"user_id": "6666c8a39641daa32b5f5443",
"assessment_id": "659cfcfe671ace001106dcaa",
"company_id": "6666c8c7e4421468fc1bcbb0",
"job_id": "6666c8c2d944f09a35be0043",
"callback_url": "https://coodesh.com/applicants/details/6666c8d5c209f8c757dcbf66",
"webhook_url": "http://example.com",
"disable_email": true
}

Response samples

201

Content type

application/json

{"attempt_id": "65dfa9f6feb036139eccce41",
"attempt_url": "https://beta.coodesh.com/pt/assessments/1704787198442?user_token={token}"
}

Sync attempt result

Recompute the score of an existing attempt, disable notifications by default

Authorizations:

x-api-key

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/json
required

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

Content type

application/json

{"disable_notification": true,
"disable_ats_sync": true,
"disable_process_snapshots": true,
"disable_calculate_traits": true
}

Response samples

201

Content type

application/json

{"message": "Attempt synced successfully"
}

Webhooks

Assessment Webhook

Processes incoming assessment webhook events.

header Parameters

x-workspace-id	any Workspace identifier to scope the request to a specific company workspace
x-subaccount-id	any Subaccount identifier for multi-tenant operations within a workspace
x-language	any Preferred language for response content (e.g. "pt", "en", "es")

Request Body schema: application/json
required

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

Content type

application/json

{"attempt_id": "507f1f77bcf86cd799439011",
"application_id": "507f1f77bcf86cd799439011",
"assessment_id": "507f1f77bcf86cd799439011",
"status": "finished",
"score": 85,
"title": "JavaScript Assessment"
}

Stripe Hooks

Handle POST stripe.

header Parameters

x-workspace-id	any Workspace identifier to scope the request to a specific company workspace
x-subaccount-id	any Subaccount identifier for multi-tenant operations within a workspace
x-language	any Preferred language for response content (e.g. "pt", "en", "es")

Responses

Jobs

Job Definitions

Returns job field definitions and enums.

header Parameters

x-workspace-id	any Workspace identifier to scope the request to a specific company workspace
x-subaccount-id	any Subaccount identifier for multi-tenant operations within a workspace
x-language	any Preferred language for response content (e.g. "pt", "en", "es")

Responses

Response samples

200

Content type

application/json

{"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 Workspace identifier to scope the request to a specific company workspace
x-subaccount-id	any Subaccount identifier for multi-tenant operations within a workspace
x-language	any Preferred language for response content (e.g. "pt", "en", "es")

Responses

Response samples

200

Content type

application/json

{"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",
"image": {"url": "https://cdn.coodesh.com/company-logo.png"
},
"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 Workspace identifier to scope the request to a specific company workspace
x-subaccount-id	any Subaccount identifier for multi-tenant operations within a workspace
x-language	any Preferred language for response content (e.g. "pt", "en", "es")

Responses

Response samples

200

Content type

application/json

{"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",
"image": {"url": "https://cdn.coodesh.com/company-logo.png"
},
"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 Workspace identifier to scope the request to a specific company workspace
x-subaccount-id	any Subaccount identifier for multi-tenant operations within a workspace
x-language	any Preferred language for response content (e.g. "pt", "en", "es")

Responses

Response samples

200

Content type

application/json

{"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 Workspace identifier to scope the request to a specific company workspace
x-subaccount-id	any Subaccount identifier for multi-tenant operations within a workspace
x-language	any Preferred language for response content (e.g. "pt", "en", "es")

Responses

Response samples

200

Content type

application/json

{"_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",
"image": {"url": "https://cdn.coodesh.com/company-logo.png"
},
"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"
],
"gallery": ["https://cdn.coodesh.com/gallery1.jpg"
],
"external_url": "https://company.com/careers/apply",
"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 Workspace identifier to scope the request to a specific company workspace
x-subaccount-id	any Subaccount identifier for multi-tenant operations within a workspace
x-language	any Preferred language for response content (e.g. "pt", "en", "es")

Responses

Response samples

200

Content type

application/json

{"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",
"image": {"url": "https://cdn.coodesh.com/company-logo.png"
},
"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
}

Match

Handle GET jobs/single/:slug/match.

path Parameters

slug

required

string

header Parameters

x-workspace-id	any Workspace identifier to scope the request to a specific company workspace
x-subaccount-id	any Subaccount identifier for multi-tenant operations within a workspace
x-language	any Preferred language for response content (e.g. "pt", "en", "es")

Responses

Response samples

200

Content type

application/json

{"level": "high",
"level_formatted": "High"
}

Apply

Handle POST jobs/apply/:jobId.

path Parameters

jobId

required

string

header Parameters

x-workspace-id	any Workspace identifier to scope the request to a specific company workspace
x-subaccount-id	any Subaccount identifier for multi-tenant operations within a workspace
x-language	any Preferred language for response content (e.g. "pt", "en", "es")

Request Body schema: application/json
required

email required	string Candidate email address
fullname required	string Candidate full name
linkedin	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

Content type

application/json

{"email": "candidate@example.com",
"fullname": "John Doe",
"linkedin": "https://linkedin.com/in/johndoe",
"github": "https://github.com/johndoe",
"cv": "https://cdn.example.com/cv.pdf",
"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

Content type

application/json

{"_id": "507f1f77bcf86cd799439011",
"fullname": "Jane Doe",
"linkedin": "https://linkedin.com/in/janedoe",
"github": "https://github.com/janedoe",
"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 Workspace identifier to scope the request to a specific company workspace
x-subaccount-id	any Subaccount identifier for multi-tenant operations within a workspace
x-language	any Preferred language for response content (e.g. "pt", "en", "es")

Responses

Response samples

200

Content type

application/json

{"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",
"image": {"url": "https://cdn.coodesh.com/company-logo.png"
},
"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
}

Applications

Talents Fields

Handle GET search_fields.

header Parameters

x-workspace-id	any Workspace identifier to scope the request to a specific company workspace
x-subaccount-id	any Subaccount identifier for multi-tenant operations within a workspace
x-language	any Preferred language for response content (e.g. "pt", "en", "es")

Responses

Response samples

200

Content type

application/json

{"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 Workspace identifier to scope the request to a specific company workspace
x-subaccount-id	any Subaccount identifier for multi-tenant operations within a workspace
x-language	any Preferred language for response content (e.g. "pt", "en", "es")

Responses

Response samples

200

Content type

application/json

{"jobName": "Job title",
"username": "Candidate's name",
"companyName": "Company name",
"inviteLink": "Vacancy URL on the Coodesh platform"
}

Application Definitions

Returns field definitions and enums used by application workflows.

header Parameters

x-workspace-id	any Workspace identifier to scope the request to a specific company workspace
x-subaccount-id	any Subaccount identifier for multi-tenant operations within a workspace
x-language	any Preferred language for response content (e.g. "pt", "en", "es")

Responses

Response samples

200

Content type

application/json

{"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"
}
}

Application Locations

Returns application locations grouped for list and filter usage.

header Parameters

x-workspace-id	any Workspace identifier to scope the request to a specific company workspace
x-subaccount-id	any Subaccount identifier for multi-tenant operations within a workspace
x-language	any Preferred language for response content (e.g. "pt", "en", "es")

Responses

Response samples

200

Content type

application/json

{"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"
}
]
}

Campaign Apply

Creates a campaign application for the authenticated candidate using a campaign code.

path Parameters

code

required

string

header Parameters

x-workspace-id	any Workspace identifier to scope the request to a specific company workspace
x-subaccount-id	any Subaccount identifier for multi-tenant operations within a workspace
x-language	any Preferred language for response content (e.g. "pt", "en", "es")

Request Body schema: application/json
required

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
linkedin	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

Content type

application/json

{"email": "candidate@example.com",
"displayName": "Maria Silva",
"focus": "backend",
"looking_for": "fulltime",
"skills": ["64a1b2c3d4e5f60012345678"
],
"level": "senior",
"city": "Belo Horizonte",
"phone": "+5531999999999",
"linkedin": "https://linkedin.com/in/mariasilva",
"github": "https://github.com/mariasilva",
"other_cities": true,
"salary_range": {"currency": "BRL",
"min": 5000,
"max": 12000
}
}

Response samples

409

Content type

application/json

{"message": "You already have a registration. Please contact us to update your preferences.",
"url": "https://coodesh.com",
"email": "contact@coodesh.com"
}

Find Apply By Share

Handle POST :applicationId/share.

path Parameters

applicationId

required

string

header Parameters

x-workspace-id	any Workspace identifier to scope the request to a specific company workspace
x-subaccount-id	any Subaccount identifier for multi-tenant operations within a workspace
x-language	any Preferred language for response content (e.g. "pt", "en", "es")

Request Body schema: application/json
required

password required	string Password to access the shared application
email	string Email of the person accessing the shared application (for tracking)

Responses

Request samples

Payload

Content type

application/json

{"password": "abc12345",
"email": "reviewer@company.com"
}

History

Handle GET :applicationId/history.

path Parameters

applicationId

required

string

header Parameters

x-workspace-id	any Workspace identifier to scope the request to a specific company workspace
x-subaccount-id	any Subaccount identifier for multi-tenant operations within a workspace
x-language	any Preferred language for response content (e.g. "pt", "en", "es")

Responses

Assessments

Get Profiler By Code

Handle GET profilers/code/:code.

path Parameters

code

required

string

header Parameters

x-workspace-id	any Workspace identifier to scope the request to a specific company workspace
x-subaccount-id	any Subaccount identifier for multi-tenant operations within a workspace
x-language	any Preferred language for response content (e.g. "pt", "en", "es")

Responses

Response samples

200

Content type

application/json

{"_id": "507f1f77bcf86cd799439011",
"status": "invited",
"user": "507f1f77bcf86cd799439011"
}

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

Content type

application/json

[{"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

Content type

application/json

[{"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."
}
]

Find assessments

Retrieves a paginated list of assessments with filtering by status, skills, author, language, and career.

Authorizations:

x-api-key

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

Content type

application/json

{"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

Authorizations:

x-api-key

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/json
required

ids

required

Array of objects (ObjectId)

Array of ids

Responses

Request samples

Payload

Content type

application/json

{"ids": [{ }
]
}

Upload media attachments

Uploads one or more media files as attachments to an assessment, with size limits based on file type.

Authorizations:

x-api-key

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

Delete media attachment

Deletes a specific media attachment from an assessment by its storage path.

Authorizations:

x-api-key

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

Update an assessment

Updates an existing assessment with the provided data, including name, settings, questions, and tags.

Authorizations:

x-api-key

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/json
required

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

Content type

application/json

{"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,
"cat_initial_bucket_index": 0,
"accepted_languages": ["string"
],
"conversational": { }
}
],
"settings": {"invites_expiration": 120,
"invites_expiration_type": "relative",
"invites_expiration_fixed_date": "2019-08-24T14:15:22Z",
"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_id": { },
"color": "green"
}
],
"grade_tags_enabled": false,
"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"
]
}

Get assessment field definitions

Retrieves available field definitions, enums, and default values used for assessment configuration.

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 assessment invitation links

Retrieves all participant invitation links for a given assessment, including participant name, email, status, and invite URL.

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

Content type

application/json

[{"name": "John Doe",
"email": "john.doe@example.com",
"status": "invited",
"invite_date": "2019-08-24T14:15:22Z",
"link": "https://assessments.coodesh.com/invite/abc123"
}
]

Duplicate an assessment

Creates a copy of an existing assessment with a new draft status and optional field overrides.

Authorizations:

x-api-key

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/json
required

name required	string
career required	object (ObjectId)
required	object (SettingsDto)

Responses

Request samples

Payload

Content type

application/json

{"name": "string",
"career": { },
"settings": {"invites_expiration": 120,
"invites_expiration_type": "relative",
"invites_expiration_fixed_date": "2019-08-24T14:15:22Z",
"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_id": { },
"color": "green"
}
],
"grade_tags_enabled": false,
"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": { }
}
}

Find assessment share links

Retrieves all share links for a given assessment, including token, active status, tags, and time window.

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

Content type

application/json

[{"token": "abc123xyz",
"active": true,
"tags": ["string"
],
"tags_list": [{"_id": "6501d432afe2730012f74d68",
"name": "Frontend"
}
],
"time_open": "2019-08-24T14:15:22Z",
"time_close": "2019-08-24T14:15:22Z"
}
]

Update assessment share links

Updates the share links for a given assessment, including active status, tags, and time window for each link.

Authorizations:

x-api-key

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/json
required

required

Array of objects (AssessmentLinkDto)

Responses

Request samples

Payload

Content type

application/json

{"links": [{"tags": ["Linkedin",
"Coodesh"
],
"active": true,
"watcher": true,
"token": "1663018172366",
"time_open": "2019-08-24T14:15:22Z",
"time_close": "2019-08-24T14:15:22Z"
}
]
}

Get assessments statistics

Retrieves aggregated statistics for all assessments within the current workspace.

Authorizations:

x-api-key

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

Content type

application/json

{"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"
}
]
}

Get statistics for a specific assessment

Retrieves aggregated statistics for a single assessment identified by its ID.

Authorizations:

x-api-key

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

Content type

application/json

{"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:

x-api-key

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

Content type

application/json

{"_id": "6501d432afe2730012f74d68",
"score": 85.5,
"grade_tag": {"tag_id": "62b5faff5a80481c2cba4669",
"name": "Adequado"
},
"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,
"min_score": 0,
"max_score": 10
}
}
],
"user": {"_id": "6501d432afe2730012f74d68",
"displayName": "John Doe",
"email": "john.doe@example.com",
"image": "https://example.com/image.png"
},
"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",
"certificate_url": "https://example.com/certificate/123",
"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,
"maxScore": 1,
"reopen_date": "2019-08-24T14:15:22Z",
"finishedIn": 45,
"proctoring": {"type": "snapshots",
"content_removed_at": "2019-08-24T14:15:22Z",
"photo_id": "https://example.com/photo_id.png",
"snapshots": [{"image": "https://example.com/snapshot.png",
"created": "2019-08-24T14:15:22Z",
"question": { }
}
]
},
"whitelabel": {"_id": "6501d432afe2730012f74d68",
"name": "Company Name",
"image": "https://example.com/logo.png",
"primaryColor": "#3B82F6"
},
"can_export": true
}

Find assessment attempt result

Display assessment attempt result for assessment managers

Authorizations:

x-api-key

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

Content type

application/json

{"_id": "6501d432afe2730012f74d68",
"score": 85.5,
"grade_tag": {"tag_id": "62b5faff5a80481c2cba4669",
"name": "Adequado"
},
"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,
"min_score": 0,
"max_score": 10
}
}
],
"user": {"_id": "6501d432afe2730012f74d68",
"displayName": "John Doe",
"email": "john.doe@example.com",
"image": "https://example.com/image.png"
},
"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",
"certificate_url": "https://example.com/certificate/123",
"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,
"maxScore": 1,
"reopen_date": "2019-08-24T14:15:22Z",
"finishedIn": 45,
"proctoring": {"type": "snapshots",
"content_removed_at": "2019-08-24T14:15:22Z",
"photo_id": "https://example.com/photo_id.png",
"snapshots": [{"image": "https://example.com/snapshot.png",
"created": "2019-08-24T14:15:22Z",
"question": { }
}
]
},
"whitelabel": {"_id": "6501d432afe2730012f74d68",
"name": "Company Name",
"image": "https://example.com/logo.png",
"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:

x-api-key

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/json
required

participants

required

Array of strings

Indicates the users that will receveid invite email

Responses

Request samples

Payload

Content type

application/json

{"participants": ["62b384d70309831f9c13c87d",
"62b5faff5a80481c2cba4669"
]
}

Response samples

201

Content type

application/json

{ }

Export assessments CSV

Exports assessment results as CSV and can optionally include action plans and integrity files. Supports filtering by assessment ids, company ids, and date range.

Authorizations:

x-api-key

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/json
required

include_expired_participations	boolean
include_pending_participations	boolean
include_actions_plans	boolean
include_integrity	boolean
startDate	string
endDate	string
ids	Array of strings Filter by assessment ids
companies	Array of strings Filter by company ids (used outside workspace scope)

Responses

Request samples

Payload

Content type

application/json

{"include_expired_participations": false,
"include_pending_participations": true,
"include_actions_plans": true,
"include_integrity": true,
"startDate": "2026-01-01",
"endDate": "2026-01-31",
"ids": ["65f8c2f739ee2f2c21ff9c10",
"65f8c2f739ee2f2c21ff9c11"
],
"companies": ["65f8c2f739ee2f2c21ff9d20"
]
}

Response samples

200

Content type

application/json

[{"filename": "export.csv",
"data": "id;name;status"
}
]

List assessment authors

Retrieves the list of authors who have created assessments within the current workspace.

Authorizations:

x-api-key

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

Content type

application/json

[{"_id": "6501d432afe2730012f74d68",
"label": "Jane Smith",
"value": "6501d432afe2730012f74d68"
}
]

List assessment skills

Retrieves the distinct skills used across assessments in the current workspace.

Authorizations:

x-api-key

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

Content type

application/json

{"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
}

List assessments with minimal fields

Retrieves a paginated list of assessments returning only ID and name, suitable for dropdown selectors.

Authorizations:

x-api-key

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

Content type

application/json

{"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
}

Generate auto login link

This endpoint creates invite links with user token to reduce the number of clicks to access the assessment.

Authorizations:

x-api-key

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/json
required

participations required	Array of objects (ObjectId) Participation ids to generate autologin links
assessment required	object Assessment

Responses

Request samples

Payload

Content type

application/json

{"participations": ["62b384d70309831f9c13c87d",
"62b5faff5a80481c2cba4669"
],
"assessment": "62b384d70309831f9c13c87d"
}

Recalculate assessment attempt

Triggers a recalculation of scores and results for a specific assessment attempt.

Authorizations:

x-api-key

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

List assessment participants

Returns a paginated list of people who participated in assessments within the workspace.

Authorizations:

x-api-key

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

Content type

application/json

{"docs": [{"_id": "6501d432afe2730012f74d68",
"user": {"_id": "6501d432afe2730012f74d68",
"displayName": "John Doe",
"email": "john.doe@example.com",
"image": "https://example.com/image.png"
},
"link": "https://assessments.coodesh.com/invite/abc123",
"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,
"score_type": "percentage",
"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
}

List participant field definitions

Returns available statuses, stages, and severity categories for assessment participants.

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

List assessment attempt tags

Returns paginated tags associated with assessment attempts, filtered by workspace and status.

Authorizations:

x-api-key

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

Content type

application/json

{"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:

x-api-key

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/json
required

ids

required

Array of strings

Array of assessment attempt IDs to delete

Responses

Request samples

Payload

Content type

application/json

{"ids": ["507f1f77bcf86cd799439011",
"507f191e810c19729de860ea"
]
}

Send invite to participants

Send invite to participants by assessment id. The attempts had been created before, using CreateAssessmentAttempts endpoint.

Authorizations:

x-api-key

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/json
required

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

Content type

application/json

{"ids": ["62b384d70309831f9c13c87d",
"62b5faff5a80481c2cba4669"
],
"send_at": "2019-08-24T14:15:22Z"
}

Bulk unlock assessment attempts

Unlocks multiple assessment attempts at once, verifying credit balances and permissions for each attempt.

Authorizations:

x-api-key

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/json
required

ids

required

Array of strings (Assessment attempt ids)

Responses

Request samples

Payload

Content type

application/json

{"ids": ["string"
]
}

Response samples

201

Content type

application/json

{ }

Sync assessment attempt

Triggers a re-sync of the assessment attempt results and scoring.

Authorizations:

x-api-key

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

Bulk recalculate assessment attempt scores

Recalculates scores for finished or blocked assessment attempts by their IDs or assessment IDs.

Authorizations:

x-api-key

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/json
required

ids

required

Array of strings (Assessment attempt ids)

Responses

Request samples

Payload

Content type

application/json

{"ids": ["string"
]
}

Reopen attempts

Reopens closed assessment attempts in bulk so participants can continue.

Authorizations:

x-api-key

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/json
required

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

Content type

application/json

{"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

Sends hidden assessment results to participants for multiple attempts.

Authorizations:

x-api-key

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/json
required

ids

required

Array of strings (Assessment attempt ids) non-empty

List of assessment attempt ids to send results

Responses

Request samples

Payload

Content type

application/json

{"ids": ["507f1f77bcf86cd799439011",
"507f191e810c19729de860ea"
]
}

Bulk update assessment attempts

Company admins can update only owned attempts.

Authorizations:

x-api-key

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/json
required

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

Content type

application/json

{"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
}

List attempt IDs for navigation

Returns a list of finished attempt IDs for a given assessment, used for cursor-based navigation.

Authorizations:

x-api-key

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

Content type

application/json

{"docs": [{"_id": "6501d432afe2730012f74d68"
}
]
}

List attempt inviters

Returns the list of users who invited participants to the specified assessments.

Authorizations:

x-api-key

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

Content type

application/json

[{ }
]

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:

x-api-key

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/json
required

ids

required

Array of strings (User ids)

Responses

Request samples

Payload

Content type

application/json

{"ids": ["string"
]
}

Close expired assessment attempts

Finds and closes all expired assessment attempts and answers. Super admin only.

Authorizations:

x-api-key

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

List attempts by assessment

Returns a paginated list of assessment attempts (responses) for a specific assessment.

Authorizations:

x-api-key

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

Content type

application/json

{"docs": [{"_id": "6501d432afe2730012f74d68",
"user": {"_id": "6501d432afe2730012f74d68",
"displayName": "John Doe",
"email": "john.doe@example.com",
"image": "https://example.com/image.png"
},
"link": "https://assessments.coodesh.com/invite/abc123",
"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,
"grade_tag": {"tag_id": "62b5faff5a80481c2cba4669",
"name": "Adequado"
},
"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
}

List attempts for a user by id in workspace

Returns paginated assessment attempts for a specific workspace user.

Authorizations:

x-api-key

path Parameters

id

required

string

Example: 66f1f3e42c10b77c8f36ab4e

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=invited Filter by status. Cannot be used with grouping query
grouping	string Enum: "results" "invited" Grouping by status. Cannot be used with status query
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

Content type

application/json

{"docs": [{"_id": "6501d432afe2730012f74d68",
"assessment": {"_id": "6501d432afe2730012f74d68",
"name": "Frontend Developer Assessment",
"duration": 60,
"duration_unit": "minutes",
"company": {"_id": "6501d432afe2730012f74d68",
"company_name": "Company Name"
},
"language": "English",
"questions_count": 10
},
"hidden_results": true,
"certificate_status": "issued",
"certificate_url": "https://example.com/certificate/123",
"company": {"_id": "6501d432afe2730012f74d68",
"company_name": "Company Name"
},
"score": 85.5,
"score_type": "percentage",
"status": "finished",
"status_formatted": "Finished",
"finished": "2019-08-24T14:15:22Z",
"invitation_date_expire": "2019-08-24T14:15:22Z",
"invitation_link": "https://assessments.coodesh.com/invite/abc123",
"has_pending_answers": true
}
],
"totalDocs": 50,
"limit": 10,
"totalPages": 5,
"page": 1,
"pagingCounter": 1,
"hasPrevPage": false,
"hasNextPage": true,
"prevPage": null,
"nextPage": 2
}

Cancel scheduled attempts

Cancels scheduled assessment attempts in bulk and reverts them to draft status.

Authorizations:

x-api-key

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/json
required

ids

required

Array of strings (Assessment attempt ids)

Responses

Request samples

Payload

Content type

application/json

{"ids": ["string"
]
}

Schedule open dates for attempts in bulk

Distributes custom_time_open dates across 30-minute slots for attempts of given assessments, limiting to a configurable batch size per slot (default 30, resulting in 60 results per hour). Only schedules attempts that do not already have a custom_time_open set.

Authorizations:

x-api-key

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/json
required

assessment_ids required	Array of strings <= 50 items Assessment IDs to schedule open dates for their attempts
start_at	string <date-time> (Start date) Date/time to start scheduling from. Defaults to now if not provided.
batch_size	number (Batch size) [ 1 .. 100 ] Default: 30 Number of attempts per 30-minute slot (default: 30, resulting in 60/hour)

Responses

Request samples

Payload

Content type

application/json

{"assessment_ids": ["62b384d70309831f9c13c87d",
"62b5faff5a80481c2cba4669"
],
"start_at": "2019-08-24T14:15:22Z",
"batch_size": 30
}

Bulk mark assessment attempts as finished

Marks multiple assessment attempts as finished.

Authorizations:

x-api-key

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/json
required

ids

required

Array of strings (Assessment attempt ids)

Responses

Request samples

Payload

Content type

application/json

{"ids": ["string"
]
}

Get attempt notes

Retrieves the assessment notes for a specific in-progress attempt.

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

Save attempt notes

Updates the assessment notes for a specific in-progress attempt.

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

Upload proctoring snapshot

Uploads a webcam snapshot image for proctoring during an active assessment attempt.

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

Upload proctoring audio recording

Uploads an audio recording file for proctoring during an active assessment attempt.

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

Upload proctoring session recording

Uploads session replay events as a JSON file for proctoring during an assessment attempt.

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

Get attempt recommendations

Retrieves learning recommendations for a specific assessment attempt, optionally filtered by answer.

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

Content type

application/json

{"recommendations": [{"_id": "6501d432afe2730012f74d68",
"title": "Advanced JavaScript Course",
"description": "Learn advanced JS concepts",
"type": "course",
"url": "https://example.com/course",
"skills": [{"_id": "6501d432afe2730012f74d68",
"name": "JavaScript"
}
]
}
],
"total": 5
}

Get certificate by token

Retrieves assessment certificate details by answer token or attempt ID.

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

Content type

application/json

{"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",
"url": "https://assessments.coodesh.com/pt/assessments/fast/javascript"
},
"whitelabel": {"_id": "6501d432afe2730012f74d68",
"name": "Company Name",
"image": "https://example.com/logo.png",
"primaryColor": "#3B82F6"
}
}

Retrieve assessment answer fields

Returns the available feedback reason fields for assessment answers, formatted from the feedback enum values.

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 assessment answer by ID

Retrieves a specific assessment answer by its unique identifier.

Authorizations:

x-api-key

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

Find certificate by token

Retrieves the certificate details for a finished fast-type assessment answer using its token.

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

Content type

application/json

{"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"
}
}

Save review for assessment answer

Used on dashboard to save the manual score on the assessment answer

Authorizations:

x-api-key

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/json
required

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

Content type

application/json

{"review_notes": "",
"comment": "string",
"score": 0,
"repository_url": "https://github.com/user/repository"
}

Response samples

200

Content type

application/json

{ }

Upload proctoring media

Uploads a proctoring snapshot photo for a given assessment answer and records a tracking event.

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

Upload video presentation

Uploads a video or audio presentation file for an assessment answer, supporting both single and multipart uploads.

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/json
required

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

Content type

application/json

{"isLast": false,
"recordId": "string",
"partNumber": 0,
"totalChunks": 0
}

Response samples

201

Content type

application/json

{ }

Delete video presentation

Deletes the uploaded video or audio presentation recording from an assessment answer.

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

Find answers by attempt

Retrieves all assessment answers associated with a given attempt ID.

Authorizations:

x-api-key

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

Bulk move answers to pending review

Used on dashboard to move finished answers back to pending review status

Authorizations:

x-api-key

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/json
required

ids

required

Array of strings non-empty

Array of assessment answer IDs to move to pending review

Responses

Request samples

Payload

Content type

application/json

{"ids": ["19dbdf0e56e00123456789ab"
]
}

Upload a media attachment

Uploads a media file (audio, video, document, or whiteboard) for a question-type assessment answer. Supports both single and multipart uploads for large files. Only the answer owner can upload.

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/json
required

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

Content type

application/json

{"isLast": false,
"recordId": "string",
"partNumber": 0,
"totalChunks": 0
}

Response samples

201

Content type

application/json

{ }

Delete a media attachment

Deletes a previously uploaded audio or video recording for a question-type assessment answer. Only the answer owner can delete. Clears the stored answer URL.

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

Find assessment questions catalog

Find public assessment questions catalog and company questions

Authorizations:

x-api-key

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 `question_domains`
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

Content type

application/json

{"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
}

Create an assessment question

Creates a new assessment question with the provided details. The question scope is set to public for super admins and private for other roles. Returns the created question.

Authorizations:

x-api-key

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`

Deletes multiple created assessment questions using their identifiers.

Authorizations:

x-api-key

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/json
required

Array of question IDs to delete

Array

string

Responses

Request samples

Payload

Content type

application/json

["string"
]

Find an assessment question by ID

Retrieves a single assessment question by its ID. Supports optional population of related fields (author, skills, company) via the include query parameter. Falls back to public questions if not found in workspace.

Authorizations:

x-api-key

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

Content type

application/json

{"_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": [{ }
],
"cat": { },
"level_scale_id": "string"
},
"project": { },
"settings": { },
"recommendations": ["string"
],
"topics": ["string"
],
"categories": ["string"
],
"deleted": true
}

Update an assessment question

Updates an existing assessment question by its ID. If the question is public and belongs to a different workspace, it creates a private duplicate instead. Archived questions cannot be updated.

Authorizations:

x-api-key

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/json
required

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" "conversational" Indicates the type of assessmentQuestion the must be: fast,coding,sql,project,question,softskill,video,essay,audio,file,whiteboard,freecoding,conversational
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

Content type

application/json

{"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": [{ }
],
"cat": { },
"level_scale_id": "string"
},
"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",
"presentation_instructions": "string",
"repository_url": "http://example.com"
},
"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": [{ }
]
}

Find an assessment question by slug

Retrieves a single assessment question by its unique slug. Returns the question with localized content, level, duration, and associated topics.

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

Content type

application/json

{"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"
}
]
}

Get assessment question field definitions

Returns field metadata used to build assessment question forms.

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

List skills used across questions

Returns a paginated list of skills that are used across all assessment questions (excluding simple question types). Supports search filtering and pagination.

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

Content type

application/json

{"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
}

Questions library

Manage assessment questions catalog, filtering by type, level, search and pagination

Authorizations:

x-api-key

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" "conversational"
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

Content type

application/json

{"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,
"cat": {"enabled": true,
"batch_size": 5,
"max_questions": 30,
"initial_bucket_index": 0
},
"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,
"partial_score": 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:

x-api-key

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

Content type

application/json

{"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

Moves multiple challenges and questions to archived status.

Authorizations:

x-api-key

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/json
required

Array

string

Responses

Request samples

Payload

Content type

application/json

["string"
]

Bulk change status for challenges/questions

Moves multiple archived challenges and questions back to published status.

Authorizations:

x-api-key

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/json
required

Array of challenge/question IDs to unarchive

Array

string

Responses

Request samples

Payload

Content type

application/json

["61b8e9bb2300e80010c0bcc2"
]

Duplicate an assessment question

Creates a copy of an existing assessment question, including its settings and bootstrap files. The duplicated question is assigned to the current user and workspace with a created status.

Authorizations:

x-api-key

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:

x-api-key

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

Content type

application/json

{ }

Run coding question tests

Executes the code for a coding or freecoding question against its test cases using the judge service. Returns the test execution results including pass/fail status for each test case.

Authorizations:

x-api-key

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/json
required

Payload for running coding question

code	string
language	string
solution	string
stub	string
	Array of objects
max_execution_time	number

Responses

Request samples

Payload

Content type

application/json

{"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
}

List question authors

Returns the list of authors who have created assessment questions in the current workspace. Supports filtering by author IDs and text search.

Authorizations:

x-api-key

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

Content type

application/json

{"docs": [{"value": "6501d432afe2730012f74d68",
"label": "John Doe"
}
],
"totalDocs": 50,
"limit": 10,
"totalPages": 5,
"page": 1,
"pagingCounter": 1,
"hasPrevPage": false,
"hasNextPage": true,
"prevPage": null,
"nextPage": 2
}

List skills from the challenges library

Returns a paginated list of skills available in the challenges library. Supports filtering by question type, status, grouping, skills, and text search.

Authorizations:

x-api-key

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

Content type

application/json

{"docs": [{"_id": "6501d432afe2730012f74d68",
"name": "JavaScript"
}
],
"totalDocs": 50,
"limit": 10,
"totalPages": 5,
"page": 1,
"pagingCounter": 1,
"hasPrevPage": false,
"hasNextPage": true,
"prevPage": null,
"nextPage": 2
}

Upload media attachments for a question

Uploads one or more media files (images, audio, video, documents) as attachments to the specified assessment question. Enforces per-type file size limits and a maximum of 15 attachments per question.

Authorizations:

x-api-key

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

Delete a media attachment from a question

Removes a specific media attachment from storage and from the assessment question attachments list, identified by the file path in the request body.

Authorizations:

x-api-key

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 question recommendations

Returns a list of recommended questions related to the specified assessment question. Recommendations are scoped to the current workspace or public questions.

Authorizations:

x-api-key

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

Content type

application/json

[{"_id": "6501d432afe2730012f74d68",
"title": "JavaScript Course",
"description": "Learn JavaScript from scratch",
"provider": "Udemy",
"type": "course",
"usage": "paid",
"url": "https://example.com/course",
"company": {"_id": "6501d432afe2730012f74d68",
"company_name": "Acme Corp"
},
"main_language": "en",
"locales": ["string"
],
"type_formatted": "Course",
"status_formatted": "Published"
}
]

Get skills for a question

Returns the list of skills associated with a specific assessment question identified by its ID.

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

Content type

application/json

{"docs": [{"_id": "6501d432afe2730012f74d68",
"name": "JavaScript"
}
]
}

Upload a bootstrap file for a question

Uploads a bootstrap file (e.g., starter code archive) and attaches it to the specified assessment question settings. Replaces any existing bootstrap file.

Authorizations:

x-api-key

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

Delete the bootstrap file for a question

Removes the bootstrap file from storage and unsets the bootstrap setting on the specified assessment question.

Authorizations:

x-api-key

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

List supported coding languages

Returns the list of supported programming languages for coding or freecoding questions, along with available editor languages. Results are cached for one day.

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

Translates assessment question content, including title, description, and choices.

Authorizations:

x-api-key

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/json
required

targetLocales

required

Array of strings non-empty

Target language codes for translation (e.g. ["en","pt"]).

Responses

Request samples

Payload

Content type

application/json

{"targetLocales": ["string"
]
}

Generate criteria for an assessment question

Generates evaluation criteria for the specified assessment question.

Authorizations:

x-api-key

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

Run SQL question preview

Executes SQL code against a dataset or script-based schema for preview purposes. Compares the output with an optional solution query and returns the result set, execution time, and pass/fail status.

Authorizations:

x-api-key

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/json
required

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

Content type

application/json

{"code": "select 1",
"dataset_id": "61b8e9bb2300e80010c0bcc2",
"script": "CREATE TABLE test (id INT); INSERT INTO test VALUES (1);",
"solution": "select 1",
"language": "82",
"mode": "default"
}

Bulk import questions from CSV/spreadsheet data

Creates multiple assessment questions from parsed spreadsheet data. Supports optional status parameter ("created" or "published"). Returns IDs of created questions and a batch identifier.

Authorizations:

x-api-key

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/json
required

required	Array of objects (BulkImportQuestionItemDto) Array of questions to import
language	string Default language for all questions if not specified per-question
status	string Default: "created" Enum: "created" "published" Status for all imported questions. Defaults to "created" (draft)

Responses

Request samples

Payload

Content type

application/json

{"questions": [{"name": "Method Swizzling",
"description": "string",
"tags": ["Objective-C",
"iOS"
],
"shuffle": "N",
"duration": 5,
"level": "beginner",
"answers": ["A"
],
"choices": {"A": "Option 1",
"B": "Option 2",
"C": "Option 3"
},
"weight": 1,
"goal": "string",
"evaluation": "string",
"language": "pt"
}
],
"language": "pt",
"status": "created"
}

Check CAT pool readiness for a FAST question

Analyzes the subquestion pool of a FAST question and reports whether each difficulty bucket has at least 2 questions per skill. Returns warnings for any (bucket, skill) pairs below the minimum.

Authorizations:

x-api-key

path Parameters

id

required

string

Example: 61b8e9bb2300e80010c0bcc2

query Parameters

question_ids

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

List question datasets

Returns all question datasets available to the current workspace, including both workspace-owned datasets and global datasets without a company assignment.

Authorizations:

x-api-key

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

Content type

application/json

[{ }
]

Create a question dataset

Uploads a gzip-compressed file to create a new question dataset for the current workspace. The file must be in gzip format and within the configured size limit.

Authorizations:

x-api-key

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-data
required

name required	string Dataset name
description	string Dataset description

Responses

Find a question dataset by ID

Returns a single question dataset identified by its ID. Access is scoped to the current workspace. Returns 403 if the dataset is not found or does not belong to the workspace.

Authorizations:

x-api-key

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

Content type

application/json

{"_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"
}

Recalculate soft skill assessment score by ID

Re-processes the stored soft skill choices through the psychometric provider to recalculate the assessment score. Restricted to super admin users.

Authorizations:

x-api-key

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

Unlock soft skill assessment result by ID

Unlocks the soft skill assessment result for viewing, creating a profiler if needed. Restricted to admin and manager roles.

Authorizations:

x-api-key

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

Download soft skill PDF report by ID

Generates or retrieves the PDF report for a finished soft skill assessment answer and returns a signed download URL.

Authorizations:

x-api-key

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

Create an action plan

Creates a new action plan associated with the current user and workspace. Returns the ID of the newly created action plan.

Authorizations:

x-api-key

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/json
required

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

Content type

application/json

{"title": "Action Plan 1",
"description": "Action Plan 1 description",
"url": "https://www.google.com",
"type": "course",
"provider": "coodesh"
}

Delete multiple action plans

Deletes multiple action plans from the workspace library.

Authorizations:

x-api-key

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 an action plan by ID

Returns a single action plan identified by its ID. Access is scoped to the current workspace, also including global action plans without a company assignment.

Authorizations:

x-api-key

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

Content type

application/json

{"_id": "6501d432afe2730012f74d68",
"title": "Course Title",
"description": "Course Description",
"type": "course",
"status": "published",
"url": "https://example.com/course",
"main_language": "pt",
"languages": { },
"company": "6501d432afe2730012f74d68",
"created": "2023-10-01T00:00:00.000Z",
"updated": "2023-10-15T00:00:00.000Z"
}

Update an action plan by ID

Updates an existing action plan identified by its ID. Validates the action plan exists and belongs to the current workspace before applying changes. Returns a redirect path to the updated action plan.

Authorizations:

x-api-key

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/json
required

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

Content type

application/json

{"title": "Action Plan 1",
"description": "Action Plan 1 description",
"url": "https://www.google.com",
"type": "course",
"provider": "coodesh",
"_id": "60f5a4e2f4e6e1001f5a4e2f",
"question": "60f5a4e2f4e6e1001f5a4e2f"
}

List action plans library

Returns a paginated list of action plans from the library. Supports filtering by status, author, type, language, and free-text search. Results include both workspace-owned and global action plans.

Authorizations:

x-api-key

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

Content type

application/json

{"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
}

Bulk attach action plans to a question

Attaches multiple action plans to a specific assessment question by their IDs. Validates the question exists and belongs to the current workspace before attaching.

Authorizations:

x-api-key

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/json
required

ids

required

Array of objects (ObjectId)

Array of ids

Responses

Request samples

Payload

Content type

application/json

{"ids": [{ }
]
}

Unattach multiple action plans from question

Detaches multiple action plans from the specified assessment question.

Authorizations:

x-api-key

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/json
required

ids

required

Array of objects (ObjectId)

Array of ids

Responses

Request samples

Payload

Content type

application/json

{"ids": [{ }
]
}

Get action plan field definitions

Returns the available field options for action plans including statuses, types, and supported languages. Results are cached for one day.

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

Attempts

Start and management of assessment attempts

Find assessment attempt result

Display assessment attempt result for assessment managers

Authorizations:

x-api-key

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

Content type

application/json

{"_id": "6501d432afe2730012f74d68",
"score": 85.5,
"grade_tag": {"tag_id": "62b5faff5a80481c2cba4669",
"name": "Adequado"
},
"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,
"min_score": 0,
"max_score": 10
}
}
],
"user": {"_id": "6501d432afe2730012f74d68",
"displayName": "John Doe",
"email": "john.doe@example.com",
"image": "https://example.com/image.png"
},
"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",
"certificate_url": "https://example.com/certificate/123",
"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,
"maxScore": 1,
"reopen_date": "2019-08-24T14:15:22Z",
"finishedIn": 45,
"proctoring": {"type": "snapshots",
"content_removed_at": "2019-08-24T14:15:22Z",
"photo_id": "https://example.com/photo_id.png",
"snapshots": [{"image": "https://example.com/snapshot.png",
"created": "2019-08-24T14:15:22Z",
"question": { }
}
]
},
"whitelabel": {"_id": "6501d432afe2730012f74d68",
"name": "Company Name",
"image": "https://example.com/logo.png",
"primaryColor": "#3B82F6"
},
"can_export": true
}

Find assessment attempt result

Display assessment attempt result for assessment managers

Authorizations:

x-api-key

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

Content type

application/json

{"_id": "6501d432afe2730012f74d68",
"score": 85.5,
"grade_tag": {"tag_id": "62b5faff5a80481c2cba4669",
"name": "Adequado"
},
"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,
"min_score": 0,
"max_score": 10
}
}
],
"user": {"_id": "6501d432afe2730012f74d68",
"displayName": "John Doe",
"email": "john.doe@example.com",
"image": "https://example.com/image.png"
},
"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",
"certificate_url": "https://example.com/certificate/123",
"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,
"maxScore": 1,
"reopen_date": "2019-08-24T14:15:22Z",
"finishedIn": 45,
"proctoring": {"type": "snapshots",
"content_removed_at": "2019-08-24T14:15:22Z",
"photo_id": "https://example.com/photo_id.png",
"snapshots": [{"image": "https://example.com/snapshot.png",
"created": "2019-08-24T14:15:22Z",
"question": { }
}
]
},
"whitelabel": {"_id": "6501d432afe2730012f74d68",
"name": "Company Name",
"image": "https://example.com/logo.png",
"primaryColor": "#3B82F6"
},
"can_export": true
}

Generate auto login link

This endpoint creates invite links with user token to reduce the number of clicks to access the assessment.

Authorizations:

x-api-key

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/json
required

participations required	Array of objects (ObjectId) Participation ids to generate autologin links
assessment required	object Assessment

Responses

Request samples

Payload

Content type

application/json

{"participations": ["62b384d70309831f9c13c87d",
"62b5faff5a80481c2cba4669"
],
"assessment": "62b384d70309831f9c13c87d"
}

Recalculate assessment attempt

Triggers a recalculation of scores and results for a specific assessment attempt.

Authorizations:

x-api-key

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

List assessment participants

Returns a paginated list of people who participated in assessments within the workspace.

Authorizations:

x-api-key

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

Content type

application/json

{"docs": [{"_id": "6501d432afe2730012f74d68",
"user": {"_id": "6501d432afe2730012f74d68",
"displayName": "John Doe",
"email": "john.doe@example.com",
"image": "https://example.com/image.png"
},
"link": "https://assessments.coodesh.com/invite/abc123",
"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,
"score_type": "percentage",
"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
}

List participant field definitions

Returns available statuses, stages, and severity categories for assessment participants.

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

List assessment attempt tags

Returns paginated tags associated with assessment attempts, filtered by workspace and status.

Authorizations:

x-api-key

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

Content type

application/json

{"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:

x-api-key

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/json
required

ids

required

Array of strings

Array of assessment attempt IDs to delete

Responses

Request samples

Payload

Content type

application/json

{"ids": ["507f1f77bcf86cd799439011",
"507f191e810c19729de860ea"
]
}

Send invite to participants

Send invite to participants by assessment id. The attempts had been created before, using CreateAssessmentAttempts endpoint.

Authorizations:

x-api-key

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/json
required

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

Content type

application/json

{"ids": ["62b384d70309831f9c13c87d",
"62b5faff5a80481c2cba4669"
],
"send_at": "2019-08-24T14:15:22Z"
}

Bulk unlock assessment attempts

Unlocks multiple assessment attempts at once, verifying credit balances and permissions for each attempt.

Authorizations:

x-api-key

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/json
required

ids

required

Array of strings (Assessment attempt ids)

Responses

Request samples

Payload

Content type

application/json

{"ids": ["string"
]
}

Response samples

201

Content type

application/json

{ }

Sync assessment attempt

Triggers a re-sync of the assessment attempt results and scoring.

Authorizations:

x-api-key

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

Bulk recalculate assessment attempt scores

Recalculates scores for finished or blocked assessment attempts by their IDs or assessment IDs.

Authorizations:

x-api-key

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/json
required

ids

required

Array of strings (Assessment attempt ids)

Responses

Request samples

Payload

Content type

application/json

{"ids": ["string"
]
}

Reopen attempts

Reopens closed assessment attempts in bulk so participants can continue.

Authorizations:

x-api-key

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/json
required

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

Content type

application/json

{"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

Sends hidden assessment results to participants for multiple attempts.

Authorizations:

x-api-key

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/json
required

ids

required

Array of strings (Assessment attempt ids) non-empty

List of assessment attempt ids to send results

Responses

Request samples

Payload

Content type

application/json

{"ids": ["507f1f77bcf86cd799439011",
"507f191e810c19729de860ea"
]
}

Bulk update assessment attempts

Company admins can update only owned attempts.

Authorizations:

x-api-key

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/json
required

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

Content type

application/json

{"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
}

List attempt IDs for navigation

Returns a list of finished attempt IDs for a given assessment, used for cursor-based navigation.

Authorizations:

x-api-key

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

Content type

application/json

{"docs": [{"_id": "6501d432afe2730012f74d68"
}
]
}

List attempt inviters

Returns the list of users who invited participants to the specified assessments.

Authorizations:

x-api-key

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

Content type

application/json

[{ }
]

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:

x-api-key

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/json
required

ids

required

Array of strings (User ids)

Responses

Request samples

Payload

Content type

application/json

{"ids": ["string"
]
}

Close expired assessment attempts

Finds and closes all expired assessment attempts and answers. Super admin only.

Authorizations:

x-api-key

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

List attempts by assessment

Returns a paginated list of assessment attempts (responses) for a specific assessment.

Authorizations:

x-api-key

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

Content type

application/json

{"docs": [{"_id": "6501d432afe2730012f74d68",
"user": {"_id": "6501d432afe2730012f74d68",
"displayName": "John Doe",
"email": "john.doe@example.com",
"image": "https://example.com/image.png"
},
"link": "https://assessments.coodesh.com/invite/abc123",
"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,
"grade_tag": {"tag_id": "62b5faff5a80481c2cba4669",
"name": "Adequado"
},
"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
}

List attempts for a user by id in workspace

Returns paginated assessment attempts for a specific workspace user.

Authorizations:

x-api-key

path Parameters

id

required

string

Example: 66f1f3e42c10b77c8f36ab4e

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=invited Filter by status. Cannot be used with grouping query
grouping	string Enum: "results" "invited" Grouping by status. Cannot be used with status query
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

Content type

application/json

{"docs": [{"_id": "6501d432afe2730012f74d68",
"assessment": {"_id": "6501d432afe2730012f74d68",
"name": "Frontend Developer Assessment",
"duration": 60,
"duration_unit": "minutes",
"company": {"_id": "6501d432afe2730012f74d68",
"company_name": "Company Name"
},
"language": "English",
"questions_count": 10
},
"hidden_results": true,
"certificate_status": "issued",
"certificate_url": "https://example.com/certificate/123",
"company": {"_id": "6501d432afe2730012f74d68",
"company_name": "Company Name"
},
"score": 85.5,
"score_type": "percentage",
"status": "finished",
"status_formatted": "Finished",
"finished": "2019-08-24T14:15:22Z",
"invitation_date_expire": "2019-08-24T14:15:22Z",
"invitation_link": "https://assessments.coodesh.com/invite/abc123",
"has_pending_answers": true
}
],
"totalDocs": 50,
"limit": 10,
"totalPages": 5,
"page": 1,
"pagingCounter": 1,
"hasPrevPage": false,
"hasNextPage": true,
"prevPage": null,
"nextPage": 2
}

Cancel scheduled attempts

Cancels scheduled assessment attempts in bulk and reverts them to draft status.

Authorizations:

x-api-key

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/json
required

ids

required

Array of strings (Assessment attempt ids)

Responses

Request samples

Payload

Content type

application/json

{"ids": ["string"
]
}

Schedule open dates for attempts in bulk

Distributes custom_time_open dates across 30-minute slots for attempts of given assessments, limiting to a configurable batch size per slot (default 30, resulting in 60 results per hour). Only schedules attempts that do not already have a custom_time_open set.

Authorizations:

x-api-key

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/json
required

assessment_ids required	Array of strings <= 50 items Assessment IDs to schedule open dates for their attempts
start_at	string <date-time> (Start date) Date/time to start scheduling from. Defaults to now if not provided.
batch_size	number (Batch size) [ 1 .. 100 ] Default: 30 Number of attempts per 30-minute slot (default: 30, resulting in 60/hour)

Responses

Request samples

Payload

Content type

application/json

{"assessment_ids": ["62b384d70309831f9c13c87d",
"62b5faff5a80481c2cba4669"
],
"start_at": "2019-08-24T14:15:22Z",
"batch_size": 30
}

Bulk mark assessment attempts as finished

Marks multiple assessment attempts as finished.

Authorizations:

x-api-key

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/json
required

ids

required

Array of strings (Assessment attempt ids)

Responses

Request samples

Payload

Content type

application/json

{"ids": ["string"
]
}

Get attempt notes

Retrieves the assessment notes for a specific in-progress attempt.

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

Save attempt notes

Updates the assessment notes for a specific in-progress attempt.

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

Upload proctoring snapshot

Uploads a webcam snapshot image for proctoring during an active assessment attempt.

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

Upload proctoring audio recording

Uploads an audio recording file for proctoring during an active assessment attempt.

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

Upload proctoring session recording

Uploads session replay events as a JSON file for proctoring during an assessment attempt.

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

Get attempt recommendations

Retrieves learning recommendations for a specific assessment attempt, optionally filtered by answer.

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

Content type

application/json

{"recommendations": [{"_id": "6501d432afe2730012f74d68",
"title": "Advanced JavaScript Course",
"description": "Learn advanced JS concepts",
"type": "course",
"url": "https://example.com/course",
"skills": [{"_id": "6501d432afe2730012f74d68",
"name": "JavaScript"
}
]
}
],
"total": 5
}

Get certificate by token

Retrieves assessment certificate details by answer token or attempt ID.

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

Content type

application/json

{"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",
"url": "https://assessments.coodesh.com/pt/assessments/fast/javascript"
},
"whitelabel": {"_id": "6501d432afe2730012f74d68",
"name": "Company Name",
"image": "https://example.com/logo.png",
"primaryColor": "#3B82F6"
}
}

Answers

Upload and processing of media in answers

Retrieve assessment answer fields

Returns the available feedback reason fields for assessment answers, formatted from the feedback enum values.

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 assessment answer by ID

Retrieves a specific assessment answer by its unique identifier.

Authorizations:

x-api-key

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

Find certificate by token

Retrieves the certificate details for a finished fast-type assessment answer using its token.

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

Content type

application/json

{"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"
}
}

Save review for assessment answer

Used on dashboard to save the manual score on the assessment answer

Authorizations:

x-api-key

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/json
required

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

Content type

application/json

{"review_notes": "",
"comment": "string",
"score": 0,
"repository_url": "https://github.com/user/repository"
}

Response samples

200

Content type

application/json

{ }

Upload proctoring media

Uploads a proctoring snapshot photo for a given assessment answer and records a tracking event.

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

Upload video presentation

Uploads a video or audio presentation file for an assessment answer, supporting both single and multipart uploads.

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/json
required

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

Content type

application/json

{"isLast": false,
"recordId": "string",
"partNumber": 0,
"totalChunks": 0
}

Response samples

201

Content type

application/json

{ }

Delete video presentation

Deletes the uploaded video or audio presentation recording from an assessment answer.

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

Find answers by attempt

Retrieves all assessment answers associated with a given attempt ID.

Authorizations:

x-api-key

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

Bulk move answers to pending review

Used on dashboard to move finished answers back to pending review status

Authorizations:

x-api-key

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/json
required

ids

required

Array of strings non-empty

Array of assessment answer IDs to move to pending review

Responses

Request samples

Payload

Content type

application/json

{"ids": ["19dbdf0e56e00123456789ab"
]
}

Questions

CRUD and search operations on assessment questions

Find assessment questions catalog

Find public assessment questions catalog and company questions

Authorizations:

x-api-key

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 `question_domains`
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

Content type

application/json

{"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
}

Create an assessment question

Creates a new assessment question with the provided details. The question scope is set to public for super admins and private for other roles. Returns the created question.

Authorizations:

x-api-key

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`

Deletes multiple created assessment questions using their identifiers.

Authorizations:

x-api-key

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/json
required

Array of question IDs to delete

Array

string

Responses

Request samples

Payload

Content type

application/json

["string"
]

Find an assessment question by ID

Retrieves a single assessment question by its ID. Supports optional population of related fields (author, skills, company) via the include query parameter. Falls back to public questions if not found in workspace.

Authorizations:

x-api-key

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

Content type

application/json

{"_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": [{ }
],
"cat": { },
"level_scale_id": "string"
},
"project": { },
"settings": { },
"recommendations": ["string"
],
"topics": ["string"
],
"categories": ["string"
],
"deleted": true
}

Update an assessment question

Updates an existing assessment question by its ID. If the question is public and belongs to a different workspace, it creates a private duplicate instead. Archived questions cannot be updated.

Authorizations:

x-api-key

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/json
required

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" "conversational" Indicates the type of assessmentQuestion the must be: fast,coding,sql,project,question,softskill,video,essay,audio,file,whiteboard,freecoding,conversational
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

Content type

application/json

{"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": [{ }
],
"cat": { },
"level_scale_id": "string"
},
"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",
"presentation_instructions": "string",
"repository_url": "http://example.com"
},
"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": [{ }
]
}

Find an assessment question by slug

Retrieves a single assessment question by its unique slug. Returns the question with localized content, level, duration, and associated topics.

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

Content type

application/json

{"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"
}
]
}

Get assessment question field definitions

Returns field metadata used to build assessment question forms.

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

List skills used across questions

Returns a paginated list of skills that are used across all assessment questions (excluding simple question types). Supports search filtering and pagination.

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

Content type

application/json

{"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
}

Questions library

Manage assessment questions catalog, filtering by type, level, search and pagination

Authorizations:

x-api-key

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" "conversational"
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

Content type

application/json

{"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,
"cat": {"enabled": true,
"batch_size": 5,
"max_questions": 30,
"initial_bucket_index": 0
},
"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,
"partial_score": 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:

x-api-key

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

Content type

application/json

{"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

Moves multiple challenges and questions to archived status.

Authorizations:

x-api-key

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/json
required

Array

string

Responses

Request samples

Payload

Content type

application/json

["string"
]

Bulk change status for challenges/questions

Moves multiple archived challenges and questions back to published status.

Authorizations:

x-api-key

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/json
required

Array of challenge/question IDs to unarchive

Array

string

Responses

Request samples

Payload

Content type

application/json

["61b8e9bb2300e80010c0bcc2"
]

Duplicate an assessment question

Creates a copy of an existing assessment question, including its settings and bootstrap files. The duplicated question is assigned to the current user and workspace with a created status.

Authorizations:

x-api-key

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:

x-api-key

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

Content type

application/json

{ }

Run coding question tests

Executes the code for a coding or freecoding question against its test cases using the judge service. Returns the test execution results including pass/fail status for each test case.

Authorizations:

x-api-key

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/json
required

Payload for running coding question

code	string
language	string
solution	string
stub	string
	Array of objects
max_execution_time	number

Responses

Request samples

Payload

Content type

application/json

{"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
}

List question authors

Returns the list of authors who have created assessment questions in the current workspace. Supports filtering by author IDs and text search.

Authorizations:

x-api-key

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

Content type

application/json

{"docs": [{"value": "6501d432afe2730012f74d68",
"label": "John Doe"
}
],
"totalDocs": 50,
"limit": 10,
"totalPages": 5,
"page": 1,
"pagingCounter": 1,
"hasPrevPage": false,
"hasNextPage": true,
"prevPage": null,
"nextPage": 2
}

List skills from the challenges library

Returns a paginated list of skills available in the challenges library. Supports filtering by question type, status, grouping, skills, and text search.

Authorizations:

x-api-key

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

Content type

application/json

{"docs": [{"_id": "6501d432afe2730012f74d68",
"name": "JavaScript"
}
],
"totalDocs": 50,
"limit": 10,
"totalPages": 5,
"page": 1,
"pagingCounter": 1,
"hasPrevPage": false,
"hasNextPage": true,
"prevPage": null,
"nextPage": 2
}

Upload media attachments for a question

Uploads one or more media files (images, audio, video, documents) as attachments to the specified assessment question. Enforces per-type file size limits and a maximum of 15 attachments per question.

Authorizations:

x-api-key

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

Delete a media attachment from a question

Removes a specific media attachment from storage and from the assessment question attachments list, identified by the file path in the request body.

Authorizations:

x-api-key

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 question recommendations

Returns a list of recommended questions related to the specified assessment question. Recommendations are scoped to the current workspace or public questions.

Authorizations:

x-api-key

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

Content type

application/json

[{"_id": "6501d432afe2730012f74d68",
"title": "JavaScript Course",
"description": "Learn JavaScript from scratch",
"provider": "Udemy",
"type": "course",
"usage": "paid",
"url": "https://example.com/course",
"company": {"_id": "6501d432afe2730012f74d68",
"company_name": "Acme Corp"
},
"main_language": "en",
"locales": ["string"
],
"type_formatted": "Course",
"status_formatted": "Published"
}
]

Get skills for a question

Returns the list of skills associated with a specific assessment question identified by its ID.

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

Content type

application/json

{"docs": [{"_id": "6501d432afe2730012f74d68",
"name": "JavaScript"
}
]
}

Upload a bootstrap file for a question

Uploads a bootstrap file (e.g., starter code archive) and attaches it to the specified assessment question settings. Replaces any existing bootstrap file.

Authorizations:

x-api-key

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

Delete the bootstrap file for a question

Removes the bootstrap file from storage and unsets the bootstrap setting on the specified assessment question.

Authorizations:

x-api-key

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

List supported coding languages

Returns the list of supported programming languages for coding or freecoding questions, along with available editor languages. Results are cached for one day.

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

Translates assessment question content, including title, description, and choices.

Authorizations:

x-api-key

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/json
required

targetLocales

required

Array of strings non-empty

Target language codes for translation (e.g. ["en","pt"]).

Responses

Request samples

Payload

Content type

application/json

{"targetLocales": ["string"
]
}

Generate criteria for an assessment question

Generates evaluation criteria for the specified assessment question.

Authorizations:

x-api-key

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

Run SQL question preview

Executes SQL code against a dataset or script-based schema for preview purposes. Compares the output with an optional solution query and returns the result set, execution time, and pass/fail status.

Authorizations:

x-api-key

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/json
required

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

Content type

application/json

{"code": "select 1",
"dataset_id": "61b8e9bb2300e80010c0bcc2",
"script": "CREATE TABLE test (id INT); INSERT INTO test VALUES (1);",
"solution": "select 1",
"language": "82",
"mode": "default"
}

Bulk import questions from CSV/spreadsheet data

Creates multiple assessment questions from parsed spreadsheet data. Supports optional status parameter ("created" or "published"). Returns IDs of created questions and a batch identifier.

Authorizations:

x-api-key

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/json
required

required	Array of objects (BulkImportQuestionItemDto) Array of questions to import
language	string Default language for all questions if not specified per-question
status	string Default: "created" Enum: "created" "published" Status for all imported questions. Defaults to "created" (draft)

Responses

Request samples

Payload

Content type

application/json

{"questions": [{"name": "Method Swizzling",
"description": "string",
"tags": ["Objective-C",
"iOS"
],
"shuffle": "N",
"duration": 5,
"level": "beginner",
"answers": ["A"
],
"choices": {"A": "Option 1",
"B": "Option 2",
"C": "Option 3"
},
"weight": 1,
"goal": "string",
"evaluation": "string",
"language": "pt"
}
],
"language": "pt",
"status": "created"
}

Check CAT pool readiness for a FAST question

Analyzes the subquestion pool of a FAST question and reports whether each difficulty bucket has at least 2 questions per skill. Returns warnings for any (bucket, skill) pairs below the minimum.

Authorizations:

x-api-key

path Parameters

id

required

string

Example: 61b8e9bb2300e80010c0bcc2

query Parameters

question_ids

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

List question datasets

Returns all question datasets available to the current workspace, including both workspace-owned datasets and global datasets without a company assignment.

Authorizations:

x-api-key

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

Content type

application/json

[{ }
]

Create a question dataset

Uploads a gzip-compressed file to create a new question dataset for the current workspace. The file must be in gzip format and within the configured size limit.

Authorizations:

x-api-key

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-data
required

name required	string Dataset name
description	string Dataset description

Responses

Find a question dataset by ID

Returns a single question dataset identified by its ID. Access is scoped to the current workspace. Returns 403 if the dataset is not found or does not belong to the workspace.

Authorizations:

x-api-key

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

Content type

application/json

{"_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"
}

Quizzes

Generate Cert

Handle GET quizzes/code/:code/certificate.

path Parameters

code

required

string

header Parameters

x-workspace-id	any Workspace identifier to scope the request to a specific company workspace
x-subaccount-id	any Subaccount identifier for multi-tenant operations within a workspace
x-language	any Preferred language for response content (e.g. "pt", "en", "es")

Responses

Find Consolidated

Handle GET root route.

header Parameters

x-workspace-id	any Workspace identifier to scope the request to a specific company workspace
x-subaccount-id	any Subaccount identifier for multi-tenant operations within a workspace
x-language	any Preferred language for response content (e.g. "pt", "en", "es")

Responses

Find All

Handle GET quizzes.

header Parameters

x-workspace-id	any Workspace identifier to scope the request to a specific company workspace
x-subaccount-id	any Subaccount identifier for multi-tenant operations within a workspace
x-language	any Preferred language for response content (e.g. "pt", "en", "es")

Responses

Upload a media attachment

Uploads a media file (audio, video, document, or whiteboard) for a question-type assessment answer. Supports both single and multipart uploads for large files. Only the answer owner can upload.

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/json
required

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

Content type

application/json

{"isLast": false,
"recordId": "string",
"partNumber": 0,
"totalChunks": 0
}

Response samples

201

Content type

application/json

{ }

Delete a media attachment

Deletes a previously uploaded audio or video recording for a question-type assessment answer. Only the answer owner can delete. Clears the stored answer URL.

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

Variants

List skill variants for a workspace

Retrieves a paginated list of skill variants for the current workspace. Supports filtering by name search and specific IDs. When both are provided, results match either condition.

Authorizations:

x-api-key

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

Content type

application/json

{"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
}

Create a skill variant

Creates a new skill variant for the current workspace. The variant is associated with the authenticated user as author and scoped to the workspace company.

Authorizations:

x-api-key

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

List template skill variants

Retrieves a paginated list of global template skill variants that are not associated with any specific company. Supports filtering by name search.

Authorizations:

x-api-key

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

Content type

application/json

{"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
}

Find a skill variant by ID

Retrieves a skill variant by its ID within the current workspace. Returns the variant with translated level descriptions and skill details based on the default locale.

Authorizations:

x-api-key

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

Content type

application/json

{"_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"
}

Update a skill variant

Updates an existing skill variant by its ID within the current workspace. Returns a redirect URL to the updated variant on success.

Authorizations:

x-api-key

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/json
required

_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

Content type

application/json

{"_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

Translates skill variant content including name, description, levels, and examples.

Authorizations:

x-api-key

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/json
required

targetLocales

required

Array of strings non-empty

Target language codes for translation (e.g. ["en","pt"]).

Responses

Request samples

Payload

Content type

application/json

{"targetLocales": ["string"
]
}

List skills export

Returns a paginated list of skill variants for export, with support for search and explicit ids filters.

Authorizations:

x-api-key

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

Content type

application/json

{"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
}

Export skills CSV

Exports skill variants as CSV using the provided search and explicit ids filters.

Authorizations:

x-api-key

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/json
required

search	string Full-text search on skill name
ids	Array of strings Filter by explicit skill ids

Responses

Request samples

Payload

Content type

application/json

{"search": "communication",
"ids": ["65f8c2f739ee2f2c21ff9c10",
"65f8c2f739ee2f2c21ff9c11"
]
}

Response samples

200

Content type

application/json

[{"filename": "export.csv",
"data": "id;name;status"
}
]

Generate proficiency levels with AI

Uses AI to generate proficiency levels with descriptions and examples for a skill variant.

Authorizations:

x-api-key

path Parameters

id

required

string

Example: 61b8e9bb2300e80010c0bcc2

query Parameters

locale

string

Example: locale=pt

Target locale for generated content

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 examples for a skill variant level with AI

Uses AI to generate concrete examples for a specific proficiency level of a skill variant.

Authorizations:

x-api-key

path Parameters

id required	string Example: 61b8e9bb2300e80010c0bcc2
levelId required	string Example: 61b8e9bb2300e80010c0bcc3

query Parameters

locale

string

Example: locale=pt

Target locale for generated content

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 skill description using AI

Uses AI to generate a professional description for the skill linked to this variant.

Authorizations:

x-api-key

path Parameters

id

required

string

Example: 61b8e9bb2300e80010c0bcc2

query Parameters

locale

string

Example: locale=pt

Target locale for generated content

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

Action Plan

Create an action plan

Creates a new action plan associated with the current user and workspace. Returns the ID of the newly created action plan.

Authorizations:

x-api-key

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/json
required

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

Content type

application/json

{"title": "Action Plan 1",
"description": "Action Plan 1 description",
"url": "https://www.google.com",
"type": "course",
"provider": "coodesh"
}

Delete multiple action plans

Deletes multiple action plans from the workspace library.

Authorizations:

x-api-key

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 an action plan by ID

Returns a single action plan identified by its ID. Access is scoped to the current workspace, also including global action plans without a company assignment.

Authorizations:

x-api-key

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

Content type

application/json

{"_id": "6501d432afe2730012f74d68",
"title": "Course Title",
"description": "Course Description",
"type": "course",
"status": "published",
"url": "https://example.com/course",
"main_language": "pt",
"languages": { },
"company": "6501d432afe2730012f74d68",
"created": "2023-10-01T00:00:00.000Z",
"updated": "2023-10-15T00:00:00.000Z"
}

Update an action plan by ID

Updates an existing action plan identified by its ID. Validates the action plan exists and belongs to the current workspace before applying changes. Returns a redirect path to the updated action plan.

Authorizations:

x-api-key

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/json
required

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

Content type

application/json

{"title": "Action Plan 1",
"description": "Action Plan 1 description",
"url": "https://www.google.com",
"type": "course",
"provider": "coodesh",
"_id": "60f5a4e2f4e6e1001f5a4e2f",
"question": "60f5a4e2f4e6e1001f5a4e2f"
}

List action plans library

Returns a paginated list of action plans from the library. Supports filtering by status, author, type, language, and free-text search. Results include both workspace-owned and global action plans.

Authorizations:

x-api-key

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

Content type

application/json

{"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
}

Bulk attach action plans to a question

Attaches multiple action plans to a specific assessment question by their IDs. Validates the question exists and belongs to the current workspace before attaching.

Authorizations:

x-api-key

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/json
required

ids

required

Array of objects (ObjectId)

Array of ids

Responses

Request samples

Payload

Content type

application/json

{"ids": [{ }
]
}

Unattach multiple action plans from question

Detaches multiple action plans from the specified assessment question.

Authorizations:

x-api-key

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/json
required

ids

required

Array of objects (ObjectId)

Array of ids

Responses

Request samples

Payload

Content type

application/json

{"ids": [{ }
]
}

Get action plan field definitions

Returns the available field options for action plans including statuses, types, and supported languages. Results are cached for one day.

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 skills for career positions using AI

Uses AI to generate a comprehensive set of skills, categories, and requirements for the specified career positions. Supports "append" mode (merge with existing) or "replace" mode (clear and regenerate).

Authorizations:

x-api-key

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/json
required

positions	Array of strings Specific position IDs to generate skills for. If omitted, generates for all positions in the team.
mode required	string Enum: "append" "replace" Mode of operation: "append" merges with existing skills (skips duplicates), "replace" clears existing skills/requirements for target positions before applying new ones.

Responses

Request samples

Payload

Content type

application/json

{"positions": ["61b8e9bb2300e80010c0bcc2"
],
"mode": "append"
}

Generate skills for a single position using AI

Uses AI to generate skills, categories, and requirements for a specific position within a career. Supports "append" mode (merge with existing) or "replace" mode (clear and regenerate).

Authorizations:

x-api-key

path Parameters

id required	string Example: 61b8e9bb2300e80010c0bcc2 Career (team) ID
positionId required	string Example: 61b8e9bb2300e80010c0bcc3 Position ID within the career

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/json
required

mode

required

string

Enum: "append" "replace"

Mode of operation: "append" merges with existing skills (skips duplicates), "replace" clears existing skills/requirements for the position before applying new ones.

Responses

Request samples

Payload

Content type

application/json

{"mode": "append"
}

Import careers from spreadsheet data

Imports career structures (teams, tracks, positions) from parsed spreadsheet data. Each row contains a career name, track name, and a list of positions in seniority order.

Authorizations:

x-api-key

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/json
required

required

Array of objects (ImportCareerRowDto) non-empty

Responses

Request samples

Payload

Content type

application/json

{"rows": [{"career": "Desenvolvimento",
"track": "Base",
"positions": ["Desenvolvedor I",
"Desenvolvedor II",
"Desenvolvedor III"
]
}
]
}

Import position descriptions

Updates position descriptions in existing careers. Each row contains career name, track name, position name, and description.

Authorizations:

x-api-key

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/json
required

required

Array of objects (ImportDescriptionRowDto) non-empty

Responses

Request samples

Payload

Content type

application/json

{"rows": [{"career": "Desenvolvimento",
"track": "Base",
"position": "Desenvolvedor I",
"description": "Responsável por desenvolver..."
}
]
}

Management

Find assessments

Retrieves a paginated list of assessments with filtering by status, skills, author, language, and career.

Authorizations:

x-api-key

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

Content type

application/json

{"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

Authorizations:

x-api-key

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/json
required

ids

required

Array of objects (ObjectId)

Array of ids

Responses

Request samples

Payload

Content type

application/json

{"ids": [{ }
]
}

Upload media attachments

Uploads one or more media files as attachments to an assessment, with size limits based on file type.

Authorizations:

x-api-key

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

Delete media attachment

Deletes a specific media attachment from an assessment by its storage path.

Authorizations:

x-api-key

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

Update an assessment

Updates an existing assessment with the provided data, including name, settings, questions, and tags.

Authorizations:

x-api-key

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/json
required

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

Content type

application/json

{"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,
"cat_initial_bucket_index": 0,
"accepted_languages": ["string"
],
"conversational": { }
}
],
"settings": {"invites_expiration": 120,
"invites_expiration_type": "relative",
"invites_expiration_fixed_date": "2019-08-24T14:15:22Z",
"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_id": { },
"color": "green"
}
],
"grade_tags_enabled": false,
"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"
]
}

Get assessment field definitions

Retrieves available field definitions, enums, and default values used for assessment configuration.

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 assessment invitation links

Retrieves all participant invitation links for a given assessment, including participant name, email, status, and invite URL.

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

Content type

application/json

[{"name": "John Doe",
"email": "john.doe@example.com",
"status": "invited",
"invite_date": "2019-08-24T14:15:22Z",
"link": "https://assessments.coodesh.com/invite/abc123"
}
]

Duplicate an assessment

Creates a copy of an existing assessment with a new draft status and optional field overrides.

Authorizations:

x-api-key

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/json
required

name required	string
career required	object (ObjectId)
required	object (SettingsDto)

Responses

Request samples

Payload

Content type

application/json

{"name": "string",
"career": { },
"settings": {"invites_expiration": 120,
"invites_expiration_type": "relative",
"invites_expiration_fixed_date": "2019-08-24T14:15:22Z",
"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_id": { },
"color": "green"
}
],
"grade_tags_enabled": false,
"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": { }
}
}

Find assessment share links

Retrieves all share links for a given assessment, including token, active status, tags, and time window.

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

Content type

application/json

[{"token": "abc123xyz",
"active": true,
"tags": ["string"
],
"tags_list": [{"_id": "6501d432afe2730012f74d68",
"name": "Frontend"
}
],
"time_open": "2019-08-24T14:15:22Z",
"time_close": "2019-08-24T14:15:22Z"
}
]

Update assessment share links

Updates the share links for a given assessment, including active status, tags, and time window for each link.

Authorizations:

x-api-key

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/json
required

required

Array of objects (AssessmentLinkDto)

Responses

Request samples

Payload

Content type

application/json

{"links": [{"tags": ["Linkedin",
"Coodesh"
],
"active": true,
"watcher": true,
"token": "1663018172366",
"time_open": "2019-08-24T14:15:22Z",
"time_close": "2019-08-24T14:15:22Z"
}
]
}

Get assessments statistics

Retrieves aggregated statistics for all assessments within the current workspace.

Authorizations:

x-api-key

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

Content type

application/json

{"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"
}
]
}

Get statistics for a specific assessment

Retrieves aggregated statistics for a single assessment identified by its ID.

Authorizations:

x-api-key

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

Content type

application/json

{"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"
}
]
}

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:

x-api-key

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/json
required

participants

required

Array of strings

Indicates the users that will receveid invite email

Responses

Request samples

Payload

Content type

application/json

{"participants": ["62b384d70309831f9c13c87d",
"62b5faff5a80481c2cba4669"
]
}

Response samples

201

Content type

application/json

{ }

Export assessments CSV

Exports assessment results as CSV and can optionally include action plans and integrity files. Supports filtering by assessment ids, company ids, and date range.

Authorizations:

x-api-key

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/json
required

include_expired_participations	boolean
include_pending_participations	boolean
include_actions_plans	boolean
include_integrity	boolean
startDate	string
endDate	string
ids	Array of strings Filter by assessment ids
companies	Array of strings Filter by company ids (used outside workspace scope)

Responses

Request samples

Payload

Content type

application/json

{"include_expired_participations": false,
"include_pending_participations": true,
"include_actions_plans": true,
"include_integrity": true,
"startDate": "2026-01-01",
"endDate": "2026-01-31",
"ids": ["65f8c2f739ee2f2c21ff9c10",
"65f8c2f739ee2f2c21ff9c11"
],
"companies": ["65f8c2f739ee2f2c21ff9d20"
]
}

Response samples

200

Content type

application/json

[{"filename": "export.csv",
"data": "id;name;status"
}
]

List assessment authors

Retrieves the list of authors who have created assessments within the current workspace.

Authorizations:

x-api-key

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

Content type

application/json

[{"_id": "6501d432afe2730012f74d68",
"label": "Jane Smith",
"value": "6501d432afe2730012f74d68"
}
]

List assessment skills

Retrieves the distinct skills used across assessments in the current workspace.

Authorizations:

x-api-key

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

Content type

application/json

{"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
}

List assessments with minimal fields

Retrieves a paginated list of assessments returning only ID and name, suitable for dropdown selectors.

Authorizations:

x-api-key

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

Content type

application/json

{"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
}

Trails

Find By Limit

Handle GET widget/:limit.

path Parameters

limit

required

string

header Parameters

x-workspace-id	any Workspace identifier to scope the request to a specific company workspace
x-subaccount-id	any Subaccount identifier for multi-tenant operations within a workspace
x-language	any Preferred language for response content (e.g. "pt", "en", "es")

Responses

Response samples

200

Content type

application/json

[{"_id": "507f1f77bcf86cd799439044",
"authors": [{"_id": "507f1f77bcf86cd799439011",
"displayName": "Jane Smith",
"username": "janesmith"
}
],
"partners": [{"_id": "507f1f77bcf86cd799439033",
"company_name": "Coodesh",
"slug": "coodesh"
}
],
"mentors": [{"_id": "507f1f77bcf86cd799439011",
"displayName": "Jane Smith",
"username": "janesmith"
}
],
"category": {"_id": "507f1f77bcf86cd799439022",
"name": "Development",
"slug": "development"
},
"sponsored": false,
"name": "React.js Trail",
"slug": "reactjs",
"code": "d9428888-122b-11e1-b85c-61cd3cbed44a",
"start_period": "2026-03-01T00:00:00.000Z",
"end_period": "2026-06-01T00:00:00.000Z",
"tags": ["reactjs",
"frontend",
"javascript"
],
"keywords": ["react",
"web development"
],
"meta_tags": ["react course",
"learn react"
],
"meta_description": "Learn React.js from scratch with hands-on projects",
"short_summary": "A hands-on React.js learning trail",
"description": "This trail covers React.js fundamentals, hooks, state management, and more.",
"sub_name": "From Zero to Hero",
"type": "remote",
"level": "beginner",
"frequency": "weekly",
"ico": "fa-react",
"color": "#61DAFB",
"cover_image": {"url": "https://cdn.example.com/images/react-trail.jpg"
},
"gallery": [ ],
"cover_video": {"id": "12345678",
"url": "https://www.youtube.com/watch?v=dQw4w9WgXcQ",
"source": "youtube"
},
"languages": [{"ico": "flag-br",
"name": "Portuguese",
"code": "pt-BR",
"description": "Brazilian Portuguese"
}
],
"additional_information": "All materials are provided in Portuguese and English.",
"differentials": [{"ico": "fa-check",
"item": "Hands-on projects"
}
],
"highlights": [{"ico": "fa-star",
"name": "Industry Expert Mentors",
"description": "Learn from senior developers",
"picture": "https://cdn.example.com/images/highlight.jpg"
}
],
"requirements": [{"ico": "fa-laptop",
"item": "Computer with internet access",
"description": "A laptop or desktop with stable internet connection",
"picture": null
}
],
"other_requirements": "Basic knowledge of HTML and CSS",
"includes": [{"ico": "fa-certificate",
"name": "Certificate of Completion",
"description": "Digital certificate upon course completion"
}
],
"order": 1,
"expected_duration": 40,
"duration": {"duration_type": "hours",
"duration": 40
},
"meeting_point": {"complete_address": "Av. Paulista, 1578 - Bela Vista, Sao Paulo",
"reference": "Near MASP",
"lat_lng": [-23.5614,
-46.6558
],
"google_map_url": "https://maps.google.com/?q=-23.5614,-46.6558"
},
"prices": [{"currency": "BRL",
"amount": 99.9,
"description": "per_person"
}
],
"free": true,
"public": true,
"availability": "sometimes",
"active": "published",
"configuration": {"need_id_document": false,
"need_github": true,
"need_linkedin": false,
"type_reservation": "individually",
"min_persons": 1,
"max_persons": 1,
"available": 50,
"rate": {"description": "Platform rate",
"percentage": 10
},
"month_availability": 3,
"has_installments": true,
"min_amount_installment_payment": 30,
"max_installments": 12
},
"created": "2026-01-15T10:30:00.000Z",
"update_date": "2026-02-10T14:20:00.000Z",
"has_wish_list": false,
"average_rating": 4.5,
"favorite": false,
"related_trails": [ ],
"related_articles": [ ],
"views": 1250
}
]

Find All Published

Handle GET published.

header Parameters

x-workspace-id	any Workspace identifier to scope the request to a specific company workspace
x-subaccount-id	any Subaccount identifier for multi-tenant operations within a workspace
x-language	any Preferred language for response content (e.g. "pt", "en", "es")

Responses

Response samples

200

Content type

application/json

[{"_id": "507f1f77bcf86cd799439044",
"authors": [{"_id": "507f1f77bcf86cd799439011",
"displayName": "Jane Smith",
"username": "janesmith"
}
],
"partners": [{"_id": "507f1f77bcf86cd799439033",
"company_name": "Coodesh",
"slug": "coodesh"
}
],
"mentors": [{"_id": "507f1f77bcf86cd799439011",
"displayName": "Jane Smith",
"username": "janesmith"
}
],
"category": {"_id": "507f1f77bcf86cd799439022",
"name": "Development",
"slug": "development"
},
"sponsored": false,
"name": "React.js Trail",
"slug": "reactjs",
"code": "d9428888-122b-11e1-b85c-61cd3cbed44a",
"start_period": "2026-03-01T00:00:00.000Z",
"end_period": "2026-06-01T00:00:00.000Z",
"tags": ["reactjs",
"frontend",
"javascript"
],
"keywords": ["react",
"web development"
],
"meta_tags": ["react course",
"learn react"
],
"meta_description": "Learn React.js from scratch with hands-on projects",
"short_summary": "A hands-on React.js learning trail",
"description": "This trail covers React.js fundamentals, hooks, state management, and more.",
"sub_name": "From Zero to Hero",
"type": "remote",
"level": "beginner",
"frequency": "weekly",
"ico": "fa-react",
"color": "#61DAFB",
"cover_image": {"url": "https://cdn.example.com/images/react-trail.jpg"
},
"gallery": [ ],
"cover_video": {"id": "12345678",
"url": "https://www.youtube.com/watch?v=dQw4w9WgXcQ",
"source": "youtube"
},
"languages": [{"ico": "flag-br",
"name": "Portuguese",
"code": "pt-BR",
"description": "Brazilian Portuguese"
}
],
"additional_information": "All materials are provided in Portuguese and English.",
"differentials": [{"ico": "fa-check",
"item": "Hands-on projects"
}
],
"highlights": [{"ico": "fa-star",
"name": "Industry Expert Mentors",
"description": "Learn from senior developers",
"picture": "https://cdn.example.com/images/highlight.jpg"
}
],
"requirements": [{"ico": "fa-laptop",
"item": "Computer with internet access",
"description": "A laptop or desktop with stable internet connection",
"picture": null
}
],
"other_requirements": "Basic knowledge of HTML and CSS",
"includes": [{"ico": "fa-certificate",
"name": "Certificate of Completion",
"description": "Digital certificate upon course completion"
}
],
"order": 1,
"expected_duration": 40,
"duration": {"duration_type": "hours",
"duration": 40
},
"meeting_point": {"complete_address": "Av. Paulista, 1578 - Bela Vista, Sao Paulo",
"reference": "Near MASP",
"lat_lng": [-23.5614,
-46.6558
],
"google_map_url": "https://maps.google.com/?q=-23.5614,-46.6558"
},
"prices": [{"currency": "BRL",
"amount": 99.9,
"description": "per_person"
}
],
"free": true,
"public": true,
"availability": "sometimes",
"active": "published",
"configuration": {"need_id_document": false,
"need_github": true,
"need_linkedin": false,
"type_reservation": "individually",
"min_persons": 1,
"max_persons": 1,
"available": 50,
"rate": {"description": "Platform rate",
"percentage": 10
},
"month_availability": 3,
"has_installments": true,
"min_amount_installment_payment": 30,
"max_installments": 12
},
"created": "2026-01-15T10:30:00.000Z",
"update_date": "2026-02-10T14:20:00.000Z",
"has_wish_list": false,
"average_rating": 4.5,
"favorite": false,
"related_trails": [ ],
"related_articles": [ ],
"views": 1250
}
]

Find By Slug

Handle GET slug/:trailSlug.

path Parameters

trailSlug

required

string

header Parameters

x-workspace-id	any Workspace identifier to scope the request to a specific company workspace
x-subaccount-id	any Subaccount identifier for multi-tenant operations within a workspace
x-language	any Preferred language for response content (e.g. "pt", "en", "es")

Responses

Response samples

200

Content type

application/json

{"_id": "507f1f77bcf86cd799439044",
"authors": [{"_id": "507f1f77bcf86cd799439011",
"displayName": "Jane Smith",
"username": "janesmith",
"image": "https://cdn.example.com/images/jane.jpg",
"social_medias": {"github": "https://github.com/janesmith"
}
}
],
"partners": [{"_id": "507f1f77bcf86cd799439033",
"company_name": "Coodesh",
"slug": "coodesh",
"image": "https://cdn.example.com/images/coodesh.png",
"website": "https://coodesh.com"
}
],
"mentors": [{"_id": "507f1f77bcf86cd799439011",
"displayName": "Jane Smith",
"username": "janesmith",
"image": "https://cdn.example.com/images/jane.jpg",
"social_medias": {"github": "https://github.com/janesmith"
}
}
],
"category": {"_id": "507f1f77bcf86cd799439022",
"name": "Development",
"slug": "development"
},
"sponsored": false,
"name": "React.js Trail",
"slug": "reactjs",
"code": "d9428888-122b-11e1-b85c-61cd3cbed44a",
"start_period": "2026-03-01T00:00:00.000Z",
"end_period": "2026-06-01T00:00:00.000Z",
"tags": ["reactjs",
"frontend",
"javascript"
],
"keywords": ["react",
"web development"
],
"meta_tags": ["react course",
"learn react"
],
"meta_description": "Learn React.js from scratch with hands-on projects",
"short_summary": "A hands-on React.js learning trail",
"description": "This trail covers React.js fundamentals, hooks, state management, and more.",
"sub_name": "From Zero to Hero",
"type": "remote",
"level": "beginner",
"frequency": "weekly",
"ico": "fa-react",
"color": "#61DAFB",
"cover_image": {"url": "https://cdn.example.com/images/react-trail.jpg"
},
"gallery": [ ],
"cover_video": {"id": "12345678",
"url": "https://www.youtube.com/watch?v=dQw4w9WgXcQ",
"source": "youtube"
},
"languages": [{"ico": "flag-br",
"name": "Portuguese",
"code": "pt-BR",
"description": "Brazilian Portuguese"
}
],
"additional_information": "All materials are provided in Portuguese and English.",
"differentials": [{"ico": "fa-check",
"item": "Hands-on projects"
}
],
"highlights": [{"ico": "fa-star",
"name": "Industry Expert Mentors",
"description": "Learn from senior developers",
"picture": "https://cdn.example.com/images/highlight.jpg"
}
],
"requirements": [{"ico": "fa-laptop",
"item": "Computer with internet access",
"description": "A laptop or desktop with stable internet connection",
"picture": null
}
],
"other_requirements": "Basic knowledge of HTML and CSS",
"includes": [{"ico": "fa-certificate",
"name": "Certificate of Completion",
"description": "Digital certificate upon course completion"
}
],
"order": 1,
"expected_duration": 40,
"duration": {"duration_type": "hours",
"duration": 40
},
"meeting_point": {"complete_address": "Av. Paulista, 1578 - Bela Vista, Sao Paulo",
"reference": "Near MASP",
"lat_lng": [-23.5614,
-46.6558
],
"google_map_url": "https://maps.google.com/?q=-23.5614,-46.6558"
},
"prices": [{"currency": "BRL",
"amount": 99.9,
"description": "per_person"
}
],
"free": true,
"public": true,
"availability": "sometimes",
"active": "published",
"configuration": {"need_id_document": false,
"need_github": true,
"need_linkedin": false,
"type_reservation": "individually",
"min_persons": 1,
"max_persons": 1,
"available": 50,
"rate": {"description": "Platform rate",
"percentage": 10
},
"month_availability": 3,
"has_installments": true,
"min_amount_installment_payment": 30,
"max_installments": 12
},
"created": "2026-01-15T10:30:00.000Z",
"update_date": "2026-02-10T14:20:00.000Z",
"has_wish_list": false,
"average_rating": 4.5,
"favorite": false,
"related_trails": [ ],
"related_articles": [ ],
"views": 1250
}

Find By Id

Handle GET crud/:id.

path Parameters

id

required

string

header Parameters

x-workspace-id	any Workspace identifier to scope the request to a specific company workspace
x-subaccount-id	any Subaccount identifier for multi-tenant operations within a workspace
x-language	any Preferred language for response content (e.g. "pt", "en", "es")

Responses

Response samples

200

Content type

application/json

{"_id": "507f1f77bcf86cd799439044",
"authors": [{"_id": "507f1f77bcf86cd799439011",
"displayName": "Jane Smith",
"username": "janesmith"
}
],
"partners": [{"_id": "507f1f77bcf86cd799439033",
"company_name": "Coodesh",
"slug": "coodesh"
}
],
"mentors": [{"_id": "507f1f77bcf86cd799439011",
"displayName": "Jane Smith",
"username": "janesmith"
}
],
"category": {"_id": "507f1f77bcf86cd799439022",
"name": "Development",
"slug": "development"
},
"sponsored": false,
"name": "React.js Trail",
"slug": "reactjs",
"code": "d9428888-122b-11e1-b85c-61cd3cbed44a",
"start_period": "2026-03-01T00:00:00.000Z",
"end_period": "2026-06-01T00:00:00.000Z",
"tags": ["reactjs",
"frontend",
"javascript"
],
"keywords": ["react",
"web development"
],
"meta_tags": ["react course",
"learn react"
],
"meta_description": "Learn React.js from scratch with hands-on projects",
"short_summary": "A hands-on React.js learning trail",
"description": "This trail covers React.js fundamentals, hooks, state management, and more.",
"sub_name": "From Zero to Hero",
"type": "remote",
"level": "beginner",
"frequency": "weekly",
"ico": "fa-react",
"color": "#61DAFB",
"cover_image": {"url": "https://cdn.example.com/images/react-trail.jpg"
},
"gallery": [ ],
"cover_video": {"id": "12345678",
"url": "https://www.youtube.com/watch?v=dQw4w9WgXcQ",
"source": "youtube"
},
"languages": [{"ico": "flag-br",
"name": "Portuguese",
"code": "pt-BR",
"description": "Brazilian Portuguese"
}
],
"additional_information": "All materials are provided in Portuguese and English.",
"differentials": [{"ico": "fa-check",
"item": "Hands-on projects"
}
],
"highlights": [{"ico": "fa-star",
"name": "Industry Expert Mentors",
"description": "Learn from senior developers",
"picture": "https://cdn.example.com/images/highlight.jpg"
}
],
"requirements": [{"ico": "fa-laptop",
"item": "Computer with internet access",
"description": "A laptop or desktop with stable internet connection",
"picture": null
}
],
"other_requirements": "Basic knowledge of HTML and CSS",
"includes": [{"ico": "fa-certificate",
"name": "Certificate of Completion",
"description": "Digital certificate upon course completion"
}
],
"order": 1,
"expected_duration": 40,
"duration": {"duration_type": "hours",
"duration": 40
},
"meeting_point": {"complete_address": "Av. Paulista, 1578 - Bela Vista, Sao Paulo",
"reference": "Near MASP",
"lat_lng": [-23.5614,
-46.6558
],
"google_map_url": "https://maps.google.com/?q=-23.5614,-46.6558"
},
"prices": [{"currency": "BRL",
"amount": 99.9,
"description": "per_person"
}
],
"free": true,
"public": true,
"availability": "sometimes",
"active": "published",
"configuration": {"need_id_document": false,
"need_github": true,
"need_linkedin": false,
"type_reservation": "individually",
"min_persons": 1,
"max_persons": 1,
"available": 50,
"rate": {"description": "Platform rate",
"percentage": 10
},
"month_availability": 3,
"has_installments": true,
"min_amount_installment_payment": 30,
"max_installments": 12
},
"created": "2026-01-15T10:30:00.000Z",
"update_date": "2026-02-10T14:20:00.000Z",
"has_wish_list": false,
"average_rating": 4.5,
"favorite": false,
"related_trails": [ ],
"related_articles": [ ],
"views": 1250
}

Create Enroll

Handle POST home/enroll/:trailId.

path Parameters

trailId

required

string

header Parameters

x-workspace-id	any Workspace identifier to scope the request to a specific company workspace
x-subaccount-id	any Subaccount identifier for multi-tenant operations within a workspace
x-language	any Preferred language for response content (e.g. "pt", "en", "es")

Request Body schema: application/json
required

email required	string Email address of the enrollee
displayName required	string Display name of the enrollee

Responses

Request samples

Payload

Content type

application/json

{"email": "user@example.com",
"displayName": "John Doe"
}

Assessments > Exports

Export assessments CSV

Exports assessment results as CSV and can optionally include action plans and integrity files. Supports filtering by assessment ids, company ids, and date range.

Authorizations:

x-api-key

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/json
required

include_expired_participations	boolean
include_pending_participations	boolean
include_actions_plans	boolean
include_integrity	boolean
startDate	string
endDate	string
ids	Array of strings Filter by assessment ids
companies	Array of strings Filter by company ids (used outside workspace scope)

Responses

Request samples

Payload

Content type

application/json

{"include_expired_participations": false,
"include_pending_participations": true,
"include_actions_plans": true,
"include_integrity": true,
"startDate": "2026-01-01",
"endDate": "2026-01-31",
"ids": ["65f8c2f739ee2f2c21ff9c10",
"65f8c2f739ee2f2c21ff9c11"
],
"companies": ["65f8c2f739ee2f2c21ff9d20"
]
}

Response samples

200

Content type

application/json

[{"filename": "export.csv",
"data": "id;name;status"
}
]

Assessments > Bulk Actions

Delete assessments

Authorizations:

x-api-key

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/json
required

ids

required

Array of objects (ObjectId)

Array of ids

Responses

Request samples

Payload

Content type

application/json

{"ids": [{ }
]
}

Bulk delete assessment attempts

Company admins can delete only owned attempts.

Authorizations:

x-api-key

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/json
required

ids

required

Array of strings

Array of assessment attempt IDs to delete

Responses

Request samples

Payload

Content type

application/json

{"ids": ["507f1f77bcf86cd799439011",
"507f191e810c19729de860ea"
]
}

Send invite to participants

Send invite to participants by assessment id. The attempts had been created before, using CreateAssessmentAttempts endpoint.

Authorizations:

x-api-key

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/json
required

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

Content type

application/json

{"ids": ["62b384d70309831f9c13c87d",
"62b5faff5a80481c2cba4669"
],
"send_at": "2019-08-24T14:15:22Z"
}

Bulk unlock assessment attempts

Unlocks multiple assessment attempts at once, verifying credit balances and permissions for each attempt.

Authorizations:

x-api-key

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/json
required

ids

required

Array of strings (Assessment attempt ids)

Responses

Request samples

Payload

Content type

application/json

{"ids": ["string"
]
}

Response samples

201

Content type

application/json

{ }

Bulk recalculate assessment attempt scores

Recalculates scores for finished or blocked assessment attempts by their IDs or assessment IDs.

Authorizations:

x-api-key

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/json
required

ids

required

Array of strings (Assessment attempt ids)

Responses

Request samples

Payload

Content type

application/json

{"ids": ["string"
]
}

Reopen attempts

Reopens closed assessment attempts in bulk so participants can continue.

Authorizations:

x-api-key

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/json
required

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

Content type

application/json

{"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

Sends hidden assessment results to participants for multiple attempts.

Authorizations:

x-api-key

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/json
required

ids

required

Array of strings (Assessment attempt ids) non-empty

List of assessment attempt ids to send results

Responses

Request samples

Payload

Content type

application/json

{"ids": ["507f1f77bcf86cd799439011",
"507f191e810c19729de860ea"
]
}

Bulk update assessment attempts

Company admins can update only owned attempts.

Authorizations:

x-api-key

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/json
required

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

Content type

application/json

{"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
}

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:

x-api-key

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/json
required

ids

required

Array of strings (User ids)

Responses

Request samples

Payload

Content type

application/json

{"ids": ["string"
]
}

Cancel scheduled attempts

Cancels scheduled assessment attempts in bulk and reverts them to draft status.

Authorizations:

x-api-key

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/json
required

ids

required

Array of strings (Assessment attempt ids)

Responses

Request samples

Payload

Content type

application/json

{"ids": ["string"
]
}

Schedule open dates for attempts in bulk

Distributes custom_time_open dates across 30-minute slots for attempts of given assessments, limiting to a configurable batch size per slot (default 30, resulting in 60 results per hour). Only schedules attempts that do not already have a custom_time_open set.

Authorizations:

x-api-key

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/json
required

assessment_ids required	Array of strings <= 50 items Assessment IDs to schedule open dates for their attempts
start_at	string <date-time> (Start date) Date/time to start scheduling from. Defaults to now if not provided.
batch_size	number (Batch size) [ 1 .. 100 ] Default: 30 Number of attempts per 30-minute slot (default: 30, resulting in 60/hour)

Responses

Request samples

Payload

Content type

application/json

{"assessment_ids": ["62b384d70309831f9c13c87d",
"62b5faff5a80481c2cba4669"
],
"start_at": "2019-08-24T14:15:22Z",
"batch_size": 30
}

Bulk move answers to pending review

Used on dashboard to move finished answers back to pending review status

Authorizations:

x-api-key

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/json
required

ids

required

Array of strings non-empty

Array of assessment answer IDs to move to pending review

Responses

Request samples

Payload

Content type

application/json

{"ids": ["19dbdf0e56e00123456789ab"
]
}

Delete multiple action plans

Deletes multiple action plans from the workspace library.

Authorizations:

x-api-key

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 attach action plans to a question

Attaches multiple action plans to a specific assessment question by their IDs. Validates the question exists and belongs to the current workspace before attaching.

Authorizations:

x-api-key

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/json
required

ids

required

Array of objects (ObjectId)

Array of ids

Responses

Request samples

Payload

Content type

application/json

{"ids": [{ }
]
}

Unattach multiple action plans from question

Detaches multiple action plans from the specified assessment question.

Authorizations:

x-api-key

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/json
required

ids

required

Array of objects (ObjectId)

Array of ids

Responses

Request samples

Payload

Content type

application/json

{"ids": [{ }
]
}

Assessments > Media

Upload media attachments

Uploads one or more media files as attachments to an assessment, with size limits based on file type.

Authorizations:

x-api-key

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

Delete media attachment

Deletes a specific media attachment from an assessment by its storage path.

Authorizations:

x-api-key

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

Upload proctoring snapshot

Uploads a webcam snapshot image for proctoring during an active assessment attempt.

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

Upload proctoring audio recording

Uploads an audio recording file for proctoring during an active assessment attempt.

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

Upload proctoring session recording

Uploads session replay events as a JSON file for proctoring during an assessment attempt.

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

Upload proctoring media

Uploads a proctoring snapshot photo for a given assessment answer and records a tracking event.

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

Upload video presentation

Uploads a video or audio presentation file for an assessment answer, supporting both single and multipart uploads.

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/json
required

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

Content type

application/json

{"isLast": false,
"recordId": "string",
"partNumber": 0,
"totalChunks": 0
}

Response samples

201

Content type

application/json

{ }

Delete video presentation

Deletes the uploaded video or audio presentation recording from an assessment answer.

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

Upload a media attachment

Uploads a media file (audio, video, document, or whiteboard) for a question-type assessment answer. Supports both single and multipart uploads for large files. Only the answer owner can upload.

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/json
required

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

Content type

application/json

{"isLast": false,
"recordId": "string",
"partNumber": 0,
"totalChunks": 0
}

Response samples

201

Content type

application/json

{ }

Delete a media attachment

Deletes a previously uploaded audio or video recording for a question-type assessment answer. Only the answer owner can delete. Clears the stored answer URL.

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

Upload media attachments for a question

Uploads one or more media files (images, audio, video, documents) as attachments to the specified assessment question. Enforces per-type file size limits and a maximum of 15 attachments per question.

Authorizations:

x-api-key

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

Delete a media attachment from a question

Removes a specific media attachment from storage and from the assessment question attachments list, identified by the file path in the request body.

Authorizations:

x-api-key

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

Download soft skill PDF report by ID

Generates or retrieves the PDF report for a finished soft skill assessment answer and returns a signed download URL.

Authorizations:

x-api-key

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

Users

Company Contact

Submits a company contact/demo request form.

header Parameters

x-workspace-id	any Workspace identifier to scope the request to a specific company workspace
x-subaccount-id	any Subaccount identifier for multi-tenant operations within a workspace
x-language	any Preferred language for response content (e.g. "pt", "en", "es")

Request Body schema: application/json
required

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

Content type

application/json

{"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"
}

SyncProfileToAnalysisResponsesController_handle

Authorizations:

x-api-key

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

List employees

Returns paginated workspace users with support for search, status, and JSONLogic query filters.

Authorizations:

x-api-key

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
permissions	Array of strings Filter users by permissions (all must match)

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

Content type

application/json

{"docs": [{"_id": "6501d432afe2730012f74d68",
"displayName": "John Doe",
"email": "john.doe@example.com",
"image": "https://example.com/image.png",
"roles": ["user"
],
"status": "active",
"created": "2019-08-24T14:15:22Z",
"last_login": "2019-08-24T14:15:22Z",
"last_authenticated_at": "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
}

Create employees

Creates one or more users in the active workspace and returns invitation links for the created users.

Authorizations:

x-api-key

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/json
required

required

Array of objects (CreateWorkspaceUserDto) non-empty

List of users to add to workspace

Responses

Request samples

Payload

Content type

application/json

{"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

Content type

application/json

[{"_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"
}
]

Remove employees

Removes multiple users from the active workspace and can optionally delete accounts.

Authorizations:

x-api-key

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/json
required

Bulk remove employees

required

Array of objects (RemoveEmployeeItemDto) non-empty

List of users to remove

Responses

Request samples

Payload

Content type

application/json

{"users": [{"id": "61b8e9bb2300e80010c0bcc2",
"deleteAccount": false
}
]
}

Get employee

Returns detailed information about a specific workspace user by id.

Authorizations:

x-api-key

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

Content type

application/json

{"_id": "6501d432afe2730012f74d68",
"displayName": "John Doe",
"email": "john.doe@example.com",
"roles": "user",
"image": "https://example.com/image.png",
"status": "active",
"created": "2019-08-24T14:15:22Z",
"last_login": "2019-08-24T14:15:22Z",
"last_authenticated_at": "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"
]
]
}

Update employee

Updates a specific workspace user by id, including role and status changes.

Authorizations:

x-api-key

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/json
required

displayName required	string <= 50 characters User name
email required	string <email> User email
roles required	string Default: "user" Enum: "user" "admin" "hunter" "manager" "business" 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" "list_briefings" "manage_briefings" "create_jobs_from_briefings" "view_talent_data" "delete_others_briefings" 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

Content type

application/json

{"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"
]
}

Remove employee

Removes a specific user from the active workspace and can optionally delete the account.

Authorizations:

x-api-key

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/json
required

Payload with delete flag

deleteAccount

boolean

Default: false

If true, also soft-delete the user account

Responses

Request samples

Payload

Content type

application/json

{"deleteAccount": false
}

List subaccounts

Returns paginated subaccounts for the active workspace with optional search and id filters.

Authorizations:

x-api-key

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

Content type

application/json

{"docs": [{"_id": "6501d432afe2730012f74d68",
"name": "Engineering Team",
"users_count": 15,
"users": [{"_id": "6501d432afe2730012f74d68",
"displayName": "John Doe",
"image": "https://example.com/image.png"
}
],
"created": "2019-08-24T14:15:22Z"
}
],
"totalDocs": 50,
"limit": 10,
"totalPages": 5,
"page": 1,
"pagingCounter": 1,
"hasPrevPage": false,
"hasNextPage": true,
"prevPage": null,
"nextPage": 2
}

Create subaccount

Creates a subaccount under the active workspace company and returns the created subaccount details.

Authorizations:

x-api-key

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/json
required

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

Content type

application/json

{"name": "Team A",
"department": "string",
"region": "string",
"user_ids": ["string"
]
}

Get subaccount

Returns details for a specific subaccount of the active workspace.

Authorizations:

x-api-key

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

Content type

application/json

{"_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",
"image": "https://example.com/image.png"
}
]
}

Update a subaccount

Updates a subaccount and returns a JSON object with a redirect_to property.

Authorizations:

x-api-key

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/json
required

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

Content type

application/json

{"name": "Team A",
"department": "string",
"region": "string",
"user_ids": ["string"
]
}

Response samples

200

Content type

application/json

{"redirect_to": "/assessments/workspace/subaccounts/123"
}

Remove subaccount

Removes a subaccount from the active workspace company by subaccount id.

Authorizations:

x-api-key

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

Get subaccount stats

Returns aggregate statistics for a specific subaccount in the active workspace.

Authorizations:

x-api-key

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

Content type

application/json

{"assessments_count": 12,
"questions_count": 50,
"scorecards_count": 5,
"skill_variants_count": 30,
"teams_count": 3,
"careers_count": 8,
"users_count": 25
}

List subaccounts options

Returns a paginated subaccount list optimized for selectors, with optional search and id filters.

Authorizations:

x-api-key

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

Content type

application/json

{"docs": [{"_id": "6501d432afe2730012f74d68",
"name": "Engineering Team"
}
],
"totalDocs": 50,
"totalPages": 5,
"page": 1,
"pageSize": 10
}

List user teams

Returns a paginated list of teams associated with a specific user.

Authorizations:

x-api-key

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

Content type

application/json

{"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
}

List credits history

Returns paginated workspace credits history with ordering and JSONLogic filters.

Authorizations:

x-api-key

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

Content type

application/json

{"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
}

Get credits stats

Returns aggregated credits statistics for the active workspace.

Authorizations:

x-api-key

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

Content type

application/json

{"total": 500,
"totalDocs": 25,
"hard_skills": {"balance": 100,
"status": "sufficient"
},
"soft_skills": {"balance": 100,
"status": "sufficient"
},
"usage": 150,
"updated": "2019-08-24T14:15:22Z"
}

List credits fields

Returns available credits actions and types with translated labels for filtering credits history.

Authorizations:

x-api-key

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

Content type

application/json

{"action": [{"value": "credits",
"label": "Credits"
},
{"value": "unlock",
"label": "Unlock"
}
],
"type": [{"value": "hard_skills",
"label": "Hard Skills"
},
{"value": "soft_skills",
"label": "Soft Skills"
}
]
}

List credits authors

Returns authors that appear in workspace credits history, with optional search.

Authorizations:

x-api-key

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

Content type

application/json

{"docs": [{"value": "6501d432afe2730012f74d68",
"label": "John Doe"
}
],
"totalDocs": 20,
"limit": 10,
"totalPages": 2,
"page": 1,
"pagingCounter": 1,
"hasPrevPage": false,
"hasNextPage": true,
"prevPage": null,
"nextPage": 2
}

Export credits CSV

Exports workspace credits history as CSV and supports filtering by date range and action type.

Authorizations:

x-api-key

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/json
required

startDate	string
endDate	string
action	string Filter by credits history action key

Responses

Request samples

Payload

Content type

application/json

{"startDate": "2026-01-01",
"endDate": "2026-01-31",
"action": "credits_consumed"
}

Response samples

200

Content type

application/json

[{"filename": "export.csv",
"data": "id;name;status"
}
]

Get employees stats

Returns aggregate statistics about users in the active workspace.

Authorizations:

x-api-key

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

Content type

application/json

{"total": 42,
"users_count": 35,
"admins_count": 7
}

List users export

Returns a paginated list of workspace users for export flows, with support for search, status, and JSONLogic query filters.

Authorizations:

x-api-key

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

Content type

application/json

{"docs": [{"user": "6501d432afe2730012f74d68",
"email": "user@example.com",
"name": "John Doe",
"completeness_index": 0.85,
"status": "active",
"linkedin": true,
"onboarding": true,
"linkedin_url": "https://www.linkedin.com/in/johndoe",
"last_interaction": "2025-01-15T10:30:00.000Z",
"last_login": "2025-01-15T10:30:00.000Z",
"last_authenticated_at": "2025-01-15T10:30:00.000Z",
"skill_map": "2025-01-15T10:30:00.000Z",
"certification": true,
"skills": "JavaScript, Python, React",
"position_name": "Software Engineer",
"track_name": "Engineering"
}
],
"totalDocs": 25,
"limit": 10,
"page": 1,
"totalPages": 3,
"pagingCounter": 1,
"hasPrevPage": false,
"hasNextPage": true,
"prevPage": null,
"nextPage": 2
}

Export users CSV

Exports workspace users as a CSV file using the provided search, status, and JSONLogic query filters.

Authorizations:

x-api-key

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/json
required

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

Content type

application/json

{"query": "eyJhbmQiOlt7ImluIjpbeyJ2YXIiOiJzdGF0dXMifSxbImFjdGl2ZSIsInBlbmRpbmciXV19LHsib3IiOlt7ImluIjpbeyJ2YXIiOiJyb2xlcyJ9LFsibWFuYWdlciJdXX0seyI9PSI6W3sidmFyIjoib25ib2FyZGluZyJ9LHRydWVdfV19XX0=",
"search": "john",
"status": "active",
"startDate": "2024-01-01",
"endDate": "2024-01-31"
}

Response samples

200

Content type

application/json

[{"filename": "export.csv",
"data": "id;name;status"
}
]

Get user profile

Returns the profile view for a specific workspace user by id.

Authorizations:

x-api-key

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

Content type

application/json

{"_id": "6501d432afe2730012f74d68",
"displayName": "John Doe",
"email": "john.doe@example.com",
"status": "active",
"roles": ["user"
],
"image": "https://example.com/image.png",
"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",
"last_authenticated_at": "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"
}

Find skills for a user

Returns the list of skills associated with the specified user within the current workspace. Accessible by all authenticated workspace roles.

Authorizations:

x-api-key

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

Content type

application/json

{"skills": [{"_id": "6501d432afe2730012f74d68",
"skill_variant": "6501d432afe2730012f74d69",
"skill": {"_id": "6501d432afe2730012f74d68",
"name": "React",
"description": "A JavaScript library for building UI",
"level": 3
}
}
]
}

Careers

Operations related to careers, teams, and positions

List teams

Returns a paginated list of teams with optional filtering by status, author, and search query.

Authorizations:

x-api-key

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=en - locale=pt - locale=es - 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

Content type

application/json

{"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",
"image": "https://example.com/image.png"
},
"users": [{"_id": "6501d432afe2730012f74d68",
"displayName": "John Doe",
"image": "https://example.com/image.png"
}
],
"users_count": 25,
"owners": [{"_id": "6501d432afe2730012f74d68",
"displayName": "John Doe",
"image": "https://example.com/image.png"
}
]
}
],
"totalDocs": 50,
"limit": 10,
"totalPages": 5,
"page": 1,
"pagingCounter": 1,
"hasPrevPage": false,
"hasNextPage": true,
"prevPage": null,
"nextPage": 2
}

Create a new career team

Creates a new career team for the current workspace.

Authorizations:

x-api-key

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/json
required

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

Content type

application/json

{"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

Deletes multiple career teams by their identifiers.

Authorizations:

x-api-key

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/json
required

ids

required

Array of objects (ObjectId)

Array of ids

Responses

Request samples

Payload

Content type

application/json

{"ids": [{ }
]
}

Archive a team

Moves the specified team to archived status by its ID.

Authorizations:

x-api-key

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

Unarchive a team

Restores a previously archived team back to published status.

Authorizations:

x-api-key

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

Duplicate a team

Creates a copy of the specified team with new field values.

Authorizations:

x-api-key

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/json
required

name required	string
description required	string

Responses

Request samples

Payload

Content type

application/json

{"name": "string",
"description": "string"
}

List team authors

Returns the list of authors who have created teams in the workspace.

Authorizations:

x-api-key

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

Content type

application/json

[{"value": "6501d432afe2730012f74d68",
"label": "John Doe"
}
]

Get career statistics

Returns aggregated statistics including total teams, people, and tracks counts.

Authorizations:

x-api-key

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

Content type

application/json

{"teams": 10,
"people": 150,
"tracks": 25
}

Get career field definitions

Returns the available field definitions such as team status options.

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 a team by ID

Returns the details of a specific team identified by its ID.

Authorizations:

x-api-key

path Parameters

id

required

string

Example: 1661452472991

query Parameters

locale

string

Examples:

locale=en -
locale=pt -
locale=es -

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

Content type

application/json

{"_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"
]
}

Update a team

Updates the details of a specific team by its ID.

Authorizations:

x-api-key

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/json
required

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

Content type

application/json

{"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

Translates career name and description for the specified team.

Authorizations:

x-api-key

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/json
required

targetLocales

required

Array of strings non-empty

Target language codes for translation (e.g. ["en","pt"]).

Responses

Request samples

Payload

Content type

application/json

{"targetLocales": ["string"
]
}

Translate track name and description

Translates track name and description for the specified team track.

Authorizations:

x-api-key

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/json
required

targetLocales

required

Array of strings non-empty

Target language codes for translation (e.g. ["en","pt"]).

Responses

Request samples

Payload

Content type

application/json

{"targetLocales": ["string"
]
}

Translate position label and description

Translates position label and description for the specified team position.

Authorizations:

x-api-key

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/json
required

targetLocales

required

Array of strings non-empty

Target language codes for translation (e.g. ["en","pt"]).

Responses

Request samples

Payload

Content type

application/json

{"targetLocales": ["string"
]
}

Translate category name and description

Translates category name and description for the specified team category.

Authorizations:

x-api-key

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/json
required

targetLocales

required

Array of strings non-empty

Target language codes for translation (e.g. ["en","pt"]).

Responses

Request samples

Payload

Content type

application/json

{"targetLocales": ["string"
]
}

Get a team view

Returns the full view of a team including tracks, positions, and categories.

Authorizations:

x-api-key

path Parameters

id

required

string

Example: 1661452472991

query Parameters

locale

string

Examples:

locale=en -
locale=pt -
locale=es -

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

Content type

application/json

{"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,
"hiring_link": "https://careers.example.com/apply",
"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",
"image": "https://example.com/image.png",
"position": "6501d432afe2730012f74d68"
}
]
}

Get team positions tree

Returns a hierarchical tree of teams with their tracks and positions.

Authorizations:

x-api-key

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

Content type

application/json

{"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"
}
]
}
]
}

Update element ordering

Updates the display order of positions, categories, or tracks within a team.

Authorizations:

x-api-key

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/json
required

kind	string Enum: "position" "team" "category"
	Array of objects

Responses

Request samples

Payload

Content type

application/json

{"kind": "category",
"ordering": [{"_id": "61b8e9bb2300e80010c0bcc2",
"order": 1
}
]
}

List users assigned to a position

Returns a paginated list of users assigned to a specific position within a team.

Authorizations:

x-api-key

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

Content type

application/json

{"docs": [{"_id": "6501d432afe2730012f74d68",
"displayName": "John Doe",
"email": "john.doe@example.com",
"image": "https://example.com/image.png"
}
],
"totalDocs": 50,
"limit": 10,
"totalPages": 5,
"page": 1,
"pagingCounter": 1,
"hasPrevPage": false,
"hasNextPage": true,
"prevPage": null,
"nextPage": 2
}

Update position users

Updates the list of users assigned to a specific position within a team.

Authorizations:

x-api-key

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/json
required

ids	Array of objects (ObjectId) Array of ids
users	object user for has bean created and invited
mode	string Default: "move" Enum: "add" "move" Assignment mode: add keeps existing positions, move removes from others

Responses

Request samples

Payload

Content type

application/json

{"ids": [{ }
],
"users": { },
"mode": "add"
}

Remove users from a specific position

Removes selected users from a specific position without affecting their other positions.

Authorizations:

x-api-key

path Parameters

id required	string Example: 61b8e9bb2300e80010c0bcc2
positionId required	string Example: 61b8e9bb2300e80010c0bcc3

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/json
required

ids

required

Array of objects (ObjectId)

Array of ids

Responses

Request samples

Payload

Content type

application/json

{"ids": [{ }
]
}

List team members

Returns a paginated list of users (people) assigned to a team with optional search and position filtering.

Authorizations:

x-api-key

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

Content type

application/json

{"docs": [{"_id": "6501d432afe2730012f74d68",
"displayName": "John Doe",
"email": "john.doe@example.com",
"image": "https://example.com/image.png",
"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
}

Get a team member

Returns the details of a specific user (person) within a team.

Authorizations:

x-api-key

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

Content type

application/json

{"_id": "6501d432afe2730012f74d68",
"displayName": "John Doe",
"email": "john.doe@example.com",
"image": "https://example.com/image.png",
"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

Removes selected users from a career team.

Authorizations:

x-api-key

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/json
required

ids

required

Array of objects (ObjectId)

Array of ids

Responses

Request samples

Payload

Content type

application/json

{"ids": [{ }
]
}

Manage user positions

Atomically add and/or remove a user from multiple positions in a career.

Authorizations:

x-api-key

path Parameters

id required	string Example: 61b8e9bb2300e80010c0bcc2
userId required	string Example: 61b8e9bb2300e80010c0bcc3

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/json
required

add	Array of objects (ObjectId) Position IDs to add the user to
remove	Array of objects (ObjectId) Position IDs to remove the user from

Responses

Request samples

Payload

Content type

application/json

{"add": [{ }
],
"remove": [{ }
]
}

Get user positions across all careers

Returns all positions a user is assigned to across all careers in the workspace.

Authorizations:

x-api-key

path Parameters

userId

required

string

Example: 61b8e9bb2300e80010c0bcc3

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

Create a track for a career team

Creates a track under the specified career team.

Authorizations:

x-api-key

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/json
required

required	object Translated content for track
assessment_id required	object Assessment id

Responses

Request samples

Payload

Content type

application/json

{"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

Deletes selected team tracks and their related references.

Authorizations:

x-api-key

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/json
required

ids

required

Array of objects (ObjectId)

Array of ids

Responses

Request samples

Payload

Content type

application/json

{"ids": [{ }
]
}

Get a team track

Returns the details of a specific track within a team.

Authorizations:

x-api-key

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

Content type

application/json

{"_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"
]
}

Update a team track

Updates a specific track within a team by its ID.

Authorizations:

x-api-key

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/json
required

required	object Translated content for track
assessment_id required	object Assessment id
_id required	object Track id

Responses

Request samples

Payload

Content type

application/json

{"translated_content": {"pt": {"name": "string",
"description": "string"
},
"en": {"name": "string",
"description": "string"
},
"es": {"name": "string",
"description": "string"
}
},
"assessment_id": { },
"_id": { }
}

Archive a track

Archives a track and all its positions within a career.

Authorizations:

x-api-key

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

Responses

Unarchive a track

Restores a previously archived track and all its positions within a career.

Authorizations:

x-api-key

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

Responses

Create a position for a career team track

Creates a position for the specified career team track.

Authorizations:

x-api-key

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/json
required

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

Content type

application/json

{"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

Deletes selected positions from team tracks and related data.

Authorizations:

x-api-key

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/json
required

ids

required

Array of objects (ObjectId)

Array of ids

Responses

Request samples

Payload

Content type

application/json

{"ids": [{ }
]
}

Get a track position

Returns the details of a specific position within a team, including its skills.

Authorizations:

x-api-key

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

Content type

application/json

{"position": {"_id": "6501d432afe2730012f74d68",
"name": "Senior Developer",
"label": "Sr. Dev",
"description": "Lead technical initiatives",
"translated_content": { },
"order": 1,
"track": "6501d432afe2730012f74d68",
"hiring_link": "https://careers.example.com/apply",
"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": { }
}
}
]
}
}

Update a track position

Updates a specific position within a team, optionally attaching new skills.

Authorizations:

x-api-key

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/json
required

_id required	object Team ID
seniority_level	number >= 1 Seniority level
vertical_level	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

Content type

application/json

{"_id": "62b384d70309831f9c13c87d",
"seniority_level": 3,
"vertical_level": 1,
"label": "Position 1 label",
"hiring_link": "https://hiring-link.com",
"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"
}
]
}

Archive a position

Archives a single position within a track.

Authorizations:

x-api-key

path Parameters

id required	string
trackId required	string
positionId 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

Unarchive a position

Restores a previously archived position within a track.

Authorizations:

x-api-key

path Parameters

id required	string
trackId required	string
positionId 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

Create a category for a career team

Creates a category under the specified career team.

Authorizations:

x-api-key

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/json
required

required

object

Translated content for category

Responses

Request samples

Payload

Content type

application/json

{"translated_content": {"pt": {"name": "string",
"description": "string"
},
"en": {"name": "string",
"description": "string"
},
"es": {"name": "string",
"description": "string"
}
}
}

Delete team category and related data

Deletes selected categories from a team and removes related references.

Authorizations:

x-api-key

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/json
required

ids

required

Array of objects (ObjectId)

Array of ids

Responses

Request samples

Payload

Content type

application/json

{"ids": [{ }
]
}

Get a team category

Returns the details of a specific category within a team.

Authorizations:

x-api-key

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

Content type

application/json

{"_id": "6501d432afe2730012f74d68",
"name": "Engineering",
"description": "Engineering department category",
"translated_content": {"pt": {"name": "Engenharia",
"description": "Categoria do departamento..."
}
},
"order": 1
}

Update a team category

Updates a specific category within a team by its ID.

Authorizations:

x-api-key

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/json
required

required	object Translated content for category
_id required	object Category id

Responses

Request samples

Payload

Content type

application/json

{"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:

x-api-key

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/json
required

ids

required

Array of objects (ObjectId)

Array of ids

Responses

Request samples

Payload

Content type

application/json

{"ids": [{ }
]
}

Remove skills from a category

Removes one or more skills from a team category.

Authorizations:

x-api-key

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/json
required

ids

required

Array of objects (ObjectId)

Array of ids

Responses

Request samples

Payload

Content type

application/json

{"ids": [{ }
]
}

Create a requirement for a career team

Creates a requirement entry for the specified career team.

Authorizations:

x-api-key

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/json
required

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

Content type

application/json

{"skill_variant": { },
"position": { },
"skill_level": 0,
"fill": true
}

Delete team requirements

Deletes selected requirement entries from a career team.

Authorizations:

x-api-key

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/json
required

ids

required

Array of objects (ObjectId)

Array of ids

Responses

Request samples

Payload

Content type

application/json

{"ids": [{ }
]
}

Update a requirement

Updates a specific requirement within a team by its ID.

Authorizations:

x-api-key

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/json
required

_id required	object Requirement id
skill_variant required	object Skill variant id
skill_level required	number Level id

Responses

Request samples

Payload

Content type

application/json

{"_id": { },
"skill_variant": { },
"skill_level": 0
}

Attach skill variants to a team

Attaches one or more skill variants to the specified team.

Authorizations:

x-api-key

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/json
required

Array

string

Responses

Request samples

Payload

Content type

application/json

["string"
]

Delete team skill and related data

Deletes selected team skills and their related references.

Authorizations:

x-api-key

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/json
required

ids

required

Array of objects (ObjectId)

Array of ids

Responses

Request samples

Payload

Content type

application/json

{"ids": [{ }
]
}

Get category skills tree

Returns a hierarchical tree of categories and their associated skills.

Authorizations:

x-api-key

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

Content type

application/json

{"categories": [{"_id": "6501d432afe2730012f74d68",
"name": "Programming Languages",
"skill_variants": [{"_id": "6501d432afe2730012f74d68",
"name": "JavaScript",
"level": "6501d432afe2730012f74d68",
"category": "6501d432afe2730012f74d68"
}
]
}
]
}

Update skill categories

This endpoint allows you to update the categories associated with a skill. Supports assigning a skill to multiple categories.

Authorizations:

x-api-key

path Parameters

id required	string Example: 61b8e9bb2300e80010c0bcc2
skillId 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/json
required

category_ids

required

Array of objects (ObjectId)

Array of category ids to assign to this skill

Responses

Request samples

Payload

Content type

application/json

{"category_ids": [{ }
]
}

Sync analysis plans for all teams in the workspace

Synchronizes analysis plans for every career team in the current workspace.

Authorizations:

x-api-key

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

List careers export

Returns a paginated list of careers for export, with support for author, status, grouping, search, locale, and JSONLogic query filters.

Authorizations:

x-api-key

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=en - locale=pt - locale=es - 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

Content type

application/json

{"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
}

Export careers CSV

Exports careers as CSV using the provided author, status, search, locale, and JSONLogic query filters.

Authorizations:

x-api-key

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/json
required

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

Content type

application/json

{"search": "engineering",
"query": "eyJhbmQiOlt7ImluIjpbeyJ2YXIiOiJzdGF0dXMifSxbInB1Ymxpc2hlZCJdXX0seyJpbiI6W3sidmFyIjoiYXV0aG9yIn0sWyI2NWY4YzJmNzM5ZWUyZjJjMjFmZjljMTAiXV19XX0=",
"author": ["65f8c2f739ee2f2c21ff9c10"
],
"status": ["published",
"archived"
],
"locale": "en"
}

Response samples

200

Content type

application/json

[{"filename": "export.csv",
"data": "id;name;status"
}
]

Export career skills CSV

Exports all skills from careers as CSV, with career, track, position, category, skill details, levels, and author info.

Authorizations:

x-api-key

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/json
required

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

Content type

application/json

{"search": "engineering",
"query": "eyJhbmQiOlt7ImluIjpbeyJ2YXIiOiJzdGF0dXMifSxbInB1Ymxpc2hlZCJdXX0seyJpbiI6W3sidmFyIjoiYXV0aG9yIn0sWyI2NWY4YzJmNzM5ZWUyZjJjMjFmZjljMTAiXV19XX0=",
"author": ["65f8c2f739ee2f2c21ff9c10"
],
"status": ["published",
"archived"
],
"locale": "en"
}

Response samples

200

Content type

application/json

[{"filename": "export.csv",
"data": "id;name;status"
}
]

Export people certificates CSV

Exports people from a team with their certifications as a CSV file.

Authorizations:

x-api-key

path Parameters

id

required

string

Team 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/json
required

locale

string

Locale override (e.g. en, pt, es)

Responses

Request samples

Payload

Content type

application/json

{"locale": "pt"
}

Response samples

200

Content type

application/json

[{"filename": "export.csv",
"data": "id;name;status"
}
]

Generate skills for career positions using AI

Uses AI to generate a comprehensive set of skills, categories, and requirements for the specified career positions. Supports "append" mode (merge with existing) or "replace" mode (clear and regenerate).

Authorizations:

x-api-key

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/json
required

positions	Array of strings Specific position IDs to generate skills for. If omitted, generates for all positions in the team.
mode required	string Enum: "append" "replace" Mode of operation: "append" merges with existing skills (skips duplicates), "replace" clears existing skills/requirements for target positions before applying new ones.

Responses

Request samples

Payload

Content type

application/json

{"positions": ["61b8e9bb2300e80010c0bcc2"
],
"mode": "append"
}

Generate skills for a single position using AI

Uses AI to generate skills, categories, and requirements for a specific position within a career. Supports "append" mode (merge with existing) or "replace" mode (clear and regenerate).

Authorizations:

x-api-key

path Parameters

id required	string Example: 61b8e9bb2300e80010c0bcc2 Career (team) ID
positionId required	string Example: 61b8e9bb2300e80010c0bcc3 Position ID within the career

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/json
required

mode

required

string

Enum: "append" "replace"

Mode of operation: "append" merges with existing skills (skips duplicates), "replace" clears existing skills/requirements for the position before applying new ones.

Responses

Request samples

Payload

Content type

application/json

{"mode": "append"
}

Generate career description using AI

Uses AI to generate a professional description for the specified career/team.

Authorizations:

x-api-key

path Parameters

id

required

string

Example: 61b8e9bb2300e80010c0bcc2

query Parameters

locale

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 track description using AI

Uses AI to generate a professional description for the specified track.

Authorizations:

x-api-key

path Parameters

id required	string
trackId required	string

query Parameters

locale

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 position description using AI

Uses AI to generate a professional description for the specified position.

Authorizations:

x-api-key

path Parameters

id required	string
positionId required	string

query Parameters

locale

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 category description using AI

Uses AI to generate a professional description for the specified category.

Authorizations:

x-api-key

path Parameters

id required	string
categoryId required	string

query Parameters

locale

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

Import careers from spreadsheet data

Imports career structures (teams, tracks, positions) from parsed spreadsheet data. Each row contains a career name, track name, and a list of positions in seniority order.

Authorizations:

x-api-key

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/json
required

required

Array of objects (ImportCareerRowDto) non-empty

Responses

Request samples

Payload

Content type

application/json

{"rows": [{"career": "Desenvolvimento",
"track": "Base",
"positions": ["Desenvolvedor I",
"Desenvolvedor II",
"Desenvolvedor III"
]
}
]
}

Import position descriptions

Updates position descriptions in existing careers. Each row contains career name, track name, position name, and description.

Authorizations:

x-api-key

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/json
required

required

Array of objects (ImportDescriptionRowDto) non-empty

Responses

Request samples

Payload

Content type

application/json

{"rows": [{"career": "Desenvolvimento",
"track": "Base",
"position": "Desenvolvedor I",
"description": "Responsável por desenvolver..."
}
]
}

Teams

Management of teams and their members within projects

FindAnalysisPlansController_handle

Authorizations:

x-api-key

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:

x-api-key

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:

x-api-key

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/json
required

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

Content type

application/json

{"company": "62b5faff5a80481c2cba4669",
"name": "Coodesh Analysis",
"questions": [{ }
],
"categories": "62b5faff5a80481c2cba4669",
"settings": {"invites_expiration": 120,
"invites_expiration_type": "relative",
"invites_expiration_fixed_date": "2019-08-24T14:15:22Z",
"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_id": { },
"color": "green"
}
],
"grade_tags_enabled": false,
"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:

x-api-key

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:

x-api-key

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:

x-api-key

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:

x-api-key

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/json
required

_id required	object ID
answers required	Array of objects non-empty List of answers

Responses

Request samples

Payload

Content type

application/json

{"_id": { },
"answers": [{ }
]
}

DeleteAnalysisResponseController_handle

Authorizations:

x-api-key

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:

x-api-key

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:

x-api-key

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/json
required

analyses required	Array of objects (ObjectId) Analysis ids to generate autologin links
analysis_plan required	object Analysis Plan

Responses

Request samples

Payload

Content type

application/json

{"analyses": ["62b384d70309831f9c13c87d",
"62b5faff5a80481c2cba4669"
],
"analysis_plan": "62b384d70309831f9c13c87d"
}

Generate analysis for employees

This endpoint can be used by admins to generate analysis for employees

Authorizations:

x-api-key

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/json
required

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

Content type

application/json

{"users": [{ }
],
"tracks": [{ }
],
"positions": [{ }
],
"team": { }
}

Response samples

201

Content type

application/json

[{ }
]

Generate analysis for employees on onboarding process

This endpoint can be used by developers to generate analysis for themselves

Authorizations:

x-api-key

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/json
required

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

Content type

application/json

{"users": [{ }
],
"tracks": [{ }
],
"positions": [{ }
],
"team": { }
}

FindSkillRadarController_handle

Authorizations:

x-api-key

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:

x-api-key

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:

x-api-key

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:

x-api-key

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

Get scorecard field definitions

Returns field definitions for scorecards including skill levels and email template variables.

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

FindRadarByTalentController_handle

Authorizations:

x-api-key

path Parameters

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

SyncProfileToAnalysisResponsesController_handle

Authorizations:

x-api-key

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

List workforce planning fields

Returns the available field definitions such as status options for workforce plannings.

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

Content type

application/json

{"status": [{"value": "draft",
"label": "Draft"
},
{"value": "published",
"label": "Published"
},
{"value": "archived",
"label": "Archived"
}
]
}

List workforce plannings

Returns a paginated list of workforce plannings with optional filtering by status, search term, and query.

Authorizations:

x-api-key

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

Content type

application/json

{"docs": [{"_id": "6501d432afe2730012f74d68",
"name": "Engineering Team Planning",
"description": "Planning for Q1 2024",
"people_count": 15,
"last_users": [{"_id": "6501d432afe2730012f74d68",
"displayName": "John Doe",
"image": "https://example.com/image.png"
}
],
"author": {"_id": "6501d432afe2730012f74d68",
"displayName": "Jane Smith",
"image": "https://example.com/image.png"
},
"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

Creates a new workforce planning entry.

Authorizations:

x-api-key

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/json
required

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

Content type

application/json

{"name": "string",
"customer": "string",
"description": "string",
"startDate": "string",
"endDate": "string",
"links": ["http://example.com"
],
"owners": ["62b384d70309831f9c13c87d",
"62b5faff5a80481c2cba4669"
],
"author": "62b5faff5a80481c2cba4669",
"subaccount_ids": ["62b384d70309831f9c13c87d",
"62b5faff5a80481c2cba4669"
],
"external_id": "string",
"tags": ["string"
]
}

Delete workforce plannings

Deletes multiple workforce planning records.

Authorizations:

x-api-key

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/json
required

ids

required

Array of objects (ObjectId)

Array of ids

Responses

Request samples

Payload

Content type

application/json

{"ids": [{ }
]
}

Find a workforce planning by ID

Returns the details of a single workforce planning identified by its ID.

Authorizations:

x-api-key

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

Content type

application/json

{"_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"
}

Update a workforce planning

Updates the details of an existing workforce planning by its ID.

Authorizations:

x-api-key

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/json
required

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

Content type

application/json

{"name": "string",
"customer": "string",
"description": "string",
"startDate": "string",
"endDate": "string",
"links": ["http://example.com"
],
"owners": ["62b384d70309831f9c13c87d",
"62b5faff5a80481c2cba4669"
],
"author": "62b5faff5a80481c2cba4669",
"subaccount_ids": ["62b384d70309831f9c13c87d",
"62b5faff5a80481c2cba4669"
],
"external_id": "string",
"tags": ["string"
],
"status": "draft"
}

Get workforce plannings statistics

Returns aggregated statistics for workforce plannings within the current workspace.

Authorizations:

x-api-key

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

Content type

application/json

{"metrics": {"teams": 10,
"leads": 5,
"belongs": 8,
"people_count": 150
},
"updated": "2019-08-24T14:15:22Z"
}

Archive a workforce planning

Changes the status of a workforce planning to archived by its ID.

Authorizations:

x-api-key

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

Unarchive a workforce planning

Restores an archived workforce planning back to published status by its ID.

Authorizations:

x-api-key

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

Duplicate a workforce planning

Creates a copy of an existing workforce planning by its ID.

Authorizations:

x-api-key

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/json
required

name required	string
description required	string

Responses

Request samples

Payload

Content type

application/json

{"name": "string",
"description": "string"
}

Find users by skills

Returns a paginated list of users matching the specified skill IDs and minimum match criteria.

Authorizations:

x-api-key

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

Content type

application/json

{"docs": [{"_id": "6501d432afe2730012f74d68",
"displayName": "John Doe",
"email": "john.doe@example.com",
"image": "https://example.com/image.png",
"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
}

Attach a skill to a workforce planning

Adds a skill to a workforce planning and recalculates the user distribution.

Authorizations:

x-api-key

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/json
required

skillId

string

Responses

Request samples

Payload

Content type

application/json

{"skillId": "61b8e9bb2300e80010c0bcc2"
}

Find users by workforce planning

Returns a paginated list of people assigned to a specific workforce planning.

Authorizations:

x-api-key

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

Content type

application/json

{"docs": [{"_id": "6501d432afe2730012f74d68",
"displayName": "John Doe",
"email": "john.doe@example.com",
"image": "https://example.com/image.png",
"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

Adds multiple users to the specified team.

Authorizations:

x-api-key

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/json
required

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

Content type

application/json

{"ids": [{ }
],
"ownerIds": [{ }
]
}

Update team users

Replaces the list of users assigned to a workforce planning team by its ID.

Authorizations:

x-api-key

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/json
required

ids	Array of objects (ObjectId) Array of existing user IDs

Responses

Request samples

Payload

Content type

application/json

{"ids": [{ }
]
}

Delete users from team

Removes multiple users from the specified team.

Authorizations:

x-api-key

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/json
required

ids

required

Array of objects (ObjectId)

Array of ids

Responses

Request samples

Payload

Content type

application/json

{"ids": [{ }
]
}

List teams export

Returns a paginated list of workforce plannings for export, with support for search, status, and JSONLogic query filters.

Authorizations:

x-api-key

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

Content type

application/json

{"docs": [{"id": "6501d432afe2730012f74d68",
"name": "Team Alpha",
"status": "published",
"status_formatted": "Publicado",
"author": "John Doe",
"people_count": 12,
"skills_count": 5,
"subaccount_ids": "6501d432afe2730012f74d71,6501d432afe2730012f74d72"
}
],
"limit": 10,
"page": 1,
"totalPages": 3,
"totalDocs": 25,
"hasNextPage": true,
"hasPrevPage": false,
"prevPage": null,
"nextPage": 2
}

Export teams CSV

Exports workforce plannings as CSV using the provided search, status, and JSONLogic query filters.

Authorizations:

x-api-key

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/json
required

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

Content type

application/json

{"search": "Engineering",
"query": "eyJvciI6W3siaW4iOlt7InZhciI6InRhZ3MifSxbImJhY2tlbmQiXV19LHsiaW4iOlt7InZhciI6ImV4dGVybmFsX2lkIn0sWyJXRi0xMjMiXV19XX0=",
"status": "published"
}

Response samples

200

Content type

application/json

[{"filename": "export.csv",
"data": "id;name;status"
}
]

Find Analysis Plan Insights

Group responses by skill, returning the users and their levels

Authorizations:

x-api-key

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

List teams

Returns a paginated list of teams with optional filtering by status, author, and search query.

Authorizations:

x-api-key

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=en - locale=pt - locale=es - 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

Content type

application/json

{"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",
"image": "https://example.com/image.png"
},
"users": [{"_id": "6501d432afe2730012f74d68",
"displayName": "John Doe",
"image": "https://example.com/image.png"
}
],
"users_count": 25,
"owners": [{"_id": "6501d432afe2730012f74d68",
"displayName": "John Doe",
"image": "https://example.com/image.png"
}
]
}
],
"totalDocs": 50,
"limit": 10,
"totalPages": 5,
"page": 1,
"pagingCounter": 1,
"hasPrevPage": false,
"hasNextPage": true,
"prevPage": null,
"nextPage": 2
}

Create a new career team

Creates a new career team for the current workspace.

Authorizations:

x-api-key

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/json
required

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

Content type

application/json

{"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

Deletes multiple career teams by their identifiers.

Authorizations:

x-api-key

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/json
required

ids

required

Array of objects (ObjectId)

Array of ids

Responses

Request samples

Payload

Content type

application/json

{"ids": [{ }
]
}

Archive a team

Moves the specified team to archived status by its ID.

Authorizations:

x-api-key

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

Unarchive a team

Restores a previously archived team back to published status.

Authorizations:

x-api-key

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

Duplicate a team

Creates a copy of the specified team with new field values.

Authorizations:

x-api-key

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/json
required

name required	string
description required	string

Responses

Request samples

Payload

Content type

application/json

{"name": "string",
"description": "string"
}

List team authors

Returns the list of authors who have created teams in the workspace.

Authorizations:

x-api-key

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

Content type

application/json

[{"value": "6501d432afe2730012f74d68",
"label": "John Doe"
}
]

Get career statistics

Returns aggregated statistics including total teams, people, and tracks counts.

Authorizations:

x-api-key

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

Content type

application/json

{"teams": 10,
"people": 150,
"tracks": 25
}

Get career field definitions

Returns the available field definitions such as team status options.

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 a team by ID

Returns the details of a specific team identified by its ID.

Authorizations:

x-api-key

path Parameters

id

required

string

Example: 1661452472991

query Parameters

locale

string

Examples:

locale=en -
locale=pt -
locale=es -

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

Content type

application/json

{"_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"
]
}

Update a team

Updates the details of a specific team by its ID.

Authorizations:

x-api-key

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/json
required

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

Content type

application/json

{"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

Translates career name and description for the specified team.

Authorizations:

x-api-key

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/json
required

targetLocales

required

Array of strings non-empty

Target language codes for translation (e.g. ["en","pt"]).

Responses

Request samples

Payload

Content type

application/json

{"targetLocales": ["string"
]
}

Translate track name and description

Translates track name and description for the specified team track.

Authorizations:

x-api-key

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/json
required

targetLocales

required

Array of strings non-empty

Target language codes for translation (e.g. ["en","pt"]).

Responses

Request samples

Payload

Content type

application/json

{"targetLocales": ["string"
]
}

Translate position label and description

Translates position label and description for the specified team position.

Authorizations:

x-api-key

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/json
required

targetLocales

required

Array of strings non-empty

Target language codes for translation (e.g. ["en","pt"]).

Responses

Request samples

Payload

Content type

application/json

{"targetLocales": ["string"
]
}

Translate category name and description

Translates category name and description for the specified team category.

Authorizations:

x-api-key

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/json
required

targetLocales

required

Array of strings non-empty

Target language codes for translation (e.g. ["en","pt"]).

Responses

Request samples

Payload

Content type

application/json

{"targetLocales": ["string"
]
}

Get a team view

Returns the full view of a team including tracks, positions, and categories.

Authorizations:

x-api-key

path Parameters

id

required

string

Example: 1661452472991

query Parameters

locale

string

Examples:

locale=en -
locale=pt -
locale=es -

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

Content type

application/json

{"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,
"hiring_link": "https://careers.example.com/apply",
"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",
"image": "https://example.com/image.png",
"position": "6501d432afe2730012f74d68"
}
]
}

Get team positions tree

Returns a hierarchical tree of teams with their tracks and positions.

Authorizations:

x-api-key

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

Content type

application/json

{"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"
}
]
}
]
}

Update element ordering

Updates the display order of positions, categories, or tracks within a team.

Authorizations:

x-api-key

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/json
required

kind	string Enum: "position" "team" "category"
	Array of objects

Responses

Request samples

Payload

Content type

application/json

{"kind": "category",
"ordering": [{"_id": "61b8e9bb2300e80010c0bcc2",
"order": 1
}
]
}

List users assigned to a position

Returns a paginated list of users assigned to a specific position within a team.

Authorizations:

x-api-key

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

Content type

application/json

{"docs": [{"_id": "6501d432afe2730012f74d68",
"displayName": "John Doe",
"email": "john.doe@example.com",
"image": "https://example.com/image.png"
}
],
"totalDocs": 50,
"limit": 10,
"totalPages": 5,
"page": 1,
"pagingCounter": 1,
"hasPrevPage": false,
"hasNextPage": true,
"prevPage": null,
"nextPage": 2
}

Update position users

Updates the list of users assigned to a specific position within a team.

Authorizations:

x-api-key

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/json
required

ids	Array of objects (ObjectId) Array of ids
users	object user for has bean created and invited
mode	string Default: "move" Enum: "add" "move" Assignment mode: add keeps existing positions, move removes from others

Responses

Request samples

Payload

Content type

application/json

{"ids": [{ }
],
"users": { },
"mode": "add"
}

Remove users from a specific position

Removes selected users from a specific position without affecting their other positions.

Authorizations:

x-api-key

path Parameters

id required	string Example: 61b8e9bb2300e80010c0bcc2
positionId required	string Example: 61b8e9bb2300e80010c0bcc3

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/json
required

ids

required

Array of objects (ObjectId)

Array of ids

Responses

Request samples

Payload

Content type

application/json

{"ids": [{ }
]
}

List team members

Returns a paginated list of users (people) assigned to a team with optional search and position filtering.

Authorizations:

x-api-key

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

Content type

application/json

{"docs": [{"_id": "6501d432afe2730012f74d68",
"displayName": "John Doe",
"email": "john.doe@example.com",
"image": "https://example.com/image.png",
"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
}

Get a team member

Returns the details of a specific user (person) within a team.

Authorizations:

x-api-key

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

Content type

application/json

{"_id": "6501d432afe2730012f74d68",
"displayName": "John Doe",
"email": "john.doe@example.com",
"image": "https://example.com/image.png",
"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

Removes selected users from a career team.

Authorizations:

x-api-key

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/json
required

ids

required

Array of objects (ObjectId)

Array of ids

Responses

Request samples

Payload

Content type

application/json

{"ids": [{ }
]
}

Manage user positions

Atomically add and/or remove a user from multiple positions in a career.

Authorizations:

x-api-key

path Parameters

id required	string Example: 61b8e9bb2300e80010c0bcc2
userId required	string Example: 61b8e9bb2300e80010c0bcc3

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/json
required

add	Array of objects (ObjectId) Position IDs to add the user to
remove	Array of objects (ObjectId) Position IDs to remove the user from

Responses

Request samples

Payload

Content type

application/json

{"add": [{ }
],
"remove": [{ }
]
}

Get user positions across all careers

Returns all positions a user is assigned to across all careers in the workspace.

Authorizations:

x-api-key

path Parameters

userId

required

string

Example: 61b8e9bb2300e80010c0bcc3

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

Create a track for a career team

Creates a track under the specified career team.

Authorizations:

x-api-key

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/json
required

required	object Translated content for track
assessment_id required	object Assessment id

Responses

Request samples

Payload

Content type

application/json

{"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

Deletes selected team tracks and their related references.

Authorizations:

x-api-key

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/json
required

ids

required

Array of objects (ObjectId)

Array of ids

Responses

Request samples

Payload

Content type

application/json

{"ids": [{ }
]
}

Get a team track

Returns the details of a specific track within a team.

Authorizations:

x-api-key

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

Content type

application/json

{"_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"
]
}

Update a team track

Updates a specific track within a team by its ID.

Authorizations:

x-api-key

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/json
required

required	object Translated content for track
assessment_id required	object Assessment id
_id required	object Track id

Responses

Request samples

Payload

Content type

application/json

{"translated_content": {"pt": {"name": "string",
"description": "string"
},
"en": {"name": "string",
"description": "string"
},
"es": {"name": "string",
"description": "string"
}
},
"assessment_id": { },
"_id": { }
}

Archive a track

Archives a track and all its positions within a career.

Authorizations:

x-api-key

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

Responses

Unarchive a track

Restores a previously archived track and all its positions within a career.

Authorizations:

x-api-key

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

Responses

Create a position for a career team track

Creates a position for the specified career team track.

Authorizations:

x-api-key

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/json
required

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

Content type

application/json

{"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

Deletes selected positions from team tracks and related data.

Authorizations:

x-api-key

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/json
required

ids

required

Array of objects (ObjectId)

Array of ids

Responses

Request samples

Payload

Content type

application/json

{"ids": [{ }
]
}

Get a track position

Returns the details of a specific position within a team, including its skills.

Authorizations:

x-api-key

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

Content type

application/json

{"position": {"_id": "6501d432afe2730012f74d68",
"name": "Senior Developer",
"label": "Sr. Dev",
"description": "Lead technical initiatives",
"translated_content": { },
"order": 1,
"track": "6501d432afe2730012f74d68",
"hiring_link": "https://careers.example.com/apply",
"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": { }
}
}
]
}
}

Update a track position

Updates a specific position within a team, optionally attaching new skills.

Authorizations:

x-api-key

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/json
required

_id required	object Team ID
seniority_level	number >= 1 Seniority level
vertical_level	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

Content type

application/json

{"_id": "62b384d70309831f9c13c87d",
"seniority_level": 3,
"vertical_level": 1,
"label": "Position 1 label",
"hiring_link": "https://hiring-link.com",
"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"
}
]
}

Archive a position

Archives a single position within a track.

Authorizations:

x-api-key

path Parameters

id required	string
trackId required	string
positionId 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

Unarchive a position

Restores a previously archived position within a track.

Authorizations:

x-api-key

path Parameters

id required	string
trackId required	string
positionId 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

Create a category for a career team

Creates a category under the specified career team.

Authorizations:

x-api-key

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/json
required

required

object

Translated content for category

Responses

Request samples

Payload

Content type

application/json

{"translated_content": {"pt": {"name": "string",
"description": "string"
},
"en": {"name": "string",
"description": "string"
},
"es": {"name": "string",
"description": "string"
}
}
}

Delete team category and related data

Deletes selected categories from a team and removes related references.

Authorizations:

x-api-key

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/json
required

ids

required

Array of objects (ObjectId)

Array of ids

Responses

Request samples

Payload

Content type

application/json

{"ids": [{ }
]
}

Get a team category

Returns the details of a specific category within a team.

Authorizations:

x-api-key

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

Content type

application/json

{"_id": "6501d432afe2730012f74d68",
"name": "Engineering",
"description": "Engineering department category",
"translated_content": {"pt": {"name": "Engenharia",
"description": "Categoria do departamento..."
}
},
"order": 1
}

Update a team category

Updates a specific category within a team by its ID.

Authorizations:

x-api-key

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/json
required

required	object Translated content for category
_id required	object Category id

Responses

Request samples

Payload

Content type

application/json

{"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:

x-api-key

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/json
required

ids

required

Array of objects (ObjectId)

Array of ids

Responses

Request samples

Payload

Content type

application/json

{"ids": [{ }
]
}

Remove skills from a category

Removes one or more skills from a team category.

Authorizations:

x-api-key

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/json
required

ids

required

Array of objects (ObjectId)

Array of ids

Responses

Request samples

Payload

Content type

application/json

{"ids": [{ }
]
}

Create a requirement for a career team

Creates a requirement entry for the specified career team.

Authorizations:

x-api-key

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/json
required

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

Content type

application/json

{"skill_variant": { },
"position": { },
"skill_level": 0,
"fill": true
}

Delete team requirements

Deletes selected requirement entries from a career team.

Authorizations:

x-api-key

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/json
required

ids

required

Array of objects (ObjectId)

Array of ids

Responses

Request samples

Payload

Content type

application/json

{"ids": [{ }
]
}

Update a requirement

Updates a specific requirement within a team by its ID.

Authorizations:

x-api-key

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/json
required

_id required	object Requirement id
skill_variant required	object Skill variant id
skill_level required	number Level id

Responses

Request samples

Payload

Content type

application/json

{"_id": { },
"skill_variant": { },
"skill_level": 0
}

Attach skill variants to a team

Attaches one or more skill variants to the specified team.

Authorizations:

x-api-key

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/json
required

Array

string

Responses

Request samples

Payload

Content type

application/json

["string"
]

Delete team skill and related data

Deletes selected team skills and their related references.

Authorizations:

x-api-key

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/json
required

ids

required

Array of objects (ObjectId)

Array of ids

Responses

Request samples

Payload

Content type

application/json

{"ids": [{ }
]
}

Get category skills tree

Returns a hierarchical tree of categories and their associated skills.

Authorizations:

x-api-key

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

Content type

application/json

{"categories": [{"_id": "6501d432afe2730012f74d68",
"name": "Programming Languages",
"skill_variants": [{"_id": "6501d432afe2730012f74d68",
"name": "JavaScript",
"level": "6501d432afe2730012f74d68",
"category": "6501d432afe2730012f74d68"
}
]
}
]
}

Update skill categories

This endpoint allows you to update the categories associated with a skill. Supports assigning a skill to multiple categories.

Authorizations:

x-api-key

path Parameters

id required	string Example: 61b8e9bb2300e80010c0bcc2
skillId 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/json
required

category_ids

required

Array of objects (ObjectId)

Array of category ids to assign to this skill

Responses

Request samples

Payload

Content type

application/json

{"category_ids": [{ }
]
}

Sync analysis plans for all teams in the workspace

Synchronizes analysis plans for every career team in the current workspace.

Authorizations:

x-api-key

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

List careers export

Returns a paginated list of careers for export, with support for author, status, grouping, search, locale, and JSONLogic query filters.

Authorizations:

x-api-key

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=en - locale=pt - locale=es - 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

Content type

application/json

{"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
}

Export careers CSV

Exports careers as CSV using the provided author, status, search, locale, and JSONLogic query filters.

Authorizations:

x-api-key

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/json
required

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

Content type

application/json

{"search": "engineering",
"query": "eyJhbmQiOlt7ImluIjpbeyJ2YXIiOiJzdGF0dXMifSxbInB1Ymxpc2hlZCJdXX0seyJpbiI6W3sidmFyIjoiYXV0aG9yIn0sWyI2NWY4YzJmNzM5ZWUyZjJjMjFmZjljMTAiXV19XX0=",
"author": ["65f8c2f739ee2f2c21ff9c10"
],
"status": ["published",
"archived"
],
"locale": "en"
}

Response samples

200

Content type

application/json

[{"filename": "export.csv",
"data": "id;name;status"
}
]

Generate career description using AI

Uses AI to generate a professional description for the specified career/team.

Authorizations:

x-api-key

path Parameters

id

required

string

Example: 61b8e9bb2300e80010c0bcc2

query Parameters

locale

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 track description using AI

Uses AI to generate a professional description for the specified track.

Authorizations:

x-api-key

path Parameters

id required	string
trackId required	string

query Parameters

locale

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 position description using AI

Uses AI to generate a professional description for the specified position.

Authorizations:

x-api-key

path Parameters

id required	string
positionId required	string

query Parameters

locale

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 category description using AI

Uses AI to generate a professional description for the specified category.

Authorizations:

x-api-key

path Parameters

id required	string
categoryId required	string

query Parameters

locale

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

Skills

Recalculate soft skill assessment score by ID

Re-processes the stored soft skill choices through the psychometric provider to recalculate the assessment score. Restricted to super admin users.

Authorizations:

x-api-key

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

Unlock soft skill assessment result by ID

Unlocks the soft skill assessment result for viewing, creating a profiler if needed. Restricted to admin and manager roles.

Authorizations:

x-api-key

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

Download soft skill PDF report by ID

Generates or retrieves the PDF report for a finished soft skill assessment answer and returns a signed download URL.

Authorizations:

x-api-key

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

List skill variants for a workspace

Retrieves a paginated list of skill variants for the current workspace. Supports filtering by name search and specific IDs. When both are provided, results match either condition.

Authorizations:

x-api-key

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

Content type

application/json

{"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
}

Create a skill variant

Creates a new skill variant for the current workspace. The variant is associated with the authenticated user as author and scoped to the workspace company.

Authorizations:

x-api-key

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

List template skill variants

Retrieves a paginated list of global template skill variants that are not associated with any specific company. Supports filtering by name search.

Authorizations:

x-api-key

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

Content type

application/json

{"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
}

Find a skill variant by ID

Retrieves a skill variant by its ID within the current workspace. Returns the variant with translated level descriptions and skill details based on the default locale.

Authorizations:

x-api-key

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

Content type

application/json

{"_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"
}

Update a skill variant

Updates an existing skill variant by its ID within the current workspace. Returns a redirect URL to the updated variant on success.

Authorizations:

x-api-key

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/json
required

_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

Content type

application/json

{"_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

Translates skill variant content including name, description, levels, and examples.

Authorizations:

x-api-key

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/json
required

targetLocales

required

Array of strings non-empty

Target language codes for translation (e.g. ["en","pt"]).

Responses

Request samples

Payload

Content type

application/json

{"targetLocales": ["string"
]
}

List skills export

Returns a paginated list of skill variants for export, with support for search and explicit ids filters.

Authorizations:

x-api-key

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

Content type

application/json

{"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
}

Export skills CSV

Exports skill variants as CSV using the provided search and explicit ids filters.

Authorizations:

x-api-key

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/json
required

search	string Full-text search on skill name
ids	Array of strings Filter by explicit skill ids

Responses

Request samples

Payload

Content type

application/json

{"search": "communication",
"ids": ["65f8c2f739ee2f2c21ff9c10",
"65f8c2f739ee2f2c21ff9c11"
]
}

Response samples

200

Content type

application/json

[{"filename": "export.csv",
"data": "id;name;status"
}
]

Generate proficiency levels with AI

Uses AI to generate proficiency levels with descriptions and examples for a skill variant.

Authorizations:

x-api-key

path Parameters

id

required

string

Example: 61b8e9bb2300e80010c0bcc2

query Parameters

locale

string

Example: locale=pt

Target locale for generated content

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 examples for a skill variant level with AI

Uses AI to generate concrete examples for a specific proficiency level of a skill variant.

Authorizations:

x-api-key

path Parameters

id required	string Example: 61b8e9bb2300e80010c0bcc2
levelId required	string Example: 61b8e9bb2300e80010c0bcc3

query Parameters

locale

string

Example: locale=pt

Target locale for generated content

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 skill description using AI

Uses AI to generate a professional description for the skill linked to this variant.

Authorizations:

x-api-key

path Parameters

id

required

string

Example: 61b8e9bb2300e80010c0bcc2

query Parameters

locale

string

Example: locale=pt

Target locale for generated content

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

Export career skills CSV

Exports all skills from careers as CSV, with career, track, position, category, skill details, levels, and author info.

Authorizations:

x-api-key

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/json
required

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

Content type

application/json

{"search": "engineering",
"query": "eyJhbmQiOlt7ImluIjpbeyJ2YXIiOiJzdGF0dXMifSxbInB1Ymxpc2hlZCJdXX0seyJpbiI6W3sidmFyIjoiYXV0aG9yIn0sWyI2NWY4YzJmNzM5ZWUyZjJjMjFmZjljMTAiXV19XX0=",
"author": ["65f8c2f739ee2f2c21ff9c10"
],
"status": ["published",
"archived"
],
"locale": "en"
}

Response samples

200

Content type

application/json

[{"filename": "export.csv",
"data": "id;name;status"
}
]

Workspace

Management of workspaces, subaccounts, and employees

List employees

Returns paginated workspace users with support for search, status, and JSONLogic query filters.

Authorizations:

x-api-key

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
permissions	Array of strings Filter users by permissions (all must match)

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

Content type

application/json

{"docs": [{"_id": "6501d432afe2730012f74d68",
"displayName": "John Doe",
"email": "john.doe@example.com",
"image": "https://example.com/image.png",
"roles": ["user"
],
"status": "active",
"created": "2019-08-24T14:15:22Z",
"last_login": "2019-08-24T14:15:22Z",
"last_authenticated_at": "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
}

Create employees

Creates one or more users in the active workspace and returns invitation links for the created users.

Authorizations:

x-api-key

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/json
required

required

Array of objects (CreateWorkspaceUserDto) non-empty

List of users to add to workspace

Responses

Request samples

Payload

Content type

application/json

{"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

Content type

application/json

[{"_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"
}
]

Remove employees

Removes multiple users from the active workspace and can optionally delete accounts.

Authorizations:

x-api-key

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/json
required

Bulk remove employees

required

Array of objects (RemoveEmployeeItemDto) non-empty

List of users to remove

Responses

Request samples

Payload

Content type

application/json

{"users": [{"id": "61b8e9bb2300e80010c0bcc2",
"deleteAccount": false
}
]
}

Get employee

Returns detailed information about a specific workspace user by id.

Authorizations:

x-api-key

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

Content type

application/json

{"_id": "6501d432afe2730012f74d68",
"displayName": "John Doe",
"email": "john.doe@example.com",
"roles": "user",
"image": "https://example.com/image.png",
"status": "active",
"created": "2019-08-24T14:15:22Z",
"last_login": "2019-08-24T14:15:22Z",
"last_authenticated_at": "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"
]
]
}

Update employee

Updates a specific workspace user by id, including role and status changes.

Authorizations:

x-api-key

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/json
required

displayName required	string <= 50 characters User name
email required	string <email> User email
roles required	string Default: "user" Enum: "user" "admin" "hunter" "manager" "business" 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" "list_briefings" "manage_briefings" "create_jobs_from_briefings" "view_talent_data" "delete_others_briefings" 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

Content type

application/json

{"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"
]
}

Remove employee

Removes a specific user from the active workspace and can optionally delete the account.

Authorizations:

x-api-key

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/json
required

Payload with delete flag

deleteAccount

boolean

Default: false

If true, also soft-delete the user account

Responses

Request samples

Payload

Content type

application/json

{"deleteAccount": false
}

List subaccounts

Returns paginated subaccounts for the active workspace with optional search and id filters.

Authorizations:

x-api-key

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

Content type

application/json

{"docs": [{"_id": "6501d432afe2730012f74d68",
"name": "Engineering Team",
"users_count": 15,
"users": [{"_id": "6501d432afe2730012f74d68",
"displayName": "John Doe",
"image": "https://example.com/image.png"
}
],
"created": "2019-08-24T14:15:22Z"
}
],
"totalDocs": 50,
"limit": 10,
"totalPages": 5,
"page": 1,
"pagingCounter": 1,
"hasPrevPage": false,
"hasNextPage": true,
"prevPage": null,
"nextPage": 2
}

Create subaccount

Creates a subaccount under the active workspace company and returns the created subaccount details.

Authorizations:

x-api-key

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/json
required

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

Content type

application/json

{"name": "Team A",
"department": "string",
"region": "string",
"user_ids": ["string"
]
}

Get subaccount

Returns details for a specific subaccount of the active workspace.

Authorizations:

x-api-key

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

Content type

application/json

{"_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",
"image": "https://example.com/image.png"
}
]
}

Update a subaccount

Updates a subaccount and returns a JSON object with a redirect_to property.

Authorizations:

x-api-key

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/json
required

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

Content type

application/json

{"name": "Team A",
"department": "string",
"region": "string",
"user_ids": ["string"
]
}

Response samples

200

Content type

application/json

{"redirect_to": "/assessments/workspace/subaccounts/123"
}

Remove subaccount

Removes a subaccount from the active workspace company by subaccount id.

Authorizations:

x-api-key

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

Get subaccount stats

Returns aggregate statistics for a specific subaccount in the active workspace.

Authorizations:

x-api-key

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

Content type

application/json

{"assessments_count": 12,
"questions_count": 50,
"scorecards_count": 5,
"skill_variants_count": 30,
"teams_count": 3,
"careers_count": 8,
"users_count": 25
}

List subaccounts options

Returns a paginated subaccount list optimized for selectors, with optional search and id filters.

Authorizations:

x-api-key

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

Content type

application/json

{"docs": [{"_id": "6501d432afe2730012f74d68",
"name": "Engineering Team"
}
],
"totalDocs": 50,
"totalPages": 5,
"page": 1,
"pageSize": 10
}

List user teams

Returns a paginated list of teams associated with a specific user.

Authorizations:

x-api-key

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

Content type

application/json

{"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
}

List credits history

Returns paginated workspace credits history with ordering and JSONLogic filters.

Authorizations:

x-api-key

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

Content type

application/json

{"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
}

Get credits stats

Returns aggregated credits statistics for the active workspace.

Authorizations:

x-api-key

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

Content type

application/json

{"total": 500,
"totalDocs": 25,
"hard_skills": {"balance": 100,
"status": "sufficient"
},
"soft_skills": {"balance": 100,
"status": "sufficient"
},
"usage": 150,
"updated": "2019-08-24T14:15:22Z"
}

List credits fields

Returns available credits actions and types with translated labels for filtering credits history.

Authorizations:

x-api-key

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

Content type

application/json

{"action": [{"value": "credits",
"label": "Credits"
},
{"value": "unlock",
"label": "Unlock"
}
],
"type": [{"value": "hard_skills",
"label": "Hard Skills"
},
{"value": "soft_skills",
"label": "Soft Skills"
}
]
}

List credits authors

Returns authors that appear in workspace credits history, with optional search.

Authorizations:

x-api-key

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

Content type

application/json

{"docs": [{"value": "6501d432afe2730012f74d68",
"label": "John Doe"
}
],
"totalDocs": 20,
"limit": 10,
"totalPages": 2,
"page": 1,
"pagingCounter": 1,
"hasPrevPage": false,
"hasNextPage": true,
"prevPage": null,
"nextPage": 2
}

Export credits CSV

Exports workspace credits history as CSV and supports filtering by date range and action type.

Authorizations:

x-api-key

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/json
required

startDate	string
endDate	string
action	string Filter by credits history action key

Responses

Request samples

Payload

Content type

application/json

{"startDate": "2026-01-01",
"endDate": "2026-01-31",
"action": "credits_consumed"
}

Response samples

200

Content type

application/json

[{"filename": "export.csv",
"data": "id;name;status"
}
]

Get employees stats

Returns aggregate statistics about users in the active workspace.

Authorizations:

x-api-key

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

Content type

application/json

{"total": 42,
"users_count": 35,
"admins_count": 7
}

List users export

Returns a paginated list of workspace users for export flows, with support for search, status, and JSONLogic query filters.

Authorizations:

x-api-key

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

Content type

application/json

{"docs": [{"user": "6501d432afe2730012f74d68",
"email": "user@example.com",
"name": "John Doe",
"completeness_index": 0.85,
"status": "active",
"linkedin": true,
"onboarding": true,
"linkedin_url": "https://www.linkedin.com/in/johndoe",
"last_interaction": "2025-01-15T10:30:00.000Z",
"last_login": "2025-01-15T10:30:00.000Z",
"last_authenticated_at": "2025-01-15T10:30:00.000Z",
"skill_map": "2025-01-15T10:30:00.000Z",
"certification": true,
"skills": "JavaScript, Python, React",
"position_name": "Software Engineer",
"track_name": "Engineering"
}
],
"totalDocs": 25,
"limit": 10,
"page": 1,
"totalPages": 3,
"pagingCounter": 1,
"hasPrevPage": false,
"hasNextPage": true,
"prevPage": null,
"nextPage": 2
}

Export users CSV

Exports workspace users as a CSV file using the provided search, status, and JSONLogic query filters.

Authorizations:

x-api-key

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/json
required

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

Content type

application/json

{"query": "eyJhbmQiOlt7ImluIjpbeyJ2YXIiOiJzdGF0dXMifSxbImFjdGl2ZSIsInBlbmRpbmciXV19LHsib3IiOlt7ImluIjpbeyJ2YXIiOiJyb2xlcyJ9LFsibWFuYWdlciJdXX0seyI9PSI6W3sidmFyIjoib25ib2FyZGluZyJ9LHRydWVdfV19XX0=",
"search": "john",
"status": "active",
"startDate": "2024-01-01",
"endDate": "2024-01-31"
}

Response samples

200

Content type

application/json

[{"filename": "export.csv",
"data": "id;name;status"
}
]

Export workspace people certificates CSV

Exports all people from the workspace with their certifications as a CSV file.

Authorizations:

x-api-key

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/json
required

locale

string

Locale override (e.g. en, pt, es)

Responses

Request samples

Payload

Content type

application/json

{"locale": "pt"
}

Response samples

200

Content type

application/json

[{"filename": "export.csv",
"data": "id;name;status"
}
]

Get user profile

Returns the profile view for a specific workspace user by id.

Authorizations:

x-api-key

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

Content type

application/json

{"_id": "6501d432afe2730012f74d68",
"displayName": "John Doe",
"email": "john.doe@example.com",
"status": "active",
"roles": ["user"
],
"image": "https://example.com/image.png",
"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",
"last_authenticated_at": "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"
}

Workforce

List workforce planning fields

Returns the available field definitions such as status options for workforce plannings.

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

Content type

application/json

{"status": [{"value": "draft",
"label": "Draft"
},
{"value": "published",
"label": "Published"
},
{"value": "archived",
"label": "Archived"
}
]
}

List workforce plannings

Returns a paginated list of workforce plannings with optional filtering by status, search term, and query.

Authorizations:

x-api-key

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

Content type

application/json

{"docs": [{"_id": "6501d432afe2730012f74d68",
"name": "Engineering Team Planning",
"description": "Planning for Q1 2024",
"people_count": 15,
"last_users": [{"_id": "6501d432afe2730012f74d68",
"displayName": "John Doe",
"image": "https://example.com/image.png"
}
],
"author": {"_id": "6501d432afe2730012f74d68",
"displayName": "Jane Smith",
"image": "https://example.com/image.png"
},
"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

Creates a new workforce planning entry.

Authorizations:

x-api-key

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/json
required

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

Content type

application/json

{"name": "string",
"customer": "string",
"description": "string",
"startDate": "string",
"endDate": "string",
"links": ["http://example.com"
],
"owners": ["62b384d70309831f9c13c87d",
"62b5faff5a80481c2cba4669"
],
"author": "62b5faff5a80481c2cba4669",
"subaccount_ids": ["62b384d70309831f9c13c87d",
"62b5faff5a80481c2cba4669"
],
"external_id": "string",
"tags": ["string"
]
}

Delete workforce plannings

Deletes multiple workforce planning records.

Authorizations:

x-api-key

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/json
required

ids

required

Array of objects (ObjectId)

Array of ids

Responses

Request samples

Payload

Content type

application/json

{"ids": [{ }
]
}

Find a workforce planning by ID

Returns the details of a single workforce planning identified by its ID.

Authorizations:

x-api-key

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

Content type

application/json

{"_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"
}

Update a workforce planning

Updates the details of an existing workforce planning by its ID.

Authorizations:

x-api-key

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/json
required

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

Content type

application/json

{"name": "string",
"customer": "string",
"description": "string",
"startDate": "string",
"endDate": "string",
"links": ["http://example.com"
],
"owners": ["62b384d70309831f9c13c87d",
"62b5faff5a80481c2cba4669"
],
"author": "62b5faff5a80481c2cba4669",
"subaccount_ids": ["62b384d70309831f9c13c87d",
"62b5faff5a80481c2cba4669"
],
"external_id": "string",
"tags": ["string"
],
"status": "draft"
}

Get workforce plannings statistics

Returns aggregated statistics for workforce plannings within the current workspace.

Authorizations:

x-api-key

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

Content type

application/json

{"metrics": {"teams": 10,
"leads": 5,
"belongs": 8,
"people_count": 150
},
"updated": "2019-08-24T14:15:22Z"
}

Archive a workforce planning

Changes the status of a workforce planning to archived by its ID.

Authorizations:

x-api-key

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

Unarchive a workforce planning

Restores an archived workforce planning back to published status by its ID.

Authorizations:

x-api-key

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

Duplicate a workforce planning

Creates a copy of an existing workforce planning by its ID.

Authorizations:

x-api-key

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/json
required

name required	string
description required	string

Responses

Request samples

Payload

Content type

application/json

{"name": "string",
"description": "string"
}

Find users by skills

Returns a paginated list of users matching the specified skill IDs and minimum match criteria.

Authorizations:

x-api-key

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

Content type

application/json

{"docs": [{"_id": "6501d432afe2730012f74d68",
"displayName": "John Doe",
"email": "john.doe@example.com",
"image": "https://example.com/image.png",
"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
}

Attach a skill to a workforce planning

Adds a skill to a workforce planning and recalculates the user distribution.

Authorizations:

x-api-key

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/json
required

skillId

string

Responses

Request samples

Payload

Content type

application/json

{"skillId": "61b8e9bb2300e80010c0bcc2"
}

Find users by workforce planning

Returns a paginated list of people assigned to a specific workforce planning.

Authorizations:

x-api-key

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

Content type

application/json

{"docs": [{"_id": "6501d432afe2730012f74d68",
"displayName": "John Doe",
"email": "john.doe@example.com",
"image": "https://example.com/image.png",
"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

Adds multiple users to the specified team.

Authorizations:

x-api-key

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/json
required

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

Content type

application/json

{"ids": [{ }
],
"ownerIds": [{ }
]
}

Update team users

Replaces the list of users assigned to a workforce planning team by its ID.

Authorizations:

x-api-key

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/json
required

ids	Array of objects (ObjectId) Array of existing user IDs

Responses

Request samples

Payload

Content type

application/json

{"ids": [{ }
]
}

Delete users from team

Removes multiple users from the specified team.

Authorizations:

x-api-key

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/json
required

ids

required

Array of objects (ObjectId)

Array of ids

Responses

Request samples

Payload

Content type

application/json

{"ids": [{ }
]
}

List teams export

Returns a paginated list of workforce plannings for export, with support for search, status, and JSONLogic query filters.

Authorizations:

x-api-key

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

Content type

application/json

{"docs": [{"id": "6501d432afe2730012f74d68",
"name": "Team Alpha",
"status": "published",
"status_formatted": "Publicado",
"author": "John Doe",
"people_count": 12,
"skills_count": 5,
"subaccount_ids": "6501d432afe2730012f74d71,6501d432afe2730012f74d72"
}
],
"limit": 10,
"page": 1,
"totalPages": 3,
"totalDocs": 25,
"hasNextPage": true,
"hasPrevPage": false,
"prevPage": null,
"nextPage": 2
}

Export teams CSV

Exports workforce plannings as CSV using the provided search, status, and JSONLogic query filters.

Authorizations:

x-api-key

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/json
required

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

Content type

application/json

{"search": "Engineering",
"query": "eyJvciI6W3siaW4iOlt7InZhciI6InRhZ3MifSxbImJhY2tlbmQiXV19LHsiaW4iOlt7InZhciI6ImV4dGVybmFsX2lkIn0sWyJXRi0xMjMiXV19XX0=",
"status": "published"
}

Response samples

200

Content type

application/json

[{"filename": "export.csv",
"data": "id;name;status"
}
]

Analysis

FindAnalysisPlansController_handle

Authorizations:

x-api-key

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:

x-api-key

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:

x-api-key

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/json
required

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

Content type

application/json

{"company": "62b5faff5a80481c2cba4669",
"name": "Coodesh Analysis",
"questions": [{ }
],
"categories": "62b5faff5a80481c2cba4669",
"settings": {"invites_expiration": 120,
"invites_expiration_type": "relative",
"invites_expiration_fixed_date": "2019-08-24T14:15:22Z",
"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_id": { },
"color": "green"
}
],
"grade_tags_enabled": false,
"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:

x-api-key

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:

x-api-key

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:

x-api-key

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:

x-api-key

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/json
required

_id required	object ID
answers required	Array of objects non-empty List of answers

Responses

Request samples

Payload

Content type

application/json

{"_id": { },
"answers": [{ }
]
}

DeleteAnalysisResponseController_handle

Authorizations:

x-api-key

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:

x-api-key

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:

x-api-key

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/json
required

analyses required	Array of objects (ObjectId) Analysis ids to generate autologin links
analysis_plan required	object Analysis Plan

Responses

Request samples

Payload

Content type

application/json

{"analyses": ["62b384d70309831f9c13c87d",
"62b5faff5a80481c2cba4669"
],
"analysis_plan": "62b384d70309831f9c13c87d"
}

Generate analysis for employees

This endpoint can be used by admins to generate analysis for employees

Authorizations:

x-api-key

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/json
required

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

Content type

application/json

{"users": [{ }
],
"tracks": [{ }
],
"positions": [{ }
],
"team": { }
}

Response samples

201

Content type

application/json

[{ }
]

Generate analysis for employees on onboarding process

This endpoint can be used by developers to generate analysis for themselves

Authorizations:

x-api-key

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/json
required

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

Content type

application/json

{"users": [{ }
],
"tracks": [{ }
],
"positions": [{ }
],
"team": { }
}

FindSkillRadarController_handle

Authorizations:

x-api-key

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:

x-api-key

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:

x-api-key

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:

x-api-key

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

Get scorecard field definitions

Returns field definitions for scorecards including skill levels and email template variables.

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

FindRadarByTalentController_handle

Authorizations:

x-api-key

path Parameters

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

SyncProfileToAnalysisResponsesController_handle

Authorizations:

x-api-key

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:

x-api-key

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

Teams > Exports

List teams export

Returns a paginated list of workforce plannings for export, with support for search, status, and JSONLogic query filters.

Authorizations:

x-api-key

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

Content type

application/json

{"docs": [{"id": "6501d432afe2730012f74d68",
"name": "Team Alpha",
"status": "published",
"status_formatted": "Publicado",
"author": "John Doe",
"people_count": 12,
"skills_count": 5,
"subaccount_ids": "6501d432afe2730012f74d71,6501d432afe2730012f74d72"
}
],
"limit": 10,
"page": 1,
"totalPages": 3,
"totalDocs": 25,
"hasNextPage": true,
"hasPrevPage": false,
"prevPage": null,
"nextPage": 2
}

Export teams CSV

Exports workforce plannings as CSV using the provided search, status, and JSONLogic query filters.

Authorizations:

x-api-key

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/json
required

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

Content type

application/json

{"search": "Engineering",
"query": "eyJvciI6W3siaW4iOlt7InZhciI6InRhZ3MifSxbImJhY2tlbmQiXV19LHsiaW4iOlt7InZhciI6ImV4dGVybmFsX2lkIn0sWyJXRi0xMjMiXV19XX0=",
"status": "published"
}

Response samples

200

Content type

application/json

[{"filename": "export.csv",
"data": "id;name;status"
}
]

Teams > Bulk Actions

Delete workforce plannings

Deletes multiple workforce planning records.

Authorizations:

x-api-key

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/json
required

ids

required

Array of objects (ObjectId)

Array of ids

Responses

Request samples

Payload

Content type

application/json

{"ids": [{ }
]
}

Skills > Exports

List skills export

Returns a paginated list of skill variants for export, with support for search and explicit ids filters.

Authorizations:

x-api-key

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

Content type

application/json

{"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
}

Export skills CSV

Exports skill variants as CSV using the provided search and explicit ids filters.

Authorizations:

x-api-key

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/json
required

search	string Full-text search on skill name
ids	Array of strings Filter by explicit skill ids

Responses

Request samples

Payload

Content type

application/json

{"search": "communication",
"ids": ["65f8c2f739ee2f2c21ff9c10",
"65f8c2f739ee2f2c21ff9c11"
]
}

Response samples

200

Content type

application/json

[{"filename": "export.csv",
"data": "id;name;status"
}
]

Workspace > Exports

Export credits CSV

Exports workspace credits history as CSV and supports filtering by date range and action type.

Authorizations:

x-api-key

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/json
required

startDate	string
endDate	string
action	string Filter by credits history action key

Responses

Request samples

Payload

Content type

application/json

{"startDate": "2026-01-01",
"endDate": "2026-01-31",
"action": "credits_consumed"
}

Response samples

200

Content type

application/json

[{"filename": "export.csv",
"data": "id;name;status"
}
]

List users export

Returns a paginated list of workspace users for export flows, with support for search, status, and JSONLogic query filters.

Authorizations:

x-api-key

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

Content type

application/json

{"docs": [{"user": "6501d432afe2730012f74d68",
"email": "user@example.com",
"name": "John Doe",
"completeness_index": 0.85,
"status": "active",
"linkedin": true,
"onboarding": true,
"linkedin_url": "https://www.linkedin.com/in/johndoe",
"last_interaction": "2025-01-15T10:30:00.000Z",
"last_login": "2025-01-15T10:30:00.000Z",
"last_authenticated_at": "2025-01-15T10:30:00.000Z",
"skill_map": "2025-01-15T10:30:00.000Z",
"certification": true,
"skills": "JavaScript, Python, React",
"position_name": "Software Engineer",
"track_name": "Engineering"
}
],
"totalDocs": 25,
"limit": 10,
"page": 1,
"totalPages": 3,
"pagingCounter": 1,
"hasPrevPage": false,
"hasNextPage": true,
"prevPage": null,
"nextPage": 2
}

Export users CSV

Exports workspace users as a CSV file using the provided search, status, and JSONLogic query filters.

Authorizations:

x-api-key

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/json
required

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

Content type

application/json

{"query": "eyJhbmQiOlt7ImluIjpbeyJ2YXIiOiJzdGF0dXMifSxbImFjdGl2ZSIsInBlbmRpbmciXV19LHsib3IiOlt7ImluIjpbeyJ2YXIiOiJyb2xlcyJ9LFsibWFuYWdlciJdXX0seyI9PSI6W3sidmFyIjoib25ib2FyZGluZyJ9LHRydWVdfV19XX0=",
"search": "john",
"status": "active",
"startDate": "2024-01-01",
"endDate": "2024-01-31"
}

Response samples

200

Content type

application/json

[{"filename": "export.csv",
"data": "id;name;status"
}
]

Export workspace people certificates CSV

Exports all people from the workspace with their certifications as a CSV file.

Authorizations:

x-api-key

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/json
required

locale

string

Locale override (e.g. en, pt, es)

Responses

Request samples

Payload

Content type

application/json

{"locale": "pt"
}

Response samples

200

Content type

application/json

[{"filename": "export.csv",
"data": "id;name;status"
}
]

Careers > Exports

List careers export

Returns a paginated list of careers for export, with support for author, status, grouping, search, locale, and JSONLogic query filters.

Authorizations:

x-api-key

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=en - locale=pt - locale=es - 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

Content type

application/json

{"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
}

Export careers CSV

Exports careers as CSV using the provided author, status, search, locale, and JSONLogic query filters.

Authorizations:

x-api-key

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/json
required

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

Content type

application/json

{"search": "engineering",
"query": "eyJhbmQiOlt7ImluIjpbeyJ2YXIiOiJzdGF0dXMifSxbInB1Ymxpc2hlZCJdXX0seyJpbiI6W3sidmFyIjoiYXV0aG9yIn0sWyI2NWY4YzJmNzM5ZWUyZjJjMjFmZjljMTAiXV19XX0=",
"author": ["65f8c2f739ee2f2c21ff9c10"
],
"status": ["published",
"archived"
],
"locale": "en"
}

Response samples

200

Content type

application/json

[{"filename": "export.csv",
"data": "id;name;status"
}
]

Export career skills CSV

Exports all skills from careers as CSV, with career, track, position, category, skill details, levels, and author info.

Authorizations:

x-api-key

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/json
required

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

Content type

application/json

{"search": "engineering",
"query": "eyJhbmQiOlt7ImluIjpbeyJ2YXIiOiJzdGF0dXMifSxbInB1Ymxpc2hlZCJdXX0seyJpbiI6W3sidmFyIjoiYXV0aG9yIn0sWyI2NWY4YzJmNzM5ZWUyZjJjMjFmZjljMTAiXV19XX0=",
"author": ["65f8c2f739ee2f2c21ff9c10"
],
"status": ["published",
"archived"
],
"locale": "en"
}

Response samples

200

Content type

application/json

[{"filename": "export.csv",
"data": "id;name;status"
}
]

Export people certificates CSV

Exports people from a team with their certifications as a CSV file.

Authorizations:

x-api-key

path Parameters

id

required

string

Team 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/json
required

locale

string

Locale override (e.g. en, pt, es)

Responses

Request samples

Payload

Content type

application/json

{"locale": "pt"
}

Response samples

200

Content type

application/json

[{"filename": "export.csv",
"data": "id;name;status"
}
]

Careers > Bulk Actions

Delete teams

Deletes multiple career teams by their identifiers.

Authorizations:

x-api-key

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/json
required

ids

required

Array of objects (ObjectId)

Array of ids

Responses

Request samples

Payload

Content type

application/json

{"ids": [{ }
]
}

ATS

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:

x-api-key

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/json
required

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 Controls transactional emails sent to the candidate for this attempt. When `true`: (1) the invite email is NOT sent at attempt creation, and (2) the result email is NOT sent to the candidate when the attempt is finished. Recommended when the ATS already notifies the candidate on its own side. Does NOT affect: emails to the assessment author or custom recipients (controlled by the assessment setting `disable_email_notification`), reminder emails, or the certificate flow. Default: `false`.

Responses

Request samples

Payload

Content type

application/json

{"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:

x-api-key

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

Content type

application/json

{ }

Get all assessments

This endpoint list all assessments from account

Authorizations:

x-api-key

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

Content type

application/json

{ }

Get all assessments

This endpoint list all assessments from account

Authorizations:

x-api-key

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

Content type

application/json

[{"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:

x-api-key

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

Content type

application/json

{"attempt_id": "65dfa9f6feb036139eccce41",
"title": "Backend Node.js",
"testCode": "659cfcfe671ace001106dcaa",
"description": "This is the result of your Backend Node.js assessment",
"providerName": "Coodesh",
"providerLink": "https://beta.coodesh.com",
"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}",
"result_candidate_page_url": "https://coodesh.com/assessments/result/65dfa9f6feb036139eccce41",
"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:

x-api-key

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/json
required

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 Controls transactional emails sent to the candidate for this attempt. When `true`: (1) the invite email is NOT sent at attempt creation, and (2) the result email is NOT sent to the candidate when the attempt is finished. On Gupy the default is `true` because Gupy itself already notifies the candidate. Does NOT affect: emails to the assessment author or custom recipients (controlled by the assessment setting `disable_email_notification`), reminder emails, or the certificate flow. Default: `true`.

Responses

Request samples

Payload

Content type

application/json

{"name": "Test User",
"email": "test@example.com",
"document_id": 10,
"birthdate": "string",
"gender": "male",
"test_id": "659cfcfe671ace001106dcaa",
"company_id": 0,
"job_id": 2,
"callback_url": "https://gupy.io/job/2/view",
"candidate_type": "internal",
"previous_result": "fail",
"result_webhook_url": "http://example.com",
"disable_email": true
}

Response samples

201

Content type

application/json

{"test_result_id": "65dfa9f6feb036139eccce41",
"test_url": "https://beta.coodesh.com/pt/assessments/1704787198442?user_token={token}"
}

Get all assessments

This endpoint list all assessments from account

Authorizations:

x-api-key

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

Content type

application/json

[{"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:

x-api-key

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

Content type

application/json

{"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",
"provider_link": "https://beta.coodesh.com",
"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",
"invite_link": "https://beta.coodesh.com/pt/assessments/invite/65dfa9f6feb036139eccce41",
"public_link": "https://beta.coodesh.com/pt/share/assessments/65dfa9f6feb036139eccce41?accessToken={token}",
"result_talent_link": "https://beta.coodesh.com/pt/assessments/results/65dfa9f6feb036139eccce41",
"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:

x-api-key

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/json
required

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: false Controls transactional emails sent to the candidate for this attempt. When `true`: (1) the invite email is NOT sent at attempt creation, and (2) the result email is NOT sent to the candidate when the attempt is finished. Recommended when the ATS already notifies the candidate on its own side. Does NOT affect: emails to the assessment author or custom recipients (controlled by the assessment setting `disable_email_notification`), reminder emails, or the certificate flow. Default: `false`.

Responses

Request samples

Payload

Content type

application/json

{"name": "Test User",
"email": "test@example.com",
"user_id": "6666c8a39641daa32b5f5443",
"assessment_id": "659cfcfe671ace001106dcaa",
"company_id": "6666c8c7e4421468fc1bcbb0",
"job_id": "6666c8c2d944f09a35be0043",
"callback_url": "https://coodesh.com/applicants/details/6666c8d5c209f8c757dcbf66",
"webhook_url": "http://example.com",
"disable_email": true
}

Response samples

201

Content type

application/json

{"attempt_id": "65dfa9f6feb036139eccce41",
"attempt_url": "https://beta.coodesh.com/pt/assessments/1704787198442?user_token={token}"
}

Sync attempt result

Recompute the score of an existing attempt, disable notifications by default

Authorizations:

x-api-key

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/json
required

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

Content type

application/json

{"disable_notification": true,
"disable_ats_sync": true,
"disable_process_snapshots": true,
"disable_calculate_traits": true
}

Response samples

201

Content type

application/json

{"message": "Attempt synced successfully"
}

Gupy

Get all assessments

This endpoint list all assessments from account

Authorizations:

x-api-key

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

Content type

application/json

[{"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:

x-api-key

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

Content type

application/json

{"attempt_id": "65dfa9f6feb036139eccce41",
"title": "Backend Node.js",
"testCode": "659cfcfe671ace001106dcaa",
"description": "This is the result of your Backend Node.js assessment",
"providerName": "Coodesh",
"providerLink": "https://beta.coodesh.com",
"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}",
"result_candidate_page_url": "https://coodesh.com/assessments/result/65dfa9f6feb036139eccce41",
"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:

x-api-key

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/json
required

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 Controls transactional emails sent to the candidate for this attempt. When `true`: (1) the invite email is NOT sent at attempt creation, and (2) the result email is NOT sent to the candidate when the attempt is finished. On Gupy the default is `true` because Gupy itself already notifies the candidate. Does NOT affect: emails to the assessment author or custom recipients (controlled by the assessment setting `disable_email_notification`), reminder emails, or the certificate flow. Default: `true`.

Responses

Request samples

Payload

Content type

application/json

{"name": "Test User",
"email": "test@example.com",
"document_id": 10,
"birthdate": "string",
"gender": "male",
"test_id": "659cfcfe671ace001106dcaa",
"company_id": 0,
"job_id": 2,
"callback_url": "https://gupy.io/job/2/view",
"candidate_type": "internal",
"previous_result": "fail",
"result_webhook_url": "http://example.com",
"disable_email": true
}

Response samples

201

Content type

application/json

{"test_result_id": "65dfa9f6feb036139eccce41",
"test_url": "https://beta.coodesh.com/pt/assessments/1704787198442?user_token={token}"
}

Recrutai

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:

x-api-key

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/json
required

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 Controls transactional emails sent to the candidate for this attempt. When `true`: (1) the invite email is NOT sent at attempt creation, and (2) the result email is NOT sent to the candidate when the attempt is finished. Recommended when the ATS already notifies the candidate on its own side. Does NOT affect: emails to the assessment author or custom recipients (controlled by the assessment setting `disable_email_notification`), reminder emails, or the certificate flow. Default: `false`.

Responses

Request samples

Payload

Content type

application/json

{"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:

x-api-key

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

Content type

application/json

{ }

Get all assessments

This endpoint list all assessments from account

Authorizations:

x-api-key

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

Content type

application/json

{ }

General

Get API status message

Returns a basic API running/version message.

header Parameters

x-workspace-id	any Workspace identifier to scope the request to a specific company workspace
x-subaccount-id	any Subaccount identifier for multi-tenant operations within a workspace
x-language	any Preferred language for response content (e.g. "pt", "en", "es")

Responses

Response samples

200

Content type

application/json

{"message": "RESTful API Coodesh v2026.2.0 running =D"
}

Get robots.txt

Returns robots.txt with deny-all directives.

header Parameters

x-workspace-id	any Workspace identifier to scope the request to a specific company workspace
x-subaccount-id	any Subaccount identifier for multi-tenant operations within a workspace
x-language	any Preferred language for response content (e.g. "pt", "en", "es")

Responses

Search CEP by ZIP code

Looks up Brazilian CEP address data by ZIP code.

path Parameters

zipCode

required

string

Example: 01310100

Brazilian postal code (CEP)

header Parameters

x-workspace-id	any Workspace identifier to scope the request to a specific company workspace
x-subaccount-id	any Subaccount identifier for multi-tenant operations within a workspace
x-language	any Preferred language for response content (e.g. "pt", "en", "es")

Responses

Response samples

200
400
404

Content type

application/json

{"cep": "01310100",
"state": "SP",
"city": "São Paulo",
"street": "Avenida Paulista",
"neighborhood": "Bela Vista",
"service": "brasilapi"
}

Generate Sitemap

Handle GET sitemaps/jobs.xml.

header Parameters

x-workspace-id	any Workspace identifier to scope the request to a specific company workspace
x-subaccount-id	any Subaccount identifier for multi-tenant operations within a workspace
x-language	any Preferred language for response content (e.g. "pt", "en", "es")

Responses

Linkedin Feed

Handle GET feeds/linkedin.xml.

header Parameters

x-workspace-id	any Workspace identifier to scope the request to a specific company workspace
x-subaccount-id	any Subaccount identifier for multi-tenant operations within a workspace
x-language	any Preferred language for response content (e.g. "pt", "en", "es")

Responses

Glassdoor Feed

Handle GET feeds/glassdoor.xml.

header Parameters

x-workspace-id	any Workspace identifier to scope the request to a specific company workspace
x-subaccount-id	any Subaccount identifier for multi-tenant operations within a workspace
x-language	any Preferred language for response content (e.g. "pt", "en", "es")

Responses

Sync database indexes

Synchronizes MongoDB indexes for registered models.

query Parameters

blacklist

string

Example: blacklist=User,Partner

Comma-separated model names to exclude from sync

header Parameters

x-workspace-id	any Workspace identifier to scope the request to a specific company workspace
x-subaccount-id	any Subaccount identifier for multi-tenant operations within a workspace
x-language	any Preferred language for response content (e.g. "pt", "en", "es")

Responses

Get API welcome message

Returns a welcome message containing the current microservice name and version. Useful for verifying the API is running.

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 current time for a timezone

Returns the current date and time for the specified timezone. The response is never cached.

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

Content type

application/json

{ }

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

Content type

application/json

[{"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

Content type

application/json

[{"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."
}
]

Media

List blog posts

Returns blog posts from WordPress.

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 Workspace identifier to scope the request to a specific company workspace
x-subaccount-id	any Subaccount identifier for multi-tenant operations within a workspace
x-language	any Preferred language for response content (e.g. "pt", "en", "es")

Responses

Response samples

200

Content type

application/json

[{"id": 42,
"date": "2024-06-15T10:30:00",
"slug": "how-to-use-nestjs",
"status": "publish",
"type": "post",
"link": "https://blog.coodesh.com/how-to-use-nestjs/",
"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
]
}
]

List blog categories

Returns blog categories from WordPress.

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 Workspace identifier to scope the request to a specific company workspace
x-subaccount-id	any Subaccount identifier for multi-tenant operations within a workspace
x-language	any Preferred language for response content (e.g. "pt", "en", "es")

Responses

Response samples

200

Content type

application/json

[{"id": 3,
"count": 12,
"description": "Articles about software engineering",
"link": "https://blog.coodesh.com/category/engineering/",
"name": "Engineering",
"slug": "engineering",
"taxonomy": "category",
"parent": 0
}
]

Coodesh API (2026.04.29)

Getting Started

Base URL

Obtaining an API Key

Quick Example

Authentication

API Key (x-api-key)

Public Endpoints

Common Headers

Authentication

Validate API key

header Parameters

Responses

Response samples

Validate Reset Token

path Parameters

header Parameters

Responses

Reset

path Parameters

header Parameters

Request Body schema: application/jsonrequired

Responses

Request samples

Response samples

Connect

header Parameters

Request Body schema: application/jsonrequired

Responses

Request samples

Response samples

Sign In

header Parameters

Request Body schema: application/jsonrequired

Responses

Request samples

Response samples

Sign Up

header Parameters

Request Body schema: application/jsonrequired

Responses

Request samples

Response samples

Validate Invite Token

path Parameters

header Parameters

Responses

Response samples

Invite

path Parameters

header Parameters

Request Body schema: application/jsonrequired

Responses

Request samples

Response samples

Forgot

header Parameters

Request Body schema: application/jsonrequired

Responses

Request samples

Response samples

Facebook

header Parameters

Request Body schema: application/jsonrequired

Responses

Request samples

Response samples

Google

header Parameters

Request Body schema: application/jsonrequired

Responses

Request samples

Response samples

Github

header Parameters

Request Body schema: application/jsonrequired

Responses

Request samples

Response samples

Linkedin

API Key (`x-api-key`)

Request Body schema: application/json
required

Request Body schema: application/json
required

Request Body schema: application/json
required

Request Body schema: application/json
required

Request Body schema: application/json
required

Request Body schema: application/json
required

Request Body schema: application/json
required

Request Body schema: application/json
required

Request Body schema: application/json
required

Request Body schema: application/json
required

Request Body schema: application/json
required

Request Body schema: application/json
required

Request Body schema: application/json
required

Request Body schema: application/json
required