API Documentation
Endpoints
Account
Assessment Invite
Resource Alias
curl --request GET \
--url https://vanguard.profilebehavior.com/api/v4/profile/{profileId} \
--header 'Authorization: Bearer <token>'{
"code": 200,
"profile": {
"id": "60e9ca73c500a9001534ad84",
"createdAt": "2025-09-26T13:49:53.256Z",
"updatedAt": "2025-09-26T14:37:29.157Z",
"email": "[email protected]",
"firstName": "John",
"lastName": "Doe",
"disc": {
"style": "CS",
"d": 34.66185580566288,
"i": 19.018670835970415,
"s": 66.40729193181404,
"c": 84.98081737824077
},
"core": {
"first": "freedom",
"second": "wealth",
"third": "wisdom",
"fourth": "familyHappiness",
"fifth": "achievement"
},
"focus": {
"flexibility": {
"score": 88,
"level": "veryHigh",
"facets": {
"creativity": {
"score": 100,
"level": "veryHigh"
},
"aestheticAppreciation": {
"score": 87,
"level": "veryHigh"
},
"emotionalAwareness": {
"score": 68,
"level": "high"
},
"innovativeness": {
"score": 75,
"level": "high"
},
"intellectualCuriosity": {
"score": 100,
"level": "veryHigh"
},
"openMindedness": {
"score": 100,
"level": "veryHigh"
}
}
},
"organization": {
"score": 78,
"level": "high",
"facets": {
"selfBelief": {
"score": 87,
"level": "veryHigh"
},
"systemization": {
"score": 75,
"level": "high"
},
"responsibility": {
"score": 68,
"level": "high"
},
"goalOriented": {
"score": 87,
"level": "veryHigh"
},
"discipline": {
"score": 50,
"level": "baseline"
},
"prudence": {
"score": 100,
"level": "veryHigh"
}
}
},
"communication": {
"score": 23,
"level": "low",
"facets": {
"friendliness": {
"score": 6,
"level": "veryLow"
},
"sociability": {
"score": 0,
"level": "veryLow"
},
"leadership": {
"score": 37,
"level": "low"
},
"vigor": {
"score": 37,
"level": "low"
},
"adventureSeeking": {
"score": 12,
"level": "veryLow"
},
"cheerfulness": {
"score": 50,
"level": "baseline"
}
}
},
"understanding": {
"score": 46,
"level": "baseline",
"facets": {
"trust": {
"score": 37,
"level": "low"
},
"integrity": {
"score": 50,
"level": "baseline"
},
"generosity": {
"score": 75,
"level": "high"
},
"teamwork": {
"score": 25,
"level": "low"
},
"humility": {
"score": 56,
"level": "baseline"
},
"compassion": {
"score": 37,
"level": "low"
}
}
},
"stability": {
"score": 81,
"level": "veryHigh",
"facets": {
"composure": {
"score": 68,
"level": "high"
},
"temperance": {
"score": 93,
"level": "veryHigh"
},
"optimism": {
"score": 81,
"level": "veryHigh"
},
"confidence": {
"score": 56,
"level": "baseline"
},
"selfControl": {
"score": 93,
"level": "veryHigh"
},
"resilience": {
"score": 93,
"level": "veryHigh"
}
}
}
},
"availableAssessments": [
"64b935448d1d9b54cb9cb5d5",
"6047fca80001b34e77245e71",
"6047fcba0001b34e77245e73"
],
"completedAssessments": [
"64b935448d1d9b54cb9cb5d5",
"6047fca80001b34e77245e71",
"6047fcba0001b34e77245e73"
],
"isCompleted": true,
"dateStarted": "2025-09-26T13:49:53.255Z",
"timers": [
{
"assessment": "64b935448d1d9b54cb9cb5d5",
"isCompleted": true,
"activeSeconds": 522,
"inactiveSeconds": 49,
"dateStarted": "2025-09-26T14:18:01.343Z",
"dateCompleted": "2025-09-26T14:27:25.489Z",
"lastUpdated": "2025-09-26T14:27:01.890Z"
},
{
"assessment": "6047fca80001b34e77245e71",
"isCompleted": true,
"activeSeconds": 318,
"inactiveSeconds": 43,
"dateStarted": "2025-09-26T14:27:28.496Z",
"dateCompleted": "2025-09-26T14:33:27.569Z",
"lastUpdated": "2025-09-26T14:32:59.021Z"
},
{
"assessment": "6047fcba0001b34e77245e73",
"isCompleted": true,
"activeSeconds": 210,
"inactiveSeconds": 0,
"dateStarted": "2025-09-26T14:33:30.446Z",
"dateCompleted": "2025-09-26T14:37:27.650Z",
"lastUpdated": "2025-09-26T14:37:00.940Z"
}
],
"dateCompleted": "2025-09-26T14:37:29.157Z"
}
}Get Profile
Returns the report data for a specific individual
curl --request GET \
--url https://vanguard.profilebehavior.com/api/v4/profile/{profileId} \
--header 'Authorization: Bearer <token>'{
"code": 200,
"profile": {
"id": "60e9ca73c500a9001534ad84",
"createdAt": "2025-09-26T13:49:53.256Z",
"updatedAt": "2025-09-26T14:37:29.157Z",
"email": "[email protected]",
"firstName": "John",
"lastName": "Doe",
"disc": {
"style": "CS",
"d": 34.66185580566288,
"i": 19.018670835970415,
"s": 66.40729193181404,
"c": 84.98081737824077
},
"core": {
"first": "freedom",
"second": "wealth",
"third": "wisdom",
"fourth": "familyHappiness",
"fifth": "achievement"
},
"focus": {
"flexibility": {
"score": 88,
"level": "veryHigh",
"facets": {
"creativity": {
"score": 100,
"level": "veryHigh"
},
"aestheticAppreciation": {
"score": 87,
"level": "veryHigh"
},
"emotionalAwareness": {
"score": 68,
"level": "high"
},
"innovativeness": {
"score": 75,
"level": "high"
},
"intellectualCuriosity": {
"score": 100,
"level": "veryHigh"
},
"openMindedness": {
"score": 100,
"level": "veryHigh"
}
}
},
"organization": {
"score": 78,
"level": "high",
"facets": {
"selfBelief": {
"score": 87,
"level": "veryHigh"
},
"systemization": {
"score": 75,
"level": "high"
},
"responsibility": {
"score": 68,
"level": "high"
},
"goalOriented": {
"score": 87,
"level": "veryHigh"
},
"discipline": {
"score": 50,
"level": "baseline"
},
"prudence": {
"score": 100,
"level": "veryHigh"
}
}
},
"communication": {
"score": 23,
"level": "low",
"facets": {
"friendliness": {
"score": 6,
"level": "veryLow"
},
"sociability": {
"score": 0,
"level": "veryLow"
},
"leadership": {
"score": 37,
"level": "low"
},
"vigor": {
"score": 37,
"level": "low"
},
"adventureSeeking": {
"score": 12,
"level": "veryLow"
},
"cheerfulness": {
"score": 50,
"level": "baseline"
}
}
},
"understanding": {
"score": 46,
"level": "baseline",
"facets": {
"trust": {
"score": 37,
"level": "low"
},
"integrity": {
"score": 50,
"level": "baseline"
},
"generosity": {
"score": 75,
"level": "high"
},
"teamwork": {
"score": 25,
"level": "low"
},
"humility": {
"score": 56,
"level": "baseline"
},
"compassion": {
"score": 37,
"level": "low"
}
}
},
"stability": {
"score": 81,
"level": "veryHigh",
"facets": {
"composure": {
"score": 68,
"level": "high"
},
"temperance": {
"score": 93,
"level": "veryHigh"
},
"optimism": {
"score": 81,
"level": "veryHigh"
},
"confidence": {
"score": 56,
"level": "baseline"
},
"selfControl": {
"score": 93,
"level": "veryHigh"
},
"resilience": {
"score": 93,
"level": "veryHigh"
}
}
}
},
"availableAssessments": [
"64b935448d1d9b54cb9cb5d5",
"6047fca80001b34e77245e71",
"6047fcba0001b34e77245e73"
],
"completedAssessments": [
"64b935448d1d9b54cb9cb5d5",
"6047fca80001b34e77245e71",
"6047fcba0001b34e77245e73"
],
"isCompleted": true,
"dateStarted": "2025-09-26T13:49:53.255Z",
"timers": [
{
"assessment": "64b935448d1d9b54cb9cb5d5",
"isCompleted": true,
"activeSeconds": 522,
"inactiveSeconds": 49,
"dateStarted": "2025-09-26T14:18:01.343Z",
"dateCompleted": "2025-09-26T14:27:25.489Z",
"lastUpdated": "2025-09-26T14:27:01.890Z"
},
{
"assessment": "6047fca80001b34e77245e71",
"isCompleted": true,
"activeSeconds": 318,
"inactiveSeconds": 43,
"dateStarted": "2025-09-26T14:27:28.496Z",
"dateCompleted": "2025-09-26T14:33:27.569Z",
"lastUpdated": "2025-09-26T14:32:59.021Z"
},
{
"assessment": "6047fcba0001b34e77245e73",
"isCompleted": true,
"activeSeconds": 210,
"inactiveSeconds": 0,
"dateStarted": "2025-09-26T14:33:30.446Z",
"dateCompleted": "2025-09-26T14:37:27.650Z",
"lastUpdated": "2025-09-26T14:37:00.940Z"
}
],
"dateCompleted": "2025-09-26T14:37:29.157Z"
}
}customId can be used in place of the profileId when querying.Querying with Custom IDs
- If querying with a
customIdthis endpoint will return an array of profiles matching that ID versus a single document when querying with aprofileId. - If a
customIdhas only been applied to one profile, querying by that ID will still return an array with that single profile included.
Authorizations
Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
Path Parameters
ID of the profile to retrieve
Response
Success
Standard response object for successful single-resource requests in the Profile Behavior API. Contains an HTTP status code, the returned resource data, and a status indicator.
HTTP status code of the successful response.
Always "success" for successful responses.
success Base schema that provides unique identification and timestamp metadata for resources in the Profile Behavior API.
Represents a behavioral assessment report for an individual.
Show child attributes
Show child attributes
Globally unique identifier for this resource.
ISO 8601 timestamp indicating when the resource was created.
ISO 8601 timestamp indicating when the resource was last updated.
The email associated with the individual's profile.
The individual's given name.
The individual's surname.
The URL of the uploaded avatar image of the profile.
A list of assessment ids that are available for the profile to take.
A list of assessment ids that the profile has completed.
The results of the Focus assessment for the profile.
Represents a record of Focus assessment results.
Show child attributes
Show child attributes
Results for the Flexibility Focus domain.
Show child attributes
Show child attributes
The score for the Flexibility domain ranging between 0-100.
A value which describes which quintile the score falls into.
veryLow, low, baseline, high, veryHigh The facets of the Flexibility domain.
Show child attributes
Show child attributes
Show child attributes
Show child attributes
The score for the Creativity facet ranging between 0-100.
A value which describes which quintile the score falls into.
veryLow, low, baseline, high, veryHigh Show child attributes
Show child attributes
The score for the Aesthetic Appreciation facet ranging between 0-100.
A value which describes which quintile the score falls into.
veryLow, low, baseline, high, veryHigh Show child attributes
Show child attributes
The score for the Emotional Awareness facet ranging between 0-100.
A value which describes which quintile the score falls into.
veryLow, low, baseline, high, veryHigh Show child attributes
Show child attributes
The score for the Innovativeness facet ranging between 0-100.
A value which describes which quintile the score falls into.
veryLow, low, baseline, high, veryHigh Show child attributes
Show child attributes
The score for the Intellectual Curiosity facet ranging between 0-100.
A value which describes which quintile the score falls into.
veryLow, low, baseline, high, veryHigh Show child attributes
Show child attributes
The score for the Open-Mindedness facet ranging between 0-100.
A value which describes which quintile the score falls into.
veryLow, low, baseline, high, veryHigh Results for the Organization Focus domain.
Show child attributes
Show child attributes
The score for the Organization domain ranging between 0-100.
A value which describes which quintile the score falls into.
veryLow, low, baseline, high, veryHigh The facets of the Organization domain.
Show child attributes
Show child attributes
Show child attributes
Show child attributes
The score for the Self-Belief facet ranging between 0-100.
A value which describes which quintile the score falls into.
veryLow, low, baseline, high, veryHigh Show child attributes
Show child attributes
The score for the Systemization facet ranging between 0-100.
A value which describes which quintile the score falls into.
veryLow, low, baseline, high, veryHigh Show child attributes
Show child attributes
The score for the Responsibility facet ranging between 0-100.
A value which describes which quintile the score falls into.
veryLow, low, baseline, high, veryHigh Show child attributes
Show child attributes
The score for the Goal-Oriented facet ranging between 0-100.
A value which describes which quintile the score falls into.
veryLow, low, baseline, high, veryHigh Show child attributes
Show child attributes
The score for the Discipline facet ranging between 0-100.
A value which describes which quintile the score falls into.
veryLow, low, baseline, high, veryHigh Show child attributes
Show child attributes
Results for the Communication Focus domain.
Show child attributes
Show child attributes
The score for the Communication domain ranging between 0-100.
A value which describes which quintile the score falls into.
veryLow, low, baseline, high, veryHigh The facets of the Communication domain.
Show child attributes
Show child attributes
Show child attributes
Show child attributes
The score for the Friendliness facet ranging between 0-100.
A value which describes which quintile the score falls into.
veryLow, low, baseline, high, veryHigh Show child attributes
Show child attributes
The score for the Sociability facet ranging between 0-100.
A value which describes which quintile the score falls into.
veryLow, low, baseline, high, veryHigh Show child attributes
Show child attributes
The score for the Leadership facet ranging between 0-100.
A value which describes which quintile the score falls into.
veryLow, low, baseline, high, veryHigh Show child attributes
Show child attributes
Show child attributes
Show child attributes
The score for the Adventure-Seeking facet ranging between 0-100.
A value which describes which quintile the score falls into.
veryLow, low, baseline, high, veryHigh Show child attributes
Show child attributes
The score for the Cheerfulness facet ranging between 0-100.
A value which describes which quintile the score falls into.
veryLow, low, baseline, high, veryHigh Results for the Understanding Focus domain.
Show child attributes
Show child attributes
The score for the Understanding domain ranging between 0-100.
A value which describes which quintile the score falls into.
veryLow, low, baseline, high, veryHigh The facets of the Understanding domain.
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
The score for the Integrity facet ranging between 0-100.
A value which describes which quintile the score falls into.
veryLow, low, baseline, high, veryHigh Show child attributes
Show child attributes
The score for the Generosity facet ranging between 0-100.
A value which describes which quintile the score falls into.
veryLow, low, baseline, high, veryHigh Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
The score for the Compassion facet ranging between 0-100.
A value which describes which quintile the score falls into.
veryLow, low, baseline, high, veryHigh Results for the Stability Focus domain.
Show child attributes
Show child attributes
The score for the Stability domain ranging between 0-100.
A value which describes which quintile the score falls into.
veryLow, low, baseline, high, veryHigh The facets of the Stability domain.
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
The score for the Self-Control facet ranging between 0-100.
A value which describes which quintile the score falls into.
veryLow, low, baseline, high, veryHigh Show child attributes
Show child attributes
The results of the DISC assessment for the profile.
Represents a record of DISC assessment results.
Show child attributes
Show child attributes
A letter style which represents which of the DISC behavioral styles used to understand individual preferences and tendencies are scored over 50 and ordered by intensity.
A score for the Dominance DISC behavioral trait ranging between 0-100.
A score for the Influence DISC behavioral trait ranging between 0-100.
A score for the Steadiness DISC behavioral trait ranging between 0-100.
A score for the Correctness DISC behavioral trait ranging between 0-100.
The results of the Core assessment for the profile.
Represents a record of Core assessment results.
Show child attributes
Show child attributes
The name of the value ranked first for a scored Core assessment.
The name of the value ranked second for a scored Core assessment.
The name of the value ranked third for a scored Core assessment.
The name of the value ranked fourth for a scored Core assessment.
The name of the value ranked fifth for a scored Core assessment.
Whether the profile has been flagged as completed.
When the individual started taking the assessments.
When the individual completed the available assessments.
An array of timers used for measuring time spent engaging with each assessment.
Show child attributes
Show child attributes
The ID of the assessment associated with the timer.
Whether the assessment has been finished and scored.
Seconds spent actively taking the assessment, meaning seconds the individual spent engaged with the assessment while accounting for time for thinking.
Seconds spent inactive while taking the assessment, meaning seconds the individual spent idling and not actively engaging with the assessment.
When the individual started taking the associated assessment.
When the individual submitted their answers for scoring for the associated assessment.
The last the timer was updated which can indicate ongoing participation for an in-progress assessment.
Was this page helpful?