v1

latestOpenAPI 3.0.0http://www.apache.org/licenses/LICENSE-2.0.html2026-07-14543167.2 KB
users

Return an array of all users within a Heartbeat community

get/users

Response

Successful response

idstring uuid
emailstring email
namestring

The user's full name

firstNamestring

The user's first name

lastNamestring

The user's last name

rolestring

The user's current role

isAdminboolean

Whether or not the user is an administrator

biostring

The user's Heartbeat bio

avatarstring uri

A URL that points to the user's Heartbeat avatar

linkedInSummarystring

A single formatted string containing the user's entire LinkedIn history. Empty if no LinkedIn data is available

Example response

[
  {
    "email": "dmoney@schrutefarms.com",
    "name": "Dwight Schrute",
    "firstName": "Dwight",
    "lastName": "Schrute",
    "role": "Moderator",
    "groups": [
      {
        "name": "Party Planning Committee"
      }
    ],
    "onboardingResponses": [
      {
        "question": "Where are you from?",
        "answer": "I'm from Seattle"
      }
    ],
    "bio": "I'm the best salesman at Dunder Mifflin",
    "linkedInData": {
      "profileUrl": "https://www.linkedin.com/in/dwight-schrute/",
      "headline": "Ready to crush your sales quotas",
      "company": "Dunder Mifflin",
      "description": "I'm a motivated salesman always willing to go the extra mile",
      "location": "Scranton, Pennsylvania, United States",
      "jobs": [
        {
          "companyName": "Dunder Mifflin",
          "jobTitle": "Assistant to the Regional Manager",
          "location": "Scranton, Pennsylvania, United States",
          "dateRange": "Mar 2005 - May 2013 OR May 2014 - Present"
        }
      ],
      "schools": [
        {
          "schoolName": "Scranton University",
          "degree": "Bachelor's Degree",
          "degreeSpec": "Business Administration",
          "dateRange": "Aug 1988 - May 1992"
        }
      ],
      "skills": [
        "Beet Farming",
        "German"
      ]
    }
  }
]