Dictionary: Real-time Employee API

Overview

Data dictionary for data retrieved using Real-time Employee API endpoints. This data dictionary lists all available data fields, explains their values, and provides sample data from the Real-time Employee API.

Data fields per category

1. Root table

2. Also viewed

3. Awards

4. Certifications

5. Courses

6. Suggested courses

7. Hidden details

8. Education

9. Experience

10. Languages

11. Organizations

12. Patents

13. Projects

14. Publications

15. Recommendations

16. Similar profiles

17. Others named

18. Test scores

19. Volunteering positions

20. Websites

21. Activity

The data provided in the samples is strictly intended for illustrative purposes, allowing you to visualize its appearance and format.

Data fields

Root table

Data field	Description	Data type
full_name	Full name	String
first_name	First name	String
last_name	Last name	String
public_profile_id	Professional network provided employee URL	String
profile_photo_url	Profile photo URL	String
headline	The title found in the profile headline – not directly related to any particular work experience	String
profile_url	Profile URL	String
location	Associated location	String
summary	Professional experience summary Note: contains HTML tags	String
recommendations_count	Number of recommendations the member has received	Number (integer)
updated_at	Time and date when we parsed the record HTML	Timestamp
country	Parsed country Note: parsed by us from the location value	String
connections_count	Active connection count	Number (integer)
shorthand_name	Employee profile identifier in the URL. Note: can be changed at any time by the member	String
canonical_shorthand_name	Most recent version of the shorthand_name	String
experience_count	Number of experience records visible on the profile	Number (integer)
deleted	Marks if the profile is publicly available. 1 – the last time we scraped the profile, the Page not found was returned, or a particular record was deleted from the profile. 0 – the last time we scraped the profile, the record was added to our data and marked with the value of 0	Integer
follower_count	Follower count	Number (integer)
services	Service offering	String

See a snippet of the dataset for reference:

Employee data

"full_name": "John Doe",
"first_name": "John",
"last_name": "Doe",
"public_profile_id": "123456700",
"headline": "Best service at Example company",
"profile_url": "https://www.professional-network.com/john-doe",
"location": "Greater Sacramento",
"summary": "Results driven and a Sacramento native for over 20 years. Proven track record with over 1000 units closed.",
"recommendations_count": 3,
"updated_at": "2025-09-30T00:00:00.000000Z",
"country": "United States",
"connections_count": 500,
"shorthand_name": "john-doe",
"canonical_shorthand_name": "john-doe",
"experience_count": 5,
"deleted": 0,
"follower_count": 300,
"services": "Customer Service, Commercial Real Estate, Real Estate, Relocation, Property Management, Strategic Planning",

Also viewed

Data field	Description	Data type
also_viewed	Other employee profiles viewed in the same session as the record profile	Array of objects
full_name	Employee's full name	String
profile_url	Profile URL	String
headline	Profile title Note: not directly related to any particular work experience	String
location	Associated location	String
order_in_profile	Section record order	Number (integer)

See a snippet of the dataset for reference:

Also viewed

"also_viewed": [
    {
       "full_name": "Jane Smith",
       "profile_url": "https://www.professional-network.com/jane-smith",
       "headline": "Coldwell Banker Residential Brokerage",
       "location": "Los Angeles, CA",
       "order_in_profile": 1
    }
],

Awards

Data field	Description	Data type
awards	Held awards	Array of objects
title	Award title	String
issuer	Award issuer	String
description	Award description Note: contains HTML tags	String
date	Issue data	String
order_in_profile	Section record order	Number (integer)

See a snippet of the dataset for reference:

Awards

"awards": [
   {
      "title": "Elite Property Pro Award",
      "issuer": "International Association of Real Estate Professionals (IAREP)",
      "description": "This award is a testament to John Doe's unwavering dedication to helping clients achieve their real estate dreams. His professionalism, integrity, and exceptional service have set new standards in the industry.",
      "date": "Aug 2025",
      "order_in_profile": 1
   }
],

Certifications

Data field	Description	Data type
certifications	Held certifications	Array of objects
title	Certification title	String
issuer	Certification issuer	String
credential_id	Credential ID assigned by Professional network	String
certificate_url	Certification URL	String
date_from	Certification issue date	String
date_to	Certification expiry date	String
issuer_url	Institution profile URL	String
order_in_profile	Section record order	Number (integer)
certificate_logo_url	Certificate logo url	String

See a snippet of the dataset for reference:

Certifications

"certifications": [
    {
        "title": "Certified Sales Excellence Professional (CSEP)",
        "issuer": "Global Sales Institute",
        "credential_id": "GG1234",
        "certificate_url": "https://www.professional-network.com/redirect/certified-example",
        "date_from": "Sep 2022",
        "date_to": "Sep 2022",
        "issuer_url": "https://www.professional-network.com/global-sales-institute",
        "order_in_profile": 1,
        "certificate_logo_url": "https://example.com/image/certificate_logo"
    }
],

Courses

Data field	Description	Data type
courses	Courses associated with professional experience	Array of objects
organizer	Course organizer	String
title	Course name	String
order_in_profile	Section record order	Number (integer)

See a snippet of the dataset for reference:

Courses

"courses": [
    {
       "organizer": "Independent Coursework",
       "title": "Organisarional Analysis;Digital Business and Workplace Technologies;Enterprise Systems Development;Knowledge, Work and Innovation;Global Sourcing and Innovation",
       "order_in_profile": 1
    }
],

Suggested courses

Data field	Description	Data type
course_suggestions	Suggested courses	Array of objects
title	Course name	String
course_url	Course URL	String
order_in_profile	Section record order	Number (integer)

See a snippet of the dataset for reference:

Suggested courses

"course_suggestions": [
    {
        "course_url": "https://www.professional-network.com/learning-confluence-administration",
        "title": "Learning Confluence Administration",
        "order_in_profile": 1
    }
],

Hidden details

Data field	Description	Data type
hidden_details	Information hidden or blurred by Professional network	Array of objects
hidden_collection	Hidden collection (e.g., education, experience)	String

Hidden details

"hidden_details": [
    {
      "hidden_collection": "education"
    },
    {
      "hidden_collection": "experience"
    }
],

If certain details are hidden in the employee profile (such as experience or education information), the collections will contain institution/company_name and, optionally, the company_url/institution_url values, while other values will be seen as null.

Education

Data field	Description	Data type
education	Education details	Array of objects
institution	Education institution/school	String
program	Program name	String
date_from	Education start date	String
date_to	Education end date	String
activities_and_societies	Activities and societies the member took part in	String
description	Education experience described by the member Note: contains HTML tags	String
institution_url	Institution profile	String
institution_shorthand_name	Institution shorthand name	String
order_in_profile	Section record order	Number (integer)

See a snippet of the dataset for reference:

Education

"education": [
    {
        "institution": "Example State University",
        "program": "Social Sciences",
        "date_from": "2023",
        "date_to": "2024",
        "activities_and_societies": "Social Ambassador",
        "description": "Improved knowledge in social sciences",
        "institution_url": "https://www.professional-network.com/example-state-university/",
        "institution_shorthand_name": "example-state-university",
        "order_in_profile": 1
    }
],

Experience

Data field	Description	Data type
experience	Work experience	Array of objects
title	Job title	String
location	Job (company) location	String
company_name	Company name	String
company_url	Employer's Professional network profile	String
company_shorthand_name	Employer's shorthand name	String
date_from	Employment start date	String
date_to	Employment end date	String
is_current	Marks if the experience is ongoing (current member workplace) 1 – Current workplace 0 – Former workplace	Integer
duration	Employment duration	String
description	Job/job experience description Note: contains HTML tags	String
order_in_profile	Section record order	Number (integer)
company_logo_url	URL pointing to the logo of the company/employer	String

See a snippet of the dataset for reference:

Experience

"experience": [
    {
        "title": "CEO of The Realty Company",
        "location": "Roseville, California, United States",
        "company_name": "The Realty Company",
        "company_url": "https://www.professional-network.com/the-realty-company",
        "company_shorthand_name": "the-realty-company",
        "date_from": "Jan 2024",
        "date_to": null,
        "is_current": 1,
        "duration": "2 years 9 months",
        "description": "CEO of the Real Estate Group",
        "order_in_profile": 1,
        "company_logo_url": "https://media.licdn.com/example-company-logo-image/"
    }
],

Languages

Data field	Description	Data type
languages	Listed languages	Array of objects
language	Language	String
proficiency	Language proficiency	String
order_in_profile	Section record order	Number (integer)

See a snippet of the dataset for reference:

Languages

"languages": [
    {
        "language": "English",
        "proficiency": "Professional working proficiency",
        "order_in_profile": 1
    }
],

Organizations

Data field	Description	Data type
organizations	Associated organizations	Array of objects
organization	Organization Note: Contains HTML tags	String
position	Position in the organization Note: Contains HTML tags	String
description	Description of the activity/experience in the organization	String
date_from	Membership start date	String
date_to	Membership end date	String
order_in_profile	Section record order	Number (integer)

See a snippet of the dataset for reference:

Organizations

"organizations": [
    {
        "organization": "National Realtor Organization",
        "position": "Realtor",
        "description": "Sharing the best practices, current market trends and industry specific ongoing education.",
        "date_from": "Feb 2023",
        "date_to": "Feb 2025",
        "order_in_profile": 1
    }
],

Patents

Data field	Description	Data type
patents	Registered patents	Array of objects
title	Patent title	String
status	Patent status	String
inventors	Patent inventors	Array of objects
full_name	Inventor's name	String
profile_url	Inventor's profile URL	String
order_in_profile	Section record order	Number (integer)
date	Patent filling date	String
patent_url	Patent URL	String
description	Patent description Note: contains HTML tags	String
patent_or_application_number	Patent details, such as the area the patent is valid in	Array of strings
order_in_profile	Section record order	Integer

See a snippet of the dataset for reference:

Patents

"patents": [
    {
        "title": "Real Estate Solutions",
        "status": "Issued",
        "inventors": [
            {
                "name": "James Doe",
                "profile_url": null, 
                "order_in_profile": 1
            },
            {
                "name": "Jane Smith",
                "profile_url": "https://www.professional-network.com/jane-smith",
                "order_in_profile": 2
            }
        ],
        "date": "June 18, 2015",
        "patent_url": "https://www.professional-network.com/redir/redirect/real-estate-solutions",
        "description": "This is a patent designed to change the industry by integrating new technologies and algorithms.",
        "patent_or_application_number": "United States NO123456789",
        "order_in_profile": 1
    }
],

Projects

Data field	Description	Data type
projects	Associated projects	Array of objects
name	Project name	String
project_url	Project website URL	String
description	Project description Note: contains HTML tags	String
date_from	Project start date	String
date_to	Project end date	String
team_members	Additional people who have worked on the project	Array of objects
full_name	Team member's name	String
profile_url	Team member's Professional network profile URL	String
order_in_profile	Section record order	Number (integer)

See snippets of the dataset for reference:

Projects

"projects": [
    {
        "name": "Residences at Example Park",
        "project_url": "https://professional-network.com/redirect/project/residences",
        "description": "This project is a residential living with a focus on natural and green spaces",
        "date_from": "Jan 2021",
        "date_to": "May 2022",
        "order_in_profile": 1,
        "team_members": [
            {
                "full_name": "John Doe",
                "profile_url": "https://www.professional-network.com/john-doe",
                "order_in_profile": 1
            }
        ]
    }
]

Publications

Data field	Description	Data type
publications	Authored publications	Array of objects
title	Publication title	String
publisher	Publication publisher	String
date	Publication release date	String
description	Publication description Note: contains HTML tags	String
authors	Publication authors	Array of objects
full_name	Author's name	String
profile_url	Author's profile URL	String
order_in_profile	Section record order	Number (integer)
publication_url	Publication website URL	String

See a snippet of the dataset for reference:

Publications

"publications": [
    {
        "title": "Sustainable Living",
        "publisher": "Example Publishing",
        "date": "January 1, 2019",
        "description": "Environmentally conscious real estate projects aim to redefine sustainable living.",
        "authors": [
            {
                "full_name": "John Smith",
                "profile_url": "https://www.professional-network.com/john-smith", 
                "order_in_profile": 1
            },
            {
                "full_name": "Jane Doe",
                "profile_url": "https://www.professional-network.com/jane-doe", 
                "order_in_profile": 2
            }
        ],
        "publication_url": "https://www.professional-network.com/redirect/publication/sustainable-living",
        "order_in_profile": 1
    }
],

Recommendations

Data field	Description	Data type
recommendations	Recommendations from other Professional network users	Array of objects
recommendation	Recommendation text	String
full_name	Referee's name	String
referee_url	Referee's profile URL	String
order_in_profile	Section record order	Number (integer)

See a snippet of the dataset for reference:

Recommendations

"recommendations": [
   {
       "recommendation": "I have worked with John and he is a Pro.",
       "full_name": "Jane Smith",
       "referee_url": "https://www.professional-network.com/jane-smith", 
       "order_in_profile": 1
   }
],

Similar profiles

Data field	Description	Data type
similar_profiles	Profiles similar to the profile in the record	Array of objects
profile_url	Profile URL	String
full_name	Employee's name	String
headline	Featured profile title Note: not directly related to any particular work experience	String
location	Associated location	String
order_in_profile	Section record order	Number (integer)

See a snippet of the dataset for reference:

Similar profiles

"similar_profiles": [
    {
        "profile_url": "https://www.professional-network.com/jane-doe",
        "full_name": "Jane Doe",
        "headline": "Owner, Example-tech",
        "location": "Roseville, CA",
        "order_in_profile": 1
    }
],

Others named

Data field	Description	Data type
others_named	List of employees with similar or exact name	Array of objects
profile_url	Profile URL	String
full_name	Full name	String
headline	Profile headline Note: not directly related to any particular work experience	String
location	Displayed location	String
order_in_profile	Section record order	Number (integer)

Others named

"others_named": [
    {
      "profile_url": "www.professional-network.com/jane-doe",
      "full_name": "Jane Doe",
      "headline": "Senior Data Scientist at Tech Corp",
      "location": "New York, NY",
      "order_in_profile": 1
    }
  ]

Test scores

Data field	Description	Data type
test_scores	Test scores	Array of objects
title	Test title	String
date	Test date	String
description	Test description	String
score	Test score	String
order_in_profile	Section record order	Number (integer)

See a snippet of the dataset for reference:

Test scores

"test_scores": [
   {
       "title": "Certified Realty Expert (CRE) Examination",
       "date": "June 2014",
       "description": "Exam to become an accredited mentor in business.",
       "score": "Score: 8",
       "order_in_profile": 1
   }
],

Volunteering positions

Data field	Description	Data type
volunteering_positions	Volunteering activity	Array of objects
organization	Associated volunteering organization	String
role	Role in the organization	String
cause	Volunteering cause	String
date_from	Volunteering start date	String
date_to	Volunteering end date	String
duration	Volunteering activity duration	String
description	Volunteering experience description Note: contains HTML tags	String
organization_url	Organization's profile on Professional network	String
organization_shorthand_name	Organization's shorthand name	String
order_in_profile	Section record order	Number (integer)

See a snippet of the dataset for reference:

Volunteering positions

"volunteering_positions": [
    {
        "organization": "Example Fund",
        "role": "Consultant",
        "cause": "Children",
        "date_from": "Jan 2017",
        "date_to": "Jan 2022",
        "duration": "5 years 1 month",
        "description": "I had some great conversations with people about life",
        "organization_url": null,
        "organization_shorthand_name": null,
        "order_in_profile": 1
    }
],

Websites

Data field	Description	Data type
websites	Listed websites	Array of objects
personal_website	Website URL	Object
order_in_profile	Section record order	Number (integer)

See a snippet of the dataset for reference:

Websites

"websites": [
      {
        "personal_website": "https://www.professional-network.com/redirect/public_profile_website1", 
        "order_in_profile": 1,
      },
      {
        "personal_website": "https://www.professional-network.com/redirect/public_profile_website2",
        "order_in_profile": 2
      }
  ],

Acitivity

Data field	Description	Data type
activity	User's interaction with posts on Professional network	Array of objects
activity_url	Post URL	String
title	Post title Note: contains control characters	String
action	Interaction type	String
order_in_profile	Section record order	Number (integer)

See a snippet of the dataset for reference:

Activity

"activity": [
      {
        "activity_url": "https://www.professional-network.com/analytics-jobs-activity",
        "title": "EXample is looking for Analytics and Consultants",
        "action": "Liked by",
        "order_in_profile": 1
      }
  ],