How do I use the Crystal API?

Crystal's API allows you to enrich your own applications and internal systems with personality data.

Table of Contents

View full API documentation here

Overview

The Crystal API is available for enterprise accounts and provides two main services: 

  • The Profile API allows you to search our dataset for personality profiles by email and LinkedIn URL. Access to this endpoint is billed by annual usage. 
  • The Analysis API  allows you to send Crystal your own text samples to generate personality predictions and return enough insights to construct a personality profile of your own. Access to this endpoint is billed by annual usage. 

Activate your Token

Please contact your Customer Success Manager for your API token. 

Getting Started

Every request requires this header:

Authorization: Bearer YOUR_TOKEN

Profile API

The Profile API enables you to access Crystal's personality database, so you can enrich your CRM, build personality data into your own applications, and more.

GET /v1/profiles

Query Parameters:

linkedin_url: string - a full LinkedIn URL of the person you're looking up. 

email: string - an email address of the person you're looking up. 

Response:

{
    "data": {
        "first_name": "Drew",
        "last_name": "D'Agostino",
        "photo_url": "https://photos.crystalknows.com/62e4eb161bc108cfa8b6e299d09077d7/1664563101/thumb_b967db42c360ed9ce5feb9c7644aee5e.png",
        "url": "https://www.crystalknows.com/p/62e317a4-7466-42cd-8dc1-6515538db7fe",
        "verified": true,
        "qualities": [
            "Independent",
            "Persuasive",
            "Assertive",
            "Determined",
            "Decisive"
        ],
        "personalities": {
            "archetype": "Driver",
            "disc_type": "Di",
            "disc_intensity": 75,
            "disc_percentages": {
                "d": 72,
                "i": 22,
                "s": 4,
                "c": 2
            },
            "enneagram_type": "7",
            "myers_briggs_type": "ENFP"
        },
        "images": {
            "disc_map": "https://api.crystalknows.com/images/disc_map/6.png"
        },
        "content": {
            "profile": {
                "overview": [
                    "This person tends to be direct, task-focused, fast-paced, and resistant to rigid structures.",
                    "This person is likely to be comfortable with direct communication, taking the lead in groups, and taking calculated risks. ",
                    "This person tends to communicate directly and make decisions independently, sometimes disregarding existing structures or standards.",
                    "This person tends to be enthusiastic and decisive, with a strong preference for autonomy. ",
                    "This person tends to be fast-paced, goal-oriented, direct, persuasive, and may seem overly blunt at times."
                ]
            },
            "behavior": {
                "phrase": [
                    "Saying something bluntly without details",
                    "Driving others to action",
                    "Speaking up to get everyone back on topic in a meeting",
                    "Feeling anxious about someone else making decisions on their behalf",
                    "Immediately projecting assertiveness and confidence"
                ]
            },
            "motivation": {
                "phrase": [
                    "Taking charge",
                    "Ambitious goals",
                    "Challenges",
                    "Making quick decisions",
                    "Professional growth"
                ]
            },
            "drainer": {
                "phrase": [
                    "Keeping their opinion to themselves",
                    "Deep research and analysis",
                    "Slow pace of work",
                    "Failing to achieve goals",
                    "Following inflexible rules"
                ]
            },
            "communication": {
                "phrase": [
                    "Don't be afraid to disagree",
                    "Keep conversation brief",
                    "Get right to the bottom line",
                    "Avoid being quiet or reserved",
                    "Assert yourself with confidence"
                ]
            },
            "meeting": {
                "phrase": [
                    "Quickly address the purpose of the meeting",
                    "Prepare for pushback",
                    "Keep it as short as possible",
                    "Make an effort to meet their goals",
                    "Stay on topic"
                ]
            },
            "selling": {
                "phrase": [
                    "Make an effort to focus the conversation",
                    "Project confidence",
                    "Don't be thrown off by a blunt comment",
                    "Ask about their goals",
                    "Expect them to offer feedback"
                ]
            },
            "working_together": {
                "phrase": [
                    "Give them a chance to take charge",
                    "Stay focused on the bottom line",
                    "Get used to a fast work pace",
                    "Always focus on the team's overall goal",
                    "Expect them to adapt quickly to change"
                ]
            },
            "recommendations": {
                "do": [
                    "Use an energetic, assertive tone",
                    "Highlight competitive advantages of your product",
                    "Speak with high energy and answer questions directly"
                ],
                "dont": [
                    "Don't be overly friendly; be assertive and push back when you need to",
                    "Don't sugarcoat or use vague, overly-optimistic language to describe the value of your product",
                    "Don't give in-depth product descriptions without explaining bottom-line impact"
                ]
            }
        },
      "hiring": []
    }
}

Text Analysis API

The Text Analysis API enables you to generate DISC-based personality predictions from a single block of text, associated with a single author. The text block may include details from a resume, social media profile, CRM contact record, or aggregated set of tags from a contact-enrichment provider. 

GET /v1/analysis/text

Query Parameters:

text: string - a block of text with labels from a resume and/or social media profile (like job titles, experiences, interests, skills, qualities, and bio).  

Response:

{
"data": {
"personalities": {
"disc_type": "C"
},
"images": {
"disc_map": "https://api.crystalknows.com/images/disc_map/11.png"
},
"content": {
"profile": {
"overview": [
"This person is likely very curious and prefers to tackle challenging, complex problems. ",
"This person tends to be direct in verbalizing concerns without leaving anything up for interpretation, occasionally being blunt with feedback.",
"This person is often intrigued by complex problems that require a comprehensive, precise solution in order to be solved.",
"This person is primarily driven by logic: accurate, task-oriented, cautious, and logical decision-making.",
"This person tends to be a problem solver who values logic, reason, and debate. "
]
},
"behavior": {
"phrase": [
"Having a well-organized area",
"Making decisions based on logical analysis",
"Experimenting with many solutions to a problem",
"Providing clear expectations and guidelines",
"Enjoying thorough spreadsheets"
]
},
"motivation": {
"phrase": [
"Accuracy & precision",
"Fixing problems",
"Order and organization",
"Being correct",
"Finding the best possible outcome"
]
},
"drainer": {
"phrase": [
"Meeting lots of new people at once",
"Major or unexpected change",
"Unreliable, unproven information",
"When people disregard the rules",
"Dealing with emotionally charged issues"
]
},
"communication": {
"phrase": [
"Start conversations with an issue to resolve",
"Provide your reasoning before you get to the bottom line",
"Remain logical and objective",
"Ask lots of questions to keep their attention",
"Trust that they will follow specific verbal instructions"
]
},
"meeting": {
"phrase": [
"Take time to thoroughly explain your idea",
"Focus solely on the topic at hand",
"Answer every question as precisely as possible",
"Do your homework before a meeting",
"Schedule your meetings at a precise time"
]
},
"selling": {
"phrase": [
"Make sure you're prepared for tough questions",
"Explain how your product works",
"Speak with clarity and specificity",
"Present proven facts and statistics instead of stories",
"Ask them what problem they is trying to solve"
]
},
"working_together": {
"phrase": [
"Demonstrate your expertise",
"Count on them to keep things on track",
"Recognize and trust his skill",
"Set clear expectations",
"Allow your ideas to be put to the test"
]
}
}
}
}

To activate API access on your account, please reach out to us at hello@crystalknows.com.