Skip to main content

Data Types

Data types are essential for defining the structure of profileAPI's object models and the specifications of API requests and responses. This documentation outlines each data type used across the profileAPI, facilitating accurate and effective API interactions.

Angellist URL​

  • Key: angellistUrl
  • Type: URL
  • Description: URL to an AngelList profile.
  • Format: https://angel.co/[handle]

Country Code​

  • Key: countryCode
  • Type: string
  • Description: A two-letter code compliant with ISO 3166-1 alpha-2 representing a country.

Crunchbase URL​

  • Key: crunchbaseUrl
  • Type: URL
  • Description: URL to a Crunchbase profile.
  • Format:
    • For Persons: https://www.crunchbase.com/person/[handle]
    • For Companies: https://www.crunchbase.com/organization/[handle]

Department​

  • Key: department
  • Type: string
  • Description: The name of the department within an organization.

Email​

  • Key: email
  • Type: string
  • Description: Represents an email address, conforming to the standard format as specified in RFC 5322, which defines the syntax for email messages.

Facebook URL​

  • Key: facebookUrl
  • Type: URL
  • Description: URL to a Facebook profile.
  • Format: https://facebook.com/[username]

Github URL​

  • Key: githubUrl
  • Type: URL
  • Description: URL to a GitHub profile.
  • Format: https://github.com/[username]

Id​

  • Key: id
  • Type: UUID
  • Description: A universally unique identifier (UUID) compliant with RFC 4122 specification, used to uniquely identify entities in the system. Presented without hyphens.
  • Format: 9e6a55b258ef11edb8780242ac120002

Industry​

  • Key: industry
  • Type: string
  • Description: Classified industries.

LinkedIn URL​

  • Key: linkedInUrl
  • Type: URL
  • Description: URL to a LinkedIn profile.
  • Format:
    • For Persons: https://linkedin.com/in/[personhandle]
    • For Companies: https://linkedin.com/company/[handle]

Niche​

  • Key: niche
  • Type: string
  • Description: A specific sub-category within an industry.

Phone​

  • Key: phone
  • Type: string
  • Description: Represents a phone number formatted according to the E.164 international numbering standard.
  • Format: +1XXXXXXXXXX (Example for the United States, including the country code +1 followed by a ten-digit number)

Role​

  • Key: role
  • Type: string
  • Description: Designates the role of an individual within the organization.
  • Accepted Values: Individual Contributor, Manager

Score​

  • Key: score
  • Type: number
  • Description: A decimal between 0 and 1 to represent confidence or precision score.

Seniority​

  • Key: seniority
  • Type: string
  • Description: Represents the level of seniority of an individual within the organization.
  • Accepted Values: C-Level+, Vice President, Director, Senior, Mid, Junior

Topic​

  • Key: topic
  • Type: string
  • Description: Extracted topics that are identified on the website through semantic analysis.

Twitter URL​

  • Key: twitterUrl
  • Type: URL
  • Description: URL to a Twitter profile.
  • Format: https://twitter.com/[username]

United States Region​

  • Key: unitedStatesRegion
  • Type: string
  • Description: Geographic region in the United States.

United States State Code​

  • Key: unitedStatesStateCode
  • Type: string
  • Description: The two-letter code representing a state in the United States follows the standard established by the United States Postal Service (USPS).

URL​

  • Key: url
  • Type: String
  • Description: A standardized address of a resource on the internet, formatted according to RFC 3986 guidelines.
  • Format: https://example.com/path?query=parameter
  • Key: websiteExternalLinkCategory
  • Type: string
  • Description: Category name for an external link found on a website.

Website Page​

  • Key: websitePage
  • Type: string
  • Description: Specifies the specific page name identified on a website.
  • Accepted Values: Blog, Career, Contact Us, Documentation, Integration, News, Pricing, Privacy, Product, Solutions, Support, Team

World Region​

  • Key: worldRegion
  • Type: string
  • Description: Geographic region in the world.

Youtube URL​

  • Key: youtubeUrl
  • Type: URL
  • Description: URL to a YouTube channel.
  • Format: https://youtube.com/user/[username]