# Data Dictionary: Base Employee API This data dictionary shows all available data fields, explains their values, and provides snippets of Base Employee data. {% tabs %} {% tab title="Data fields per category" %} 1. [Root table](#root-table) 2. [Awards](#awards) 3. [Certifications](#certifications) 4. [Courses](#courses) 5. [Course suggestions](#course-suggestions) 6. [Education](#education) 7. [Experience](#experience) 8. [Languages](#languages) 9. [Organizations](#organizations) 10. [Patents](#patents) 11. [Projects](#projects) 12. [Publications](#publications) 13. [Recommendations](#recommendations) 14. [Similar profiles](#similar-profiles) 15. [Others named](#others-named) 16. [Test scores](#test-scores) 17. [Volunteering positions](#volunteering-positions) 18. [Websites](#websites) 19. [Activity](#activity) 20. [Inferred skills](#inferred-skills) {% endtab %} {% endtabs %} {% hint style="info" %} All personal/company information mentioned within this context is entirely fictional and is solely intended for illustrative purposes. {% endhint %} ## Data fields ### Root table
Data fieldDescriptionData type
idRecord identification keyLong
parent_idEmployee profile identification keyLong
is_parentRepresents if the employee ID is the original ID in our dataset (not a duplicate)
1 – original ID
0 – duplicate ID		Number (integer)
full_nameFull nameString
first_nameFirst nameString
last_nameLast nameString
headlineEmployee headlineString
profile_urlEmployee profile URLString
shorthand_name

Part of the Professional network employee URL used to identify employee profiles

Note: can be changed at any time by the user

String
canonical_shorthand_nameThe most recent version of the shorthand_nameString
created_atRecord creation timestamp in ISO 8601 formatString (date)
updated_atRecord update timestamp in ISO 8601 formatString (date)
checked_atTimestamp of the last time the profile was checked for key changes in ISO 8601 formatString (date)
received_atTimestamp when the profile was found on Professional networkString (date)
deletedStatus indicating if the profile is publicly available:
1 – The last time we scraped the profile, the page that was not found was returned.
0 – The last time we scraped the profile, the record was added to our data and marked with the value 0		Number (integer)
public_profile_idProfessional network provided employee URLString
profile_photo_urlProfile photo URLString
summaryProfessional experience summaryString
locationDisplayed locationString
cityEmployee location cityString
stateEmployee location stateString
countryDisplayed location (country) parsed by us from the location valueString
country_iso_2ISO 3166-1 alpha-2 country codeString
country_iso_3ISO 3166-1 alpha-3 country codeString
connections_countNumber of active connectionsNumber (integer)
recommendations_countNumber of recommendationsInteger
follower_countEmployee followers countNumber (integer)
industry

Associated industry

Note: legacy field

String
servicesOffered servicesString
experience_countNumber of experience recordsNumber (integer)
regionsRegion information (additional location information)Array of objects
regionLocation regionString
shorthand_namesA list of all historical shorthand_name that we capturedArray of objects
shorthand_nameCaptured shorthand nameString
historical_idsA list of all employee identification keys assigned to this recordArray of structs
idEmployee identification keyLong
**Refer to the table example from the data:** ```json { "id": 101, "parent_id": 101, "is_parent": 1, "full_name": "John Doe", "first_name": "John", "last_name": "Doe", "headline": "Software Engineer", "created_at": "2024-12-10T12:00:00Z", "updated_at": "2024-12-10T12:00:00Z", "checked_at": "2024-12-10T12:00:00Z", "public_profile_id": "422009225", "profile_url": "http://example.com/johndoe", "location": "New York, USA", "city": "New York", "state": "New York", "industry": "Technology", "summary": "Experienced software engineer with expertise in Python and Spark.", "services": "Consulting, Development", "profile_photo_url": "http://example.com/johndoe/photo.jpg", "deleted": 0, "country": "USA", "country_iso_2": "US", "country_iso_3": "USA", "recommendations_count": 10, "connections_count": 500, "follower_count": 1500, "experience_count": 5, "shorthand_name": "johndoe", "canonical_shorthand_name": "johndoe", "regions": [ { "region": "Northeast" } ], "shorthand_names": [ { "shorthand_name": "johndoe" } ], "historical_ids": [ { "id": 1001 } ] } ``` *** ### Awards | Data field | Description | Data type | | ------------------ | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------- | | `awards` | Awards | Array of objects | | `id` | Record UUID identifier | String | | `title` | Award title | String | | `issuer` | Award issuer | String | | `description` |

Award description
Note: contains HTML tags

| String | | `date` |

Issue date

Note: date format varies

| String (date) | | `date_year` | Issue year | Number (integer) | | `date_month` | Issue month | Number (integer) | | `date_day` | Issue day | Number (integer) | | `order_in_profile` | Section record order | Number (integer) | | `created_at` | Record creation timestamp in `ISO 8601` format | String (date) | | `updated_at` | Record update timestamp in `ISO 8601` format | String (date) | | `deleted` |

Status indicating if the record is publicly available:
1 – The record was publicly unavailable the last time we scraped the profile
0 – The last time we scraped the profile, the record was available and added to the profile's data

| Number (integer) | **See a snippet of the dataset for reference:** {% code title="Awards" %} ```json "awards": [ { "id": "c8f68c94-1c90-4b36-8e0e-905cf2e1283e", "title": "Best Innovator", "issuer": "Tech Conference 2023", "description": "Awarded for outstanding innovation in technology.", "date": "2023-11-15", "date_year": 2023, "date_month": 11, "date_day": 15, "order_in_profile": 1, "deleted": 0, "created_at": "2023-11-15T10:00:00Z", "updated_at": "2023-11-15T12:00:00Z" } ] ``` {% endcode %} ### Certifications | Data field | Description | Data type | | ---------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ---------------- | | `certifications` | Certifications | Array of objects | | `id` | Record UUID identifier | String | | `title` | Certification title | String | | `issuer` | Certification issuer | String | | `credential_id` | Credential identification key | String | | `certificate_url` | Certification URL | String | | `certificate_logo_url` | URL pointing to the logo of the certification provider (AWS, Microsoft, Coursera, etc.) | String | | `date_from` | Certification issue date | String (date) | | `date_from_year` | Issue year | Number (integer) | | `date_from_month` | Issue month | Number (integer) | | `date_to` | Certification expiry date | String (date) | | `date_to_year` | Expiry year | Number (integer) | | `date_to_month` | Expiry month | Number (integer) | | `issuer_url` | Issuer profile URL | String | | `order_in_profile` | Section record order | Number (integer) | | `created_at` | Record creation timestamp in `ISO 8601` format | String (date) | | `updated_at` | Record update timestamp in `ISO 8601` format | String (date) | | `deleted` |

Status indicating if the record is publicly available:
1 – The record was publicly unavailable the last time we scraped the profile.
0 – The last time we scraped the profile, the record was available and added to the profile's data

| Number (integer) | **See a snippet of the dataset for reference:** {% code title="Certifications" %} ```json "certifications": [ { "id": "f1c4f870-8c4e-456c-a5e6-892a2be9a3b2", "title": "Certified Data Scientist", "issuer": "Example Institute", "credential_id": "6245866", "certificate_url": "https://example.com/certificates/dsi-2023-001", "certificate_logo_url": "https:/example-images.com/dms/image/v2/certificate", "date_from": "2023-01-01", "date_from_year": 2023, "date_from_month": 1, "date_to": "2025-01-01", "date_to_year": 2025, "date_to_month": 1, "issuer_url": "https://exampleinstitute.org", "order_in_profile": 1, "deleted": 0, "created_at": "2023-01-01T10:00:00Z", "updated_at": "2023-01-01T12:00:00Z" } ] ``` {% endcode %} ### Courses | Data field | Description | Data type | | ------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ---------------- | | `courses` | Courses | Array of objects | | `id` | Record UUID identifier | String | | `organizer` | Course organizer | String | | `title` | Course title | String | | `order_in_profile` | Section record order | Number (integer) | | `created_at` | Record creation timestamp in `ISO 8601` format | String (date) | | `updated_at` | Record update timestamp in `ISO 8601` format | String (date) | | `deleted` |

Status indicating if the record is publicly available:
1 – The record was publicly unavailable the last time we scraped the profile.
0 – The last time we scraped the profile, the record was available and added to the profile's data

| Number (integer) | **See a snippet of the dataset for reference:** {% code title="Courses" %} ```json "courses": [ { "id": "d0f7e8e5-abc3-4e9b-8e0c-2a8b80b9f5e9", "organizer": "Example Organizer", "title": "Introduction to Machine Learning", "order_in_profile": 1, "deleted": 0, "created_at": "2023-06-01T10:00:00Z", "updated_at": "2023-06-01T12:00:00Z" } ] ``` {% endcode %} ### Course suggestions | Data field | Description | Data type | | -------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ---------------- | | `course_suggestions` | Suggested courses | Array of objects | | `id` | Record UUID identifier | String | | `title` | Course title | String | | `course_url` | Course URL | String | | `order_in_profile` | Section record order | Number (integer) | | `created_at` | Record creation timestamp in `ISO 8601` format | String (date) | | `updated_at` | Record update timestamp in `ISO 8601` format | String (date) | | `deleted` |

Status indicating if the record is publicly available:
1 – The record was publicly unavailable the last time we scraped the profile.
0 – The last time we scraped the profile, the record was available and added to the profile's data

| Number (integer) | **See a snippet of the dataset for reference:** {% code title="Course suggestions" %} ```json "course_suggestions": [ { "id": "b1c2d3e4-f5a6-7890-ab12-cd34ef567890", "title": "Advanced Data Science and Machine Learning", "course_url": "https://www.example.com/courses/advanced-data-science", "order_in_profile": 1, "deleted": 0, "created_at": "2023-06-01T10:00:00Z", "updated_at": "2023-06-01T12:00:00Z" } ] ``` {% endcode %} ### Education | Data field | Description | Data type | | ---------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ---------------- | | `education` | Education details | Array of objects | | `id` | Record UUID identifier | String | | `institution` | Education institution | String | | `program` | Program title | String | | `date_from` | Enrollment date | String (date) | | `date_from_year` | Enrollment year | Number (integer) | | `date_from_month` | Enrollment month | Number (integer) | | `date_to` | Graduation date | String (date) | | `date_to_year` | Graduation year | Number (integer) | | `date_to_month` | Graduation month | Number (integer) | | `activities_and_societies` | Activities and societies considered part of education | String | | `description` |

Education experience described by the person

Note: contains HTML tags

| String | | `institution_url` | Institution profile URL | String | | `institution_shorthand_name` | Shorthand name from the institution profile URL | String | | `institution_logo_url` | URL pointing to the logo of the educational institution (university, school, training provider) | String | | `order_in_profile` | Section record order | Number (integer) | | `created_at` | Record creation timestamp in `ISO 8601` format | String (date) | | `updated_at` | Record update timestamp in `ISO 8601` format | String (date) | | `deleted` |

Status indicating if the record is publicly available:
1 – The record was publicly unavailable the last time we scraped the profile.
0 – The last time we scraped the profile, the record was available and added to the profile's data

| Number (integer) | **See a snippet of the dataset for reference:** {% code title="Education" %} ```json "education": [ { "id": "d1e2f3b4-56a7-8901-bcde-234567890abc", "institution": "Example University", "program": "Bachelor of Science in Computer Science", "date_from": "2013-09-01", "date_from_year": 2013, "date_from_month": 9, "date_to": "2017-06-01", "date_to_year": 2017, "date_to_month": 6, "activities_and_societies": "Member of the Computer Science Club and Debate Team", "description": "Studied core computer science concepts including algorithms, machine learning, and distributed systems.", "institution_url": "https://www.example-university.edu", "institution_shorthand_name": "example", "institution_logo_url": "https://example-images.com/dms/image/v2/education", "order_in_profile": 1, "deleted": 0, "created_at": "2013-09-01T10:00:00Z", "updated_at": "2017-06-01T12:00:00Z" } ] ``` {% endcode %} ### Experience | Data field | Description | Data type | | -------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ----------------------- | | `experience` | Work experience | Array of objects | | `id` | Record UUID identifier | String | | `title` | Job title | String | | `location` | Job (company) location | String | | `company_id` | ID of the company relating to the company table | Number (integer, int64) | | `company_source_id` | Record identification key assigned by Professional network | Number (integer, int64) | | `company_name` | Workplace name | String | | `company_url` | Professional network profile URL of the workplace | String | | `company_url_shorthand_name` | Shorthand name from the company profile URL | String | | `company_url_canonical_shorthand_name` | The most recent version of company profile URL `shorthand_name` | String | | `company_industry` | Company's industry | String | | `company_website` | Company's website | String | | `company_logo_url` | URL pointing to the logo of the company/employer | String | | `company_employees_count` | Number of employees on Professional network who associated their experience with the company | Number (integer) | | `company_size` | Company size | String | | `date_from` | Employment start date | String (date) | | `date_from_year` | Employment start year | Number (integer) | | `date_from_month` | Employment start month | Number (integer) | | `date_to` | Employment end date | String (date) | | `date_to_year` | Employment end year | Number (integer) | | `date_to_month` | Employment end month | Number (integer) | | `is_current` |

Marks if the record is for current employment

1 – Current workplace

0 – Former workplace

| Boolean | | `duration` | Employment duration | String | | `description` |

Job/job experience description

Note: contains HTML tags

| String | | `order_in_profile` | Section record order | Number (integer) | | `created_at` | Record creation timestamp in `ISO 8601` format | String (date) | | `updated_at` | Record update timestamp in `ISO 8601` format | String (date) | | `deleted` |

Status indicating if the record is publicly available:
1 – The record was publicly unavailable the last time we scraped the profile.
0 – The last time we scraped the profile, the record was available and added to the profile's data

| Number (integer) | **See a snippet of the dataset for reference:** {% code title="Experience" %} ```json "experience": [ { "id": "a1b2c3d4-e5f6-7890-ab12-cd34ef567890", "title": "Senior Software Engineer", "location": "San Francisco, CA", "company_id": 91323973, "company_source_id": 1011745, "company_name": "Example Company.", "company_url": "https://www.professional_network.com/profile/example-company", "company_website": "https://www.example-company.com", "company_shorthand_name": "example-company", "company_url_canonical_shorthand_name": "example-company1", "company_logo_url": "https://example-images.com/dms/image/v2/company-logo", "company_industry": "IT Systems Operations and Maintenance", "company_employees_count": 10, "company_size": "51-200 employees", "date_from": "2019-05-01", "date_from_year": 2019, "date_from_month": 5, "date_to": "2023-03-01", "date_to_year": 2023, "date_to_month": 3, "is_current": 0, "duration": "3 years 10 months", "description": "Led a team of engineers to develop scalable web applications and improve system performance by 40%.", "order_in_profile": 1, "deleted": 0, "created_at": "2019-05-01T08:00:00Z", "updated_at": "2023-03-01T17:00:00Z" } ] ``` {% endcode %} ### Languages | Data field | Description | Data type | | ------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ---------------- | | `languages` | Language knowledge | Array of objects | | `id` | Record UUID identifier | String | | `language` | Listed language | String | | `proficiency` | Language proficiency | String | | `order_in_profile` | Section record order | Number (integer) | | `created_at` | Record creation timestamp in `ISO 8601` format | String (date) | | `updated_at` | Record update timestamp in `ISO 8601` format | String (date) | | `deleted` |

Status indicating if the record is publicly available:
1 – The record was publicly unavailable the last time we scraped the profile.
0 – The last time we scraped the profile, the record was available and added to the profile's data

| Number (integer) | **See a snippet of the dataset for reference:** {% code title="Languages" %} ```json "languages": [ { "id": "d3f4e5b6-7890-ab12-cd34-ef5678901234", "language": "English", "proficiency": "Native", "order_in_profile": 1, "deleted": 0, "created_at": "2022-01-01T10:00:00Z", "updated_at": "2022-01-01T12:00:00Z" } ] ``` {% endcode %} ### Organizations | Data field | Description | Data type | | ------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ---------------- | | `organizations` | Memberships in organizations | Array of objects | | `id` |

Record UUID identifier

| String | | `organization` |

Organization title

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) | | `date_from_year` | Membership start year | Number (integer) | | `date_from_month` | Membership start month | Number (integer) | | `date_to` | Membership end date | String (date) | | `date_to_year` | Membership end year | Number (integer) | | `date_to_month` | Membership end month | Number (integer) | | `order_in_profile` | Section record order | Number (integer) | | `created_at` | Record creation timestamp in `ISO 8601` format | String (date) | | `updated_at` | Record update timestamp in `ISO 8601` format | String (date) | | `deleted` |

Status indicating if the record is publicly available:
1 – The record was publicly unavailable the last time we scraped the profile.
0 – The last time we scraped the profile, the record was available and added to the profile's data

| Number (integer) | **See a snippet of the dataset for reference:** {% code title="Organizations" %} ```json "organizations": [ { "id": "b1a2c3d4-5678-90ab-cdef-1234567890ab", "organization": "Example Organization", "position": "Member", "description": "Participated in monthly meetups and collaborative projects focused on technology innovation.", "date_from": "2020-03-01", "date_from_year": 2020, "date_from_month": 3, "date_to": "2023-03-01", "date_to_year": 2023, "date_to_month": 3, "order_in_profile": 1, "deleted": 0, "created_at": "2020-03-01T08:00:00Z", "updated_at": "2023-03-01T17:00:00Z" } ], ``` {% endcode %} ### Patents | Data field | Description | Data type | | ------------------------------ | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------- | | `patents` | Authored patents | Array of objects | | `id` | Record UUID identifier | String | | `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 filing date | String (date) | | `date_year` | Filling year | Number (integer) | | `date_month` | Filling month | Number (integer) | | `date_day` | Filling day | Number (integer) | | `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 | String | | `order_in_profile` | Section record order | Number (integer) | | `created_at` | Record creation timestamp in `ISO 8601` format | String (date) | | `updated_at` | Record update timestamp in `ISO 8601` format | String (date) | | `deleted` |

Status indicating if the record is publicly available:
1 – The record was publicly unavailable the last time we scraped the profile.
0 – The last time we scraped the profile, the record was available and added to the profile's data

| Number (integer) | **See a snippet of the dataset for reference:** {% code title="Patents" %} ```json "patents": [ { "id": "f1a2b3c4-d5e6-7890-ab12-cd34ef567890", "title": "System for Optimized Data Processing", "status": "Granted", "inventors": [ { "full_name": "John Doe", "profile_url": "www.professional_network.com/in/johndoe", "order_in_profile": 1 }, { "full_name": "Jane Smith", "profile_url": "www.professional_network/in/janesmith", "order_in_profile": 2 } ], "date": "2021-08-15", "date_year": 2021, "date_month": 8, "date_day": 15, "patent_url": "https://example.com/patents/123456", "description": "An innovative system for efficient data processing in distributed environments.", "patent_or_application_number": "US1234567890A", "order_in_profile": 1, "deleted": 0, "created_at": "2021-08-15T10:00:00Z", "updated_at": "2023-03-01T12:00:00Z" } ] ``` {% endcode %} ### Projects | Data field | Description | Data type | | ------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ---------------- | | `projects` | Projects | Array of objects | | `id` | Record UUID identifier | String | | `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) | | `date_from_year` | Start year | Number (integer) | | `date_from_month` | Start year | Number (integer) | | `date_to` | Project end date | String (date) | | `date_to_year` | End year | Number (integer) | | `date_to_month` | End month | Number (integer) | | `team_members` | Project team members | Array of objects | | `full_name` | Member's full name | String (date) | | `profile_url` | Member's Professional network profile URL | String (date) | | `order_in_profile` | Section record order | Number (integer) | | `created_at` | Record creation timestamp in `ISO 8601` format | String (date) | | `updated_at` | Record update timestamp in `ISO 8601` format | String (date) | | `deleted` |

Status indicating if the record is publicly available:
1 – The record was publicly unavailable the last time we scraped the profile.
0 – The last time we scraped the profile, the record was available and added to the profile's data

| Number (integer) | **See snippets of the dataset for reference:** {% code title="Projects" %} ```json "projects": [ { "id": "e1f2a3b4-c5d6-7890-ab12-cd34ef567890", "name": "AI-Powered Recommendation System", "project_url": "https://example.com/projects/recommendation-system", "description": "Developed an AI-powered recommendation engine for e-commerce platforms, increasing conversion rates by 20%.", "date_from": "2020-01-01", "date_from_year": 2020, "date_from_month": 1, "date_to": "2022-06-01", "date_to_year": 2022, "date_to_month": 6, "team_members": [ { "full_name": "John Doe", "profile_url": "www.professional_network.com/in/john-doe", "order_in_profile": 1 }, { "full_name": "Jane Smith", "profile_url": "www.professional_network.com/in/jane-smith", "order_in_profile": 2 } ], "order_in_profile": 1, "deleted": 0, "created_at": "2020-01-01T10:00:00Z", "updated_at": "2022-06-01T12:00:00Z" } ] ``` {% endcode %} ### Publications | Data field | Description | Data type | | ------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ---------------- | | `publications` | Authored publications | Array of objects | | `id` | Record UUID identifier | String | | `title` | Publication title | String | | `publisher` | Publication publisher | String | | `date` | Publication release date | String (date) | | `date_year` | Release year | Number (integer) | | `date_month` | Release month | Number (integer) | | `date_day` | Release day | Number (integer) | | `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` | Author's section record order | Number (integer) | | `publication_url` | Publication website URL | String | | `order_in_profile` | Section record order | Number (integer) | | `created_at` | Record creation timestamp in `ISO 8601` format | String (date) | | `updated_at` | Record update timestamp in `ISO 8601` format | String (date) | | `deleted` |

Status indicating if the record is publicly available:
1 – The record was publicly unavailable the last time we scraped the profile.
0 – The last time we scraped the profile, the record was available and added to the profile's data

| Number (integer) | **See a snippet of the dataset for reference:** {% code title="Publications" %} ```json "publications": [ { "id": "f1e2d3c4-b5a6-7890-ab12-cd34ef567890", "title": "Advances in Machine Learning", "publisher": "Example Journal", "date": "2021-10-15", "date_year": 2021, "date_month": 10, "date_day": 15, "description": "A comprehensive study on the latest trends and advancements in machine learning techniques.", "authors": [ { "full_name": "John Doe", "profile_url": "https://example.com/john-doe", "order_in_profile": 1 }, { "full_name": "Jane Smith", "profile_url": "https://example.com/jane-smith", "order_in_profile": 2 } ], "publication_url": "https://example.com/publications/machine-learning", "order_in_profile": 1, "deleted": 0, "created_at": "2021-10-15T10:00:00Z", "updated_at": "2021-10-15T12:00:00Z" } ] ``` {% endcode %} ### Recommendations | Data field | Description | Data type | | ------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ---------------- | | `recommendations` | Recommendations from other previous/current colleagues | Array of objects | | `id` | Record UUID identifier | String | | `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) | | `created_at` | Record creation timestamp in `ISO 8601` format | String (date) | | `updated_at` | Record update timestamp in `ISO 8601` format | String (date) | | `deleted` |

Status indicating if the record is publicly available:
1 – The record was publicly unavailable the last time we scraped the profile.
0 – The last time we scraped the profile, the record was available and added to the profile's data

| Number (integer) | **See a snippet of the dataset for reference:** {% code title="Recommendations" %} ```json "recommendations": [ { "id": "a1b2c3d4-e5f6-7890-ab12-cd34ef567890", "recommendation": "John is a highly skilled and dependable software engineer. His ability to solve complex problems and lead projects to success is remarkable.", "full_name": "Jane Smith", "referee_url": "https:/www.professional_network.com/in/jane-smith", "order_in_profile": 1, "deleted": 0, "created_at": "2022-05-01T10:00:00Z", "updated_at": "2022-05-01T12:00:00Z" } ] ``` {% endcode %} ### Similar profiles | Data field | Description | Data type | | ------------------ | ----------------------------------------------------------------------------------------------------------- | ---------------- | | `similar_profiles` | Similar profiles | Array of objects | | `id` | Record UUID identifier | String | | `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 | | `company` | Company name associated with the similar profile | String | | `followers` | Follower count or description for the similar profile | String | | `order_in_profile` | Section record order | Number (integer) | | `created_at` | Record creation timestamp in `ISO 8601` format | String (date) | | `updated_at` | Record update timestamp in `ISO 8601` format | String (date) | **See a snippet of the dataset for reference:** {% code title="Similar profiles" %} ```json "similar_profiles": [ { "id": "b1a2c3d4-f5e6-7890-ab12-cd34ef567890", "profile_url": "www.professional_network.com/in/jane-doe", "full_name": "Jane Doe", "headline": "Senior Data Scientist at Tech Corp", "location": "New York, NY", "company": "Tech Corp", "followers": "210", "order_in_profile": 1, "created_at": "2023-01-01T10:00:00Z", "updated_at": "2023-01-01T12:00:00Z" } ] ``` {% endcode %} ### Others named | Data field | Description | Data type | | ------------------ | ----------------------------------------------------------------------------------------------------------- | ---------------- | | `other_named` | List of employees with similar or exact name | Array of objects | | `id` | Record UUID identifier | String | | `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) | | `created_at` | Record creation timestamp in `ISO 8601` format | String (date) | | `updated_at` | Record update timestamp in `ISO 8601` format | String (date) | {% code title="Others named" %} ```json "other_named": [ { "id": "b1a2c3d4-f5e6-7890-ab12-cd34ef567890", "profile_url": "www.professional_network.com/in/jane-doe", "full_name": "Jane Doe", "headline": "Senior Data Scientist at Tech Corp", "location": "New York, NY", "order_in_profile": 1, "created_at": "2023-01-01T10:00:00Z", "updated_at": "2023-01-01T12:00:00Z" } ] ``` {% endcode %} ### Test scores | Data field | Description | Data type | | ------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ---------------- | | `test_scores` | Relevant tests and scores | Array of objects | | `id` | Record UUID identifier | String | | `title` | Test title | String | | `date` | Test completion date | String (date) | | `date_year` | Test completion year | Number (integer) | | `date_month` | Test completion month | Number (integer) | | `date_day` | Test completion day | Number (integer) | | `description` | Test completion day | String | | `score` | Test score | String | | `order_in_profile` | Section record order | String | | `created_at` |

Record creation timestamp in ISO 8601 format

| String (date) | | `updated_at` | Record update timestamp in `ISO 8601` format | String (date) | | `deleted` |

Status indicating if the record is publicly available:
1 – The record was publicly unavailable the last time we scraped the profile.
0 – The last time we scraped the profile, the record was available and added to the profile's data

| Number (integer) | **See a snippet of the dataset for reference:** {% code title="Test scores" %} ```json "test_scores": [ { "id": "c1d2e3f4-a5b6-7890-ab12-cd34ef567890", "title": "General Test", "date": "2021-09-15", "date_year": 2021, "date_month": 9, "date_day": 15, "description": "Scored in the 95th percentile on the General Test, with a focus on quantitative reasoning and analytical writing.", "score": "328", "order_in_profile": 1, "deleted": 0, "created_at": "2021-09-15T10:00:00Z", "updated_at": "2021-09-15T12:00:00Z" } ] ``` {% endcode %} ### Volunteering positions | Data field | Description | Data type | | ----------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ---------------- | | `volunteering_positions` | Participation in volunteering organizations | Array of objects | | `id` | Record UUID identifier | String | | `organization` | Volunteer organization | String | | `role` | Role in the organization | String | | `cause` | Volunteering cause | String | | `date_from` | Volunteering start date | String (date) | | `date_from_year` | Start year | Number (integer) | | `date_to` | Volunteering end date | String (date) | | `date_to_year` | End year | Number (integer) | | `duration` | Volunteering duration | String | | `description` |

Experience description

Note: contains HTML tags

| String | | `organization_url` | Organization's profile URL | String | | `organization_shorthand_name` | Shorthand name from the profile URL | String | | `order_in_profile` | Section record order | Number (integer) | | `created_at` | Record creation timestamp in `ISO 8601` format | String (date) | | `updated_at` | Record update timestamp in `ISO 8601` format | String (date) | | `deleted` |

Status indicating if the record is publicly available:
1 – The record was publicly unavailable the last time we scraped the profile.
0 – The last time we scraped the profile, the record was available and added to the profile's data

| Number (integer) | **See a snippet of the dataset for reference:** {% code title="Volunteering positions" %} ```json "volunteering_positions": [ { "id": "d1e2f3a4-b5c6-7890-ab12-cd34ef567890", "organization": "Example Organization", "role": "Volunteer Coordinator", "cause": "Poverty Alleviation", "date_from": "2018-04-01", "date_from_year": 2018, "date_to": "2021-12-01", "date_to_year": 2021, "duration": "3 years 8 months", "description": "Organized and managed volunteer activities to support low-income families through food distribution and educational programs.", "organization_url": "www.professional_network.com/company/example-organization", "organization_shorthand_name": "CAN", "order_in_profile": 1, "deleted": 0, "created_at": "2018-04-01T08:00:00Z", "updated_at": "2021-12-01T17:00:00Z" } ] ``` {% endcode %} ### Websites | Data field | Description | Data type | | ------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ---------------- | | `websites` | Personal websites | Array of objects | | `id` | Record UUID identifier | String | | `personal_website` | Personal website | String | | `order_in_profile` | Section record order | Number (integer) | | `created_at` | Record creation timestamp in `ISO 8601` format | String (date) | | `updated_at` | Record update timestamp in `ISO 8601` format | String (date) | | `deleted` |

Status indicating if the record is publicly available:
1 – The record was publicly unavailable the last time we scraped the profile.
0 – The last time we scraped the profile, the record was available and added to the profile's data

| Number (integer) | {% code title="Websites table" %} ```json "websites": [ { "id": "a1b2c3d4-e5f6-7890-ab12-cd34ef567890", "personal_website": "https://www.johndoeportfolio.com", "order_in_profile": 1, "deleted": 0, "created_at": "2023-01-01T10:00:00Z", "updated_at": "2023-01-01T12:00:00Z" } ] ``` {% endcode %} ### Activity | Data field | Description | Data type | | ------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ---------------- | | `activity` | Activity on Professional network | Array of objects | | `id` | Record UUID identifier | String | | `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) | | `created_at` | Record creation timestamp in `ISO 8601` format | String (date) | | `updated_at` | Record update timestamp in `ISO 8601` format | String (date) | | `deleted` |

Status indicating if the record is publicly available:
1 – The record was publicly unavailable the last time we scraped the profile.
0 – The last time we scraped the profile, the record was available and added to the profile's data

| Number (integer) | **See a snippet of the dataset for reference:** {% code title="Activity" %} ```json "activity": [ { "id": "d1e2f3a4-b5c6-7890-ab12-cd34ef567890", "activity_url": "https://www.example.com/activity/12345", "title": "Shared an article on AI advancements", "action": "Shared", "order_in_profile": 1, "deleted": 0, "created_at": "2023-07-01T10:00:00Z", "updated_at": "2023-07-01T12:00:00Z" } ] ``` {% endcode %} ### Inferred skills | Data field | Description | Data type | | ----------------- | ------------------------------------------------------------------ | ---------------- | | `inferred_skills` | Lists employees' skills based on the descriptions from the profile | Array of strings | **See a snippet of the dataset for reference:** {% code title="Inferred skills" %} ```json "inferred_skills": [ "software development", "troubleshooting", "web development" ] ``` {% endcode %} --- # Agent Instructions: Querying This Documentation If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question. Perform an HTTP GET request on the current page URL with the `ask` query parameter: ``` GET https://docs.coresignal.com/employee-api/base-employee-api/data-dictionary-base-employee-api.md?ask= ``` The question should be specific, self-contained, and written in natural language. The response will contain a direct answer to the question and relevant excerpts and sources from the documentation. Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.