PerformMgmt API

Build powerful integrations with the PerformMgmt Survey API. Create and manage survey templates, send invitations, and retrieve comprehensive behavioral assessment results.

API Key Authentication

REST API

JSON Responses

Base URL

https://culture-course.com/api

Authentication

The PerformMgmt API uses API keys to authenticate requests. Include your API key in the X-Api-Key header with every request. You must also specify your tenant ID.

X-Api-Key: your_api_key_here

X-Tenant-Id: your_tenant_guid

Content-Type: application/json

Keep your API key secure

Never expose your API key in client-side code or public repositories. Store it securely on your server.

Error Handling

The API uses standard HTTP status codes and returns detailed error information in a consistent format.

Status Code	Description
200	Request succeeded
201	Resource created successfully
400	Bad request - Invalid parameters or validation error
401	Unauthorized - Invalid or missing API key
404	Not found - Resource doesn't exist
500	Server error - Something went wrong on our end

Survey Templates

Survey templates define the structure and questions for behavioral assessments. Create, manage, and publish templates to use for employee and candidate evaluations.

GET

List all templates

/survey/templates

Retrieves all survey templates for your tenant. Returns template metadata including name, description, status, and question count.

Response

200 Returns a list of templates

GET

Retrieve a template

/survey/templates/{id}

Retrieves a specific template with all its questions and answer options.

Parameter	Description
id guid required	The unique identifier of the template

POST

Create a template

/survey/templates

Creates a new survey template. After creation, add questions and answer options, then publish the template to make it available for use.

Body Parameter	Description
name string required	Display name of the template
description string optional	Detailed description of the survey purpose
audience string required	Target audience: "Internal", "External", or "Both"
scoringMode string required	Scoring method: "Standard" or "Weighted"
shuffleQuestions boolean optional	Randomize question order for respondents

Response

201 Returns the new template ID

PUT

Update a template

/survey/templates/{id}

Updates an existing template's properties. Only draft templates can be modified.

POST

Publish a template

/survey/templates/{id}/publish

Publishes a draft template, making it available for survey invitations. Published templates cannot be edited.

POST

Archive a template

/survey/templates/{id}/archive

Archives a template, preventing new invitations while preserving existing results.

POST

Clone a template

/survey/templates/{id}/clone

Creates a copy of an existing template with all questions and answer options. The clone is created as a draft.

Response

201 Returns the new template ID

DELETE

Delete a template

/survey/templates/{id}

Permanently deletes a template. Templates with existing responses cannot be deleted.

Questions

Add and manage questions within a survey template. Each question can have multiple answer options with associated ability and willingness scores.

POST

Add a question

/survey/questions

Adds a new question to an existing template.

Body Parameter	Description
templateId guid required	The template to add the question to
text string required	The question text displayed to respondents
domainTag string optional	Category: "Behavioral", "Emotional", or "Cognitive"

PUT

Update a question

/survey/questions/{id}

Updates an existing question's text or domain tag.

DELETE

Delete a question

/survey/questions/{id}

Removes a question and all its answer options from the template.

POST

Reorder questions

/survey/templates/{templateId}/questions/reorder

Sets the display order of questions within a template.

Body Parameter	Description
questionIds guid[] required	Array of question IDs in desired order

Answer Options

Define the available responses for each question. Each option includes ability and willingness scores used in the behavioral assessment calculation.

POST

Add an answer option

/survey/answers

Adds a new answer option to an existing question.

Body Parameter	Description
questionId guid required	The question to add the option to
text string required	The answer text displayed to respondents
order integer required	Display order (0 = A, 1 = B, etc.)
abilityScore decimal required	Ability score contribution (0-100)
willingnessScore decimal required	Willingness score contribution (0-100)

PUT

Update an answer option

/survey/answers/{id}

Updates an existing answer option's properties.

DELETE

Delete an answer option

/survey/answers/{id}

Removes an answer option from a question.

Invitations

Send survey invitations to candidates and employees. Track invitation status and manage pending invitations.

POST

Send an invitation

/survey/invitations

Sends a survey invitation email to the specified recipient. The email includes a unique link to complete the survey.

Body Parameter	Description
templateId guid required	The published template to use
email string required	Recipient's email address
candidateName string optional	Recipient's display name for personalization

Response

201 Returns the invitation ID

GET

List invitations

/survey/invitations

Retrieves all survey invitations with their current status.

Query Parameter	Description
status string optional	Filter by status: "Pending", "Completed", "Expired", "Cancelled"

POST

Resend an invitation

/survey/invitations/{id}/resend

Resends the invitation email for a pending invitation.

POST

Cancel an invitation

/survey/invitations/{id}/cancel

Cancels a pending invitation, preventing the recipient from completing the survey.

GET

Get available templates

/survey/invitations/templates

Lists published templates available for sending invitations.

Results

Retrieve completed survey results including behavioral profiles, scores, and comprehensive assessment narratives.

GET

List results

/survey/results

Retrieves a list of completed survey results with summary information.

Query Parameter	Description
isEmployeeTab boolean optional	Filter to current employees only
search string optional	Search by name or email
sortBy string optional	Sort order: "recent" (default), "name", "score"

GET

Get result detail

/survey/results/{responseId}

Retrieves detailed assessment results including the behavioral profile, strengths, risks, and management recommendations.

Profile Quadrants

Results include quadrant placement (Able-Willing, Able-Unwilling, Unable-Willing, Unable-Unwilling) based on the respondent's ability and willingness scores.

Utility Endpoints

Helper endpoints for retrieving available configuration options.

GET

Get domain tags

/survey/domain-tags

Returns available domain tags for categorizing questions: Behavioral, Emotional, Cognitive.

GET

Get audience types

/survey/audience-types

Returns available audience types for survey templates: Internal, External, Both.

GET

Get scoring modes

/survey/scoring-modes

Returns available scoring modes: Standard, Weighted.

using var client = new HttpClient(); client.DefaultRequestHeaders.Add("X-Api-Key", "your_api_key"); client.DefaultRequestHeaders.Add("X-Tenant-Id", "your_tenant_id"); var response = await client.GetAsync( "https://culture-course.com/api/survey/templates" ); var content = await response.Content.ReadAsStringAsync();

import requests headers = { "X-Api-Key": "your_api_key", "X-Tenant-Id": "your_tenant_id" } response = requests.get( "https://culture-course.com/api/survey/templates", headers=headers ) data = response.json()

const response = await fetch( 'https://culture-course.com/api/survey/templates', { headers: { 'X-Api-Key': 'your_api_key', 'X-Tenant-Id': 'your_tenant_id' } } ); const data = await response.json();

{ "success": true, "data": [ { "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", "name": "Employee Assessment", "description": "Standard behavioral assessment", "audience": "Internal", "scoringMode": "Standard", "status": "Published", "version": 1, "questionCount": 25, "createdAt": "2024-01-15T10:30:00Z" } ], "message": null, "errors": [] }

var response = await client.GetAsync( "https://culture-course.com/api/survey/templates" ); var result = await response.Content .ReadFromJsonAsync<ApiResponse<List<Template>>>(); foreach (var template in result.Data) { Console.WriteLine($"{template.Name}: {template.QuestionCount} questions"); }

response = requests.get( "https://culture-course.com/api/survey/templates", headers=headers ) templates = response.json()["data"] for template in templates: print(f"{template['name']}: {template['questionCount']} questions")

curl -X POST \ https://culture-course.com/api/survey/templates \ -H "X-Api-Key: your_api_key" \ -H "X-Tenant-Id: your_tenant_id" \ -H "Content-Type: application/json" \ -d '{ "name": "New Hire Assessment", "description": "Behavioral assessment for new hires", "audience": "External", "scoringMode": "Standard", "shuffleQuestions": true }'

var request = new CreateTemplateRequest { Name = "New Hire Assessment", Description = "Behavioral assessment for new hires", Audience = "External", ScoringMode = "Standard", ShuffleQuestions = true }; var response = await client.PostAsJsonAsync( "https://culture-course.com/api/survey/templates", request ); var result = await response.Content .ReadFromJsonAsync<ApiResponse<Guid>>(); Console.WriteLine($"Created template: {result.Data}");

template_data = { "name": "New Hire Assessment", "description": "Behavioral assessment for new hires", "audience": "External", "scoringMode": "Standard", "shuffleQuestions": True } response = requests.post( "https://culture-course.com/api/survey/templates", headers=headers, json=template_data ) template_id = response.json()["data"] print(f"Created template: {template_id}")

curl -X POST \ https://culture-course.com/api/survey/invitations \ -H "X-Api-Key: your_api_key" \ -H "X-Tenant-Id: your_tenant_id" \ -H "Content-Type: application/json" \ -d '{ "templateId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", "email": "candidate@example.com", "candidateName": "John Smith" }'

var invitation = new CreateInvitationRequest { TemplateId = Guid.Parse("3fa85f64-5717-4562-b3fc-2c963f66afa6"), Email = "candidate@example.com", CandidateName = "John Smith" }; var response = await client.PostAsJsonAsync( "https://culture-course.com/api/survey/invitations", invitation ); var result = await response.Content .ReadFromJsonAsync<ApiResponse<Guid>>(); Console.WriteLine($"Invitation sent: {result.Data}");

invitation = { "templateId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", "email": "candidate@example.com", "candidateName": "John Smith" } response = requests.post( "https://culture-course.com/api/survey/invitations", headers=headers, json=invitation ) invitation_id = response.json()["data"] print(f"Invitation sent: {invitation_id}")

var responseId = "8b2c4f91-a832-4e5f-9c1d-3e7b8a2f5c6d"; var response = await client.GetAsync( $"https://culture-course.com/api/survey/results/{responseId}" ); var result = await response.Content .ReadFromJsonAsync<ApiResponse<SurveyResult>>(); Console.WriteLine($"Profile: {result.Data.ProfileName}"); Console.WriteLine($"Quadrant: {result.Data.QuadrantLabel}");

response_id = "8b2c4f91-a832-4e5f-9c1d-3e7b8a2f5c6d" response = requests.get( f"https://culture-course.com/api/survey/results/{response_id}", headers=headers ) result = response.json()["data"] print(f"Profile: {result['profileName']}") print(f"Quadrant: {result['quadrantLabel']}")

{ "success": true, "data": { "responseId": "8b2c4f91-a832-4e5f-9c1d-3e7b8a2f5c6d", "firstName": "John", "lastName": "Smith", "email": "john.smith@example.com", "completedAt": "2024-01-20T14:30:00Z", "abilityTotal": 72.5, "willingnessTotal": 85.0, "abilityBand": "High", "willingnessBand": "High", "quadrant": "AW", "quadrantLabel": "Able and Willing", "profileCode": "ACHIEVER", "profileName": "The Achiever", "profileCategory": "High Performer", "narrativeSummary": "This individual demonstrates...", "strengths": "Strong analytical skills...", "risks": "May become frustrated with...", "bestFitConditions": "Thrives in environments...", "supervisionNeeds": "Minimal supervision required..." }, "message": null, "errors": [] }