Assessments

Make a GET request to /assessments to retrieve a list of the JOFI assessments.

This route returns the real assessment catalog even when you use a test API key (sk_test_...). See API Keys.

GET /assessments

{
    "mode": "live",
    "object": "list",
    "total_count": 4,
    "has_more": false,
    "data": [
        {
            "object": "assessment_list_item",
            "id": 1,
            "short_name": "Prescreen",
            "display_name": "JOFI Quick Prescreen"
        },
        {
            "object": "assessment_list_item",
            "id": 6,
            "short_name": "Personality",
            "display_name": "JOFI Personality Traits"
        },
        {
            "object": "assessment_list_item",
            "id": 7,
            "short_name": "Thinking",
            "display_name": "JOFI Thinking Skills"
        },
        {
            "object": "assessment_list_item",
            "id": 8,
            "short_name": "Interests",
            "display_name": "JOFI Career Interests"
        }
    ]
}

Response fields

List envelope

Field	Description
mode	"live" or "test" depending on your API key
object	Always "list"
total_count	Total number of assessments in the JOFI catalog
has_more	true if more items exist beyond the current page
data	Array of assessment_list_item objects

assessment_list_item fields

Field	Description
object	Always "assessment_list_item"
id	Assessment ID. Use as test_id in assessments_to_assign on invitations.
short_name	Short assessment name (for example, "Personality")
display_name	Full assessment name