Profile API

query description the query to be used when returning the reference data inputs, types and enums fields name returns description info docid 0p1arbpcgvn4db2zv l7n query to return health info rolesboard docid 0p1arbpcgvn4db2zv l7n query to return rolesboard based on filter and pagination rolesemployment docid 0p1arbpcgvn4db2zv l7n query to return rolesemployment based on filter and pagination rolescommittee docid 0p1arbpcgvn4db2zv l7n query to return the set of roles within the organization that are part of a committee, providing information about specific roles related to organizational governance, based on filter and pagination memberships docid 0p1arbpcgvn4db2zv l7n query to return memberships based on filter and pagination charitabledonations docid 0p1arbpcgvn4db2zv l7n query retrieves a paginated list of charitable donations based on specific filters politicaldonations docid 0p1arbpcgvn4db2zv l7n query returns a paginated list of political donations based on the applied filter criteria personidsearch docid 0p1arbpcgvn4db2zv l7n query for searching a single person id personbulkidsearch docid 0p1arbpcgvn4db2zv l7n query for bulk search of person ids personkeywordsearch docid 0p1arbpcgvn4db2zv l7n query for keyword search of persons organizationidsearch docid 0p1arbpcgvn4db2zv l7n query for searching a single organization by id organizationbulkidsearch docid 0p1arbpcgvn4db2zv l7n query for bulk search of organization ids organizationkeywordsearch docid 0p1arbpcgvn4db2zv l7n query for keyword search of organizations referencedata docid 0p1arbpcgvn4db2zv l7n query to retrieve various reference data inputs, types, and enums, enabling access to predefined reference values for use in queries and filtering referencegroupdata docid 0p1arbpcgvn4db2zv l7n query to retrieve various reference group data inputs, types, and enums, enabling access to predefined reference values for use in queries and filtering organizationsearch docid 0p1arbpcgvn4db2zv l7n query to perform a detailed search for organization based on advanced filters and criteria, allowing for more refined and specific queries to retrieve organization data organizationsearchcount — query to retrieve the total count of organizations that match specified search criteria, providing a way to know the number of results before fetching the actual data personsearch docid 0p1arbpcgvn4db2zv l7n query to search for people based on specified filters and criteria, enabling users to retrieve relevant person data from the system personsearchcount docid 0p1arbpcgvn4db2zv l7n query to retrieve the total number of people that match specified search criteria, providing a count of the results before fetching the actual data exportorganization docid 0p1arbpcgvn4db2zv l7n query to initiate the generation of a downloadable file containing an organization's profile data, allowing users to retrieve and export relevant organizational information exportperson docid 0p1arbpcgvn4db2zv l7n query to initiate the generation of a downloadable file containing a person's profile data, enabling users to retrieve and export detailed information about a specific individual exportpersonsearch docid 0p1arbpcgvn4db2zv l7n query to apply search filters and export person search results, enabling users to retrieve and download filtered dataset based on specified criteria exportorganizationsearch docid 0p1arbpcgvn4db2zv l7n query to apply search filters and export organization search results, enabling users to retrieve and download filtered dataset based on specified criteria wealthassets docid 0p1arbpcgvn4db2zv l7n query to retrieve wealth assets based on specified filters and pagination information inforesponse fields name type description appversion string! the app version, e g v0 1 0 163 g8ec2901 deployment string! deployment used whether its blue or green or n/a environment string! environment used whether its dev/qa/prod/etc healthy boolean! returns the status of the service and the dependencies schemaversion string! the metadata and appsync schema version clusterversion string! the cluster version permissionsversion string! the permissions version used for feature set datetimeinformation fields name type description date awsdatetime the date displayed as yyyy mm ddthh\ mm \ ss sssz displaydate string refers to the date values which are accurate to the iso 8601 format for calendar dates rolepagedresult description a paged set of role items including the page information fields name type description items \[role] list of role items pageinforesponse pageinforesponse paging information linked to the paged set of results, including the number of results and tokens for paging forwards and backward role fields name type description id id! unique identifier for the entity person persondetails query to return core attributes of a person organization organizationdetails query to return core details of an organization startdate dateinformation the start date for when the role began enddate dateinformation the end date for when the role ended type string deprecated use roletypes instead roletypes \[string!] denotes all the types of a role a person holds at an organization i e board role and employment role status currentpriorstatus refers to the status of the role a person holds title string denotes a specific designation or label given to an individual to indicate their role, responsibilities, and level within the organization titlecategorygroup \[titlecategorygroup] they refer to a grouping or classification of roles based on role category group emailprimary string primary email address for each role titlecategorydetail \[titlecategorydetail] they refer to a grouping or classification of roles based on role category detail isexecutivedirector boolean indicates whether this role is an executive director position isnonexecutivedirector boolean indicates whether this role is a non executive director position ispartofleadershipteam boolean indicates whether this role is part of the leadership team isotheremployee boolean indicates whether this role is classified as other employee persondetails fields name type description name string an individual's full name comprising of first, middle, & last names example satya nadella id id! unique identifier for an individual profile age int an individual's age derived from date of birth gender string value is provided as male or female, when available organizationdetails fields name type description id id! unique identifier for an organization organizationname string an official (full name) of organization organizationtype string denotes the nature or type of business sectorprimary string company sector information associated with the organization headofficeaddress address represents the address of the organization headquarters latestdailymarketcapital float the latest market capital $ amount for the organization latestannualmarketrevenue float the latest annual market revenue $ amount for the organization latestannualnumberofemployeesdisclosed int the latest figure for the number of employees the organization has address fields name type description address string an address line 1 of the organization headquarters location zip string the postcode or zip code of organization headquarter's location state string the state of the organization headquarter's location city string the city of the organization headquarter's location country string the country of the organization headquarter's location dateinformation fields name type description date awsdate the date displayed as year month & day dateprecision dateprecision indicates the precision that date information is provided (to the day, month, or year) displaydate string refers to the date values which are accurate to the iso 8601 format for calendar dates currentpriorstatus values value description current n/a prior n/a unknown n/a titlecategorygroup description the query to be used for role title category group fields name type description roletitlecategory string defines a field that categorizes the role title as a string, which can be null if not specified roletitlecategorygroupname string defines a field that categorizes the role title as a group name, which can be null if not specified titlecategorydetail description the query to be used for role title category details fields name type description rolegroup string defines a group that categorizes the role title category authorizationerror description error type returned when an authorization error occurs fields name type description authorizationerrorcode authorizationerrorcode! displays the authorization error code errorcode string! displays the error code correlationid string! returns a unique idenfier for the given request, used for diagnostic purposes errormessage string! a brief description of the issue that occurred this message helps explain the error, though it may not provide specific technical details error description define error interface and types possible types docid 0p1arbpcgvn4db2zv l7n docid 0p1arbpcgvn4db2zv l7n docid 0p1arbpcgvn4db2zv l7n docid 0p1arbpcgvn4db2zv l7n fields name type description errorcode string! displays the error code correlationid string! represent an id used to correlate logs and metrics across services and processes errormessage string! na brief description of the issue that occurred this message helps explain the error, though it may not provide specific technical details entitynotfounderror description error type returned when an entity is not found fields name type description entitynotfounderrorcode entitynotfounderrorcode! displays the entity not found error code errorcode string! displays the error code correlationid string! returns a unique idenfier for the given request, used for diagnostic purposes errormessage string! a brief description of the issue that occurred this message helps explain the error, though it may not provide specific technical details genericerror fields name type description genericerrorcode genericerrorcode! displays the generic error code errorcode string! displays the error code correlationid string! represent an id used to correlate logs and metrics across services and processes errormessage string! a brief description of the issue that occurred this message helps explain the error, though it may not provide specific technical details validationerror description the query to be used for validation errors fields name type description validationerrorcode validationerrorcode! displays the validation error code errorcode string! displays the error code correlationid string! an id used to correlate logs and metrics across services and processes errormessage string! a brief description of the issue that occurred this message helps explain the error, though it may not provide specific technical details errordetails \[errordetail!] displays the detailed information about the error errordetail fields name type description message string! displays the description of the error path string represents the area where the error has occurred code string represents the category of error membershippagedresult description a paged set of membership items including the page information fields name type description items \[membership!]! list of membershipitems pageinforesponse pageinforesponse information about pagination in a paged set of results membership fields name type description id id! unique identifier for the entity person persondetails key person attributes for the person the membership is associated to organization organizationdetails key organization attributes for the person the membership is associated to title string the title associated to the person's membership affiliation startdate dateinformation date year, month, and day when the person's membership began enddate dateinformation date year, month, and day when the person's membership ended currentpriorstatus currentpriorstatus indicates if the membership is current or prior (historic) charitabledonation fields name type description id id! the unique id of a charitable donation the id helps identify and reference a specific donation record within the system donorpeople \[persondetails] displays detailed information about individual donors donororganization organizationdonordetails displays detailed information about a donor organization recipientorganization organizationdonordetails displays detailed information about the organization receiving the donation amount float retrieves the donation amount as a number with decimals (float) it helps track the exact value of each charitable contribution measurementdate dateinformation retrieves the date when a specific measurement or record was taken organizationdonordetails fields name type description id id! unique identifier for an organization organizationname string an official (full name) of organization organizationtype string denotes the nature or type of business sectorprimary string company sector information associated with the organization headofficeaddress address represents the address of the organization headquarters latestdailymarketcapital float the latest market capital $ amount for the organization latestannualmarketrevenue float the latest annual market revenue $ amount for the organization latestannualnumberofemployeesdisclosed int the latest figure for the number of employees the organization has charitablecauses charitablecauses fetches the list of charitable causes an organization supports charitablecauses fields name type description causeprimary string displays the primary cause associated with a charitable activity causes \[string] retrieves a list of charitable causes politicaldonationpagedresult fields name type description items \[politicaldonation!]! the query returns list of individual politicaldonation records, each representing a single donation made to or by a political party pageinforesponse pageinforesponse paging information linked to the paged set of results, including the number of results and tokens for paging forwards and backward politicaldonation fields name type description id id! a unique identifier for the political donation, used to reliably reference this specific record across queries donorpeople \[persondetails] represents a list of individuals who contributed to the political donation recipientorganization organizationdetails represents the organization that received the political donation recipientperson persondetails represents the individual who received the political donation recipientpoliticalpartyorganization politicalpartyorganization returns details of the political party organization that received the donation, if applicable amount float returns the monetary value of the donation made measurementdate dateinformation returns the date when the donation data was recorded or measured politicalpartyorganization fields name type description id id! the id uniquely identifies each political party organization entity in the system politicalparty string represents the name of the political party associated with the politicalpartyorganization organizationname string represents the name of the political party organization organizationtype string indicates the type of the political party organization person description query to return people fields name type description matchtype matchtype the match type of the query result {exact, fuzzy, combined, or combined fuzzy} matchdetails matchdetails the match details of the query result which include name and organization name string an individual's full name comprising of first, middle, & last names example satya nadella id id! unique identifier for an individual profile firstname string an individual's first name middlename string an individual's middle name lastname string an individual's last name suffix string follows an individual's full name and provides additional information about the person salutation string an individual's title or prefix gender string value is provided as male or female, when available age int an individual's age derived from date of birth dateofbirth dateinformation a date or approximate date when individual is born (dddd mm dd) isdeceased boolean indicator to identify if the person is deceased or not dateofdeath dateinformation a date or approximate date when individual died (dddd mm dd) linkedinprimary string the linkedin url of the person rolesemployment rolepagedresult a list of employment roles when linked to a person, a list of roles the person holds or used to hold when linked from organization, a list of roles within that organization rolesboard rolepagedresult a list of board positions when linked to a person, a list of board positions that the person holds or used to hold when linked from organization, a list of board positions within that organization education educationpagedresult refers to the actual qualification gained memberships membershippagedresult all the memberships that are currently or historically held by the person externalidentifiers \[externalidentifier] the list of external id's associated to the person profile from the altrata foundation brands roleprimary role the role details associated to the primary role for the person rolescommittee rolepagedresult represents a list or set of roles within the organization that are part of a committee, providing information about specific roles related to organizational governance donorcharitabledonations charitabledonationpagedresult the query fetches a list of charitable donations made by a person politicaldonations politicaldonationpagedresult returns a paginated list of political donations made by the person, useful for analyzing their donation history politicaldonationsummary politicaldonationsummarydetails returns a summary of the person's political donations, including total amount donated and count of donations personalemails string the list of personal emails associated with the person personalemailprimary string the primary personal email associated with the person executivesummary string the executive summary associated with the person earningindicatordescription string defines a field related to persons earning, providing insight into their financial or professional standing personalrelationships personalrelationshippagedresult the list of personal relationships associated with a person the personalrelationships field supports pagination, making it easy to view and manage large sets of relationship records birthplace birthplace the structured information about the person's place of birth, including city, state and country when available wealthassetsummary wealthassetsummary this is a list summary of a person's asset classifications and their values networthsummarylatest networthsummary this is a summary of the total asset worth of a person, their estimated liabilities, and thereby their estimated net worth sourceofwealth string this refers to the classification of a person in terms of how they accumolated their wealth (inheritance, inheritance & self made, self made, or unkown) wealthtier string the classification of a person according to the size of their wealth; likely very high net worth, confirmed very high net worth, likely ultra high net worth, confirmed ultra high net worth nationality \[nationality] this refers to the citizenship of a person, i e , having legal documents of citizenship such as a passport relationshipstatus string this describes the romantic relationship that a person has, such as being married, single, windowed, etc personalinterests interestpagedresult a person's interests, which fall under one or more interest categories (genres) and one or more human pursuits personaladdresses personaladdresspagedresult the address of a person that is used for personal, non work related activities publicboardcount boardcount the count of public board positions the person holds, broken down by current, historical, and total privateboardcount boardcount the count of private board positions the person holds, broken down by current, historical, and total otherboardcount boardcount the count of other board positions the person holds, broken down by current, historical, and total monthsinrole int the number of months the person has been in their current role monthswithorganization int the number of months the person has been associated with their primary organization monthsonboardatorganization int the number of months the person has served on the board at their primary organization charitabledonationsummary string a text summary of the person's charitable donations interestingfacts \[interestingfact!] a list of interesting facts about the person familyofficepersoncontacts \[rolefamilyofficepersoncontact!] a list of family office person contacts associated with the person's roles matchdetails fields name type description name string the person name that is returned based on the details matched in the search criteria organizationid id the organization id that is returned based on the details matched in the search criteria organization string the organization name that is returned based on the details matched in the search criteria roletitle string the role title that is returned based on the details matched in the search criteria education fields name type description id id! unique identifier for the entity person persondetails query to return people organization organizationdetails query to return organizations startdate dateinformation the date for when the education commenced enddate dateinformation the date for when the qualification was completed qualification string the actual qualification gained qualificationcategory string categorization of obtained education to denote the level of the qualification externalidentifier description the unique identifier associated to the external source e g boardex id fields name type description source string! the source or provider of the external id also includes other altrata products e g boardex or relsci value string the unique external id linked to the altrata id politicaldonationsummarydetails fields name type description totaldonationamount float represents the total sum of all political donations made by the person averagedonationamount float represents average amount donated across all political donations made by the person totaldonationcount int represents the total number of political donations made by the person highestdonationamount float represents the single largest monetary contribution made by the person across all political donations lowestdonationamount float represents the smallest monetary contribution made by the person across all political donations annualsummaries \[donationannualsummarydetails] returns a list of donationannualsummarydetails, each summarizing total political donations made per year by the person summary string a text summary of the person's political donations donationannualsummarydetails fields name type description donationyear string represents the calendar year during which the political donation was made totaldonationamount float represents the total sum of political donations made by the individual in a given year averagedonationamount float represents the average amount of all political donations made by the person within the specified year totaldonationcount int returns the total number of political donations made by the person in a given year highestdonationamount float represents the largest single political donation made by the person in any year lowestdonationamount float represents the lowest single donation amount made by the person in a given year personalrelationshippagedresult description a paged set of relationship items including the page information fields name type description items \[personalrelationship!]! list of relationship items pageinforesponse pageinforesponse paging information linked to the paged set of results including the number of results and tokens for paging forwards and backward personalrelationship description family details or personal relationship related to that person fields name type description personid string the id of a person involved in a personal relationship name string the name of a person associated with a personal relationship age int the age of a person involved in a personal relationship gender string the gender information of a person involved in a personal relationship status currentpriorstatus retrieves the status of a personal relationship, showing whether it is current or from the past startdate dateinformation retrieves the start date for when the relationship began enddate dateinformation retrieves the end date for when the relationship ended type string the type of personal relationship between individuals, returned as a text value birthplace fields name type description cityname string returns the city name where the person was born, useful for research, segmentation, and donor profiling statename string returns the name of the state where the person was born, based on available birthplace data countryname string returns the country where the person was born, if available wealthassetsummary fields name type description totalassetvalue float the total value of all financial and non financial assets held by a person, including private and public holdings, alternative assets, and cash privateholdingvalue float the estimated cumulative value of a person's ownership in private companies, meaning their shares are not traded on a public stock exchange privateholdingpercentage float the percentage of a person's estiamted cumulative ownership in private companies, meaning their shares are not traded on a public stock exchange cashandothervalue float this is the estimated value of a particular cash asset, that is immediately available or convertible to known cash amounts within 90 days without significant risk of value change this is also know as liquid assets cashandotherpercentage float the percentage of the estimated value of a cash asset, that is immediately available or convertible to known cash amounts without significant risk of value change commonstockvalue float the estimated value of a person's common stock, which is a fractional ownership stake in a company, granting shareholders voting rights on corporate policy and the board of directors, as well as a claim on residual profits through dividends or stock appreciation shareholders have a lower priority for payouts in a liquidation event, as creditors and preferred stockholders are paid first commonstockpercentage float the percentage of a person's estimated common stock in a company, which is a fractional ownership stake in a company, granting shareholders voting rights on corporate policy and the board of directors, as well as a claim on residual profits through dividends or stock appreciation it is the most common type of stock issued and is traded on public exchanges shareholders have a lower priority for payouts in a liquidation event, as creditors and preferred stockholders are paid first stockoptionvalue float the estimated value of a person's stock option, which refers to the worth or potential financial benefit of a stock option — that is, the right (but not the obligation) to buy or sell a company’s stock at a predetermined price (called the strike price) within a certain period the strike price is usually lower than the current price of the stock stockoptionpercentage float the percentage of a person's estimated stock option in a company, which refers to the worth or potential financial benefit of a stock option — that is, the right (but not the obligation) to buy or sell a company’s stock at a predetermined price (called the strike price) within a certain period the strike price is usually lower than the current price of the stock alternateassetvalue float the estimated value of a person's non traditional assets (stocks, bonds, and cash) examples of alternative assets include private equity or hedge funds, commodities, and collectibles alternateassetpercentage float this is the percentage of ownership a person has in the alternate asset for example, it is less than 100%, then they share the asset ownership with others networthsummary fields name type description estimatednetworth float the net worth of a person that is calculated as the total assets value minus the liabilities value totalassetfound float the total value of all identified and verified assets for a person within the altrata database estimatedliquidasset float this is the estimated value of all the funds immediately available or convertible to known cash amounts within 90 days without significant risk of value change this is also known as cash estimatedfamilynetworth float the net worth of a person and their immediate family that is calculated as the total assets value minus the liabilities value estimatedfamilyliquidasset float this is an estimate of funds immediately available, or convertible to known cash amounts within 90 days without significant risk of value change, that belong to person and their immediate famlily this is also know as cash nationality fields name type description name string returns the nationality name isprimary boolean! returns whether the nationality is primary or not interestpagedresult description a paged set of interest items including the page information fields name type description items \[interest!]! list of interest items pageinforesponse pageinforesponse information about pagination in a paged set of results interest fields name type description pursuit string a sustained activity in a domain a person does not they are not working pursuits contain different categories of human interests category string a category of human interest this can be thought of as the genre of interest, which could fall under one or more pursuits name string the name of the human interest which could fall under one or more interest categories or genres description string a descriptive summary providing additional context about the interest personaladdress fields name type description city string the city of the personal address state string the state of the personal address country string the country of the personal address residencetype residencetype the residence type of the personal address residencetype values value description residential property n/a investment property n/a unknown n/a boardcount fields name type description current int the number of board positions a person currently holds historical int the number of board positions a person historically held total int the total number of board positions a person holds or held interestingfact description an interesting fact about a person fields name type description description string the description of the interesting fact rolefamilyofficepersoncontact description a family office person contact from a role context, including organization details fields name type description personid id the unique identifier of the person organizationid id the unique identifier of the organization roleid id the unique identifier of the role organizationname string the name of the organization organizationheadofficeaddress string the head office address of the organization organizationheadofficezip string the head office zip code of the organization organizationheadofficecity string the head office city of the organization organizationheadofficestate string the head office state of the organization organizationheadofficecountry string the head office country of the organization personname string the name of the person organizationphonenumberprimary string the primary phone number of the organization roletitle string the title of the role personpagedresult description a paged set of person items including the page information fields name type description items \[person!]! list of person items pageinforesponse pageinforesponse paging information linked to the paged set of results, including the number of results and tokens for paging forwards and backward keywordsearchfields values value description interests and hobbies n/a organization fields name type description matchtype matchtype the match type of the query result {exact, fuzzy, combined, or combined fuzzy} id id! unique identifier for an organization organizationname string an official (full name) of organization organizationtype string denotes the nature or type of business tickerprimary string ticker symbol associated with the main stock exchange listing of the organization a ticker symbol is a unique one to five letter code used by a stock exchange to identify a company dateextinct dateinformation the date when the organization ceased to exist sectorprimary string a primary sector refers to a broader classification of the economic activity an organization is involved with, e g banking & finance headofficeaddress address represents the address of the organization headquarters industryprimary string a primary industry refers to a granular classification of the economic activity an organization is involved with, e g retail & commercial banking datefounded dateinformation the date when the organization was established website string the public website for an organization when available ultimateparentid id the unique id of ultimate parent company the topmost company within the hierarchy of the organization ultimateparentname string the name of ultimate parent company the topmost company within the hierarchy of the organization isultimateparent boolean indicator to identify if the organization is ultimate parent company or not latestdailymarketcapital float the latest market capital $ amount for the organization latestdailymarketcapitalmeasurementdate dateinformation the latest date the market capital $ amount was collected for the organization latestannualmarketrevenue float the latest annual market revenue $ amount for the organization latestannualmarketrevenuemeasurementdate dateinformation the latest date the annual market revenue $ amount was collected for the organization latestannualnumberofemployeesdisclosed int the latest figure for the number of employees the organization has latestannualnumberofemployeesdisclosedmeasurementdate dateinformation the latest date taken for the number of employees the organization has rolesboard rolepagedresult a list of board positions when linked to a person, a list of board positions that the person holds or used to hold when linked from organization, a list of board positions within that organization rolesemployment rolepagedresult a list of employment roles when linked to a person, a list of roles the person holds or used to hold when linked from organization, a list of roles within that organization externalidentifiers \[externalidentifier] the list of external id's associated to the organization profile from the altrata foundation brands rolescommittee rolepagedresult the list or set of roles within the organization that are part of a committee, providing information about specific roles related to organizational governance donorcharitabledonations charitabledonationpagedresult the query retrieves a paginated list of charitable donations based on specific filters recipientcharitabledonations charitabledonationpagedresult the query fetches donation records made to an organisation, showing details about each charitable donation it has received charitablecauses charitablecauses the query fetches the list of charitable causes an organisation supports indexes \[index!] the list of market indexes the organization is listed on currentwomenonboardcount int the current number of women on the board of the organization currentwomenonboardpercentage int the current percentage of women on the board of the organization currentpersonsonboardcount int the current total number of persons on the board of the organization isfamilyoffice boolean indicates whether the organization is a family office financialinformation financialinformation financial information associated with the organization familyofficepersoncontact familyofficepersoncontact a list of family office person contacts associated with the organization organizationphonenumberprimary string the primary phone number of the organization index fields name type description id id! unique identifier for the index name string the full name of the index abbreviatedname string the abbreviated name of the index status string the current status of the index membership startdate dateinformation the date the organization joined the index enddate dateinformation the date the organization left the index country string the country associated with the index financialinformation description financial information associated with an organization fields name type description assetsundermanagement float the assets under management value familyofficepersoncontact description a family office person contact associated with an organization fields name type description personid id the unique identifier of the person personname string the name of the person roleid id the unique identifier of the role roletitle string the title of the role organizationpagedresult description a paged set of organization items including the page information fields name type description items \[organization!]! list of organization items pageinforesponse pageinforesponse paging information linked to the paged set of results including the number of results and tokens for paging forwards and backward referencedatapagedresult description pagination query to identify the different reference data items and page info details fields name type description items \[refdataitem] the input criteria to signify that reference data items are required in the response object refdataitem fields name type description debuginfo \[debuginfo] provides diagnostic details about refdataitem related queries, helping to troubleshoot issues by returning metadata value string the actual reference data item to be included referencedatatypeenum description a list of reference data types that can be ingested via api to support the advanced search queries values value description countries n/a event type n/a earning indicator description n/a education qualifications n/a gender n/a market cap max n/a membership title n/a number of employees max n/a organization industries n/a organization sectors n/a organization types n/a revenue max n/a role statuses n/a role title categories n/a role title category group name n/a role groups n/a role types n/a state name n/a asset type n/a charitable cause n/a political party n/a wealth tier n/a source of wealth n/a relationship status n/a residence type n/a asset classification n/a asset liquidity type n/a index n/a refgroupdataitem fields name type description name string the actual reference group data category value \[string] the actual reference group data item to be included referencegroupdatatypeenum description a list of reference group data types that can be ingested via api to support the advanced search queries values value description role title categories n/a organization sectors n/a organizationsortablefields description the field available for determing the sort order of the query values value description id n/a organization name n/a organization type n/a ticker primary n/a sector primary n/a industry primary n/a country n/a state n/a number of employees n/a market capital n/a revenue n/a women on board count n/a women on board percentage n/a persons on board count n/a organizationcountresult fields name type description value int! defines a non nullable field that represents an integer value, meaning it must always have a valid integer provided totalresults int! defines the total number of organizations that match the query criteria, providing a count of all relevant records personsearchresult description the input used for the new person search query fields name type description id id! defines a non nullable unique identifier field, typically used to uniquely identify an object within the schema personid id unique identifier for the entity person name string defines a field that holds text or a string value, which can be null if not provided age int defines a field that holds an integer value, representing a person's age, which can be null if not provided gender string defines a field that holds text representing a person's gender, which can be null if not specified deceased boolean defines a field that indicates whether a person is deceased, represented as true or false, and can be null if not specified organizationid id defines a field representing the unique identifier of an organization, which can be null if not provided organizationname string defines a field that holds the name of an organization as a string, which can be null if not specified organizationtype string defines a field that specifies the type or category of an organization as a string, which can be null if not provided organizationsectorprimary string defines a field that specifies the primary sector of an organization as a string, which can be null if not provided organizationindustryprimary string defines a field that represents the primary industry of an organization as a string, which can be null if not specified organizationheadofficecountry string defines a field that specifies the country where an organization is based, represented as a string, which can be null if not provided organizationheadofficestate string defines a field that specifies the state where an organization is based, represented as a string, which can be null if not provided organizationlatestannualnumberofemployeesdisclosed int defines a field that represents the most recent publicly disclosed number of employees for an organization in its latest annual report as an integer, which can be null if not provided organizationlatestdailymarketcap float defines a field that represents the most recent daily market capitalization of an organization as a floating point number, which can be null if not provided organizationlatestannualmarketrevenue float defines a field that represents the most recent annual market revenue of an organization as a floating point number, which can be null if not provided roleid id defines a field that represents the unique identifier of a role roletitle string defines a field that represents the title or name of a role as a string, which can be null if not provided roletitlecategory string defines a field that categorizes the role title as a string, which can be null if not specified roletitlecategorygroupname string defines a field that categorizes the role title group name as a string, which can be null if not specified roletype string deprecated use roletypes instead roletypes \[string!] denotes all the types of a role a person holds at an organization i e board role and employment role rolestatus string defines a field that represents the status of a role as a string, which can be null if not specified rolestartdate dateinformation defines a field that represents the start date for when the role began roleenddate dateinformation defines a field that represents the end date for when the role ended educationid id defines a field that represents the unique identifier of an education record, which can be null if not provided educationorganizationname string defines a field that represents the name of the educational institution as a string, which can be null if not provided educationqualification string represents the educational qualification of a person in the search results, providing details about their highest attained degree or certification educationqualificationcategory string defines a field that specifies the category or type of educational qualification as a string, which can be null if not provided educationqualificationdate dateinformation defines a field that represents the date associated with the educational qualification, typically using a custom dateinformation type to store date related details, which can be null if not provided matchtype matchtypeenum defines a field that specifies the type of match as matchtypeenum earningindicatordescription string defines a field related to persons earning, providing insight into their financial or professional standing birthplace birthplace defines a field related to the information about the person's place of birth, including city, state and country when available totalcharitabledonationvalue float defines a field related to the total charitable donation value totalpoliticaldonationvalue float defines a field related to the total political donation value nationality \[nationality!] this refers to the citizenship of a person, i e , having legal documents of citizenship such as a passport relationshipstatus string this describes the romantic relationship that a person has, such as being married, single, windowed, etc totalnetworth float the net worth of a person that is calculated as the total assets value minus the liabilities value totalassetvalue float this is the sum of the estimated values of all the different asset types a person has estimatedliquidassets float this is the estimated value of all the funds immediately available or convertible to known cash amounts within 90 days without significant risk of value change this is also known as cash sourceofwealth string this refers to the classification of a person in terms of how they accumolated their wealth (inheritance, inheritance & self made, self made, or unkown) wealthtier string the classification of a person according to the size of their wealth; likely very high net worth, confirmed very high net worth, likely ultra high net worth, confirmed ultra high net worth privateholdingvalue float this refers to the estimated value of a person's ownership in a private company (private equity), which means its shares are not traded on a public stock exchange cashandothervalue float this is the estimated value of a particular cash asset, that is immediately available or convertible to known cash amounts within 90 days without significant risk of value change this is also know as liquid assets commonstockvalue float the estimated value of a person's common stock, which is a fractional ownership stake in a company, granting shareholders voting rights on corporate policy and the board of directors, as well as a claim on residual profits through dividends or stock appreciation shareholders have a lower priority for payouts in a liquidation event, as creditors and preferred stockholders are paid first stockoptionvalue float the estimated value of a person's stock option, which refers to the worth or potential financial benefit of a stock option — that is, the right (but not the obligation) to buy or sell a company’s stock at a predetermined price (called the strike price) within a certain period the strike price is usually lower than the current price of the stock alternateassetvalue float the estimated value of a person's non traditional assets (stocks, bonds, and cash) examples of alternative assets include private equity or hedge funds, commodities, and collectibles personaladdress \[personaladdress!] the address of a person that is used for personal, non work related activities interests \[interest!] a person's interests, which fall under one or more interest categories (genres) and one or more human pursuits publicboardcount boardcount the count of public board positions the person holds, broken down by current, historical, and total privateboardcount boardcount the count of private board positions the person holds, broken down by current, historical, and total otherboardcount boardcount the count of other board positions the person holds, broken down by current, historical, and total monthsonboardatorganization int the number of months the person has served on the board at their primary organization monthswithorganization int the number of months the person has been associated with their primary organization monthsinrole int the number of months the person has been in their current role isexecutivedirector boolean indicates whether the person holds an executive director position isnonexecutivedirector boolean indicates whether the person holds a non executive director position ispartofleadershipteam boolean indicates whether the person is part of the leadership team matchtypeenum values value description person n/a role n/a education n/a role education n/a assetclassification values value description private holding n/a common stocks n/a common stock n/a stock options n/a cash and other n/a alternate assets n/a boardcountinput description use this input when wanting to include board count filters in your advanced search query personsortablefields description the field available for determining the sort order of the query values value description id n/a name n/a last name n/a gender n/a age n/a deceased n/a organization name n/a organization type n/a organization sector primary n/a organization industry primary n/a organization country n/a organization number of employees n/a organization market capital n/a organization revenue n/a role title n/a role title category n/a role title category group name n/a role type n/a role status n/a role duration n/a role start date n/a role end date n/a education organization name n/a education qualification n/a education qualification category n/a education qualification date n/a organization head office state n/a organization head office country n/a earning indicator description n/a birthplace city n/a birthplace state n/a birthplace country n/a total charitable donation value n/a total political donation value n/a total net worth n/a total asset value n/a estimated liquid assets n/a relationship status n/a wealth source n/a wealth tier n/a private holding value n/a cash and other value n/a common stock value n/a stock option value n/a alternate asset value n/a current board public count n/a historical board public count n/a total board public count n/a current board private count n/a historical board private count n/a total board private count n/a current board other count n/a historical board other count n/a total board other count n/a total board count n/a current board count n/a months on board at organization n/a months with organization n/a months in role n/a is executive director n/a is non executive director n/a is part of leadership team n/a personcountresult fields name type description value int! defines a non nullable field that represents an integer value, meaning it must always have a valid integer provided totalresults int! defines the total number of people matching the search or filter criteria, providing a count of all relevant records totalpersonresults int! defines the total number of person records that match the applied search criteria, providing a summary count for result downloadinformation fields name type description url string represents the url as a string where a downloadable resource or document can be accessed wealthassetpagedresult fields name type description items \[wealthasset!]! list of wealth assets pageinforesponse pageinforesponse paging information linked to the paged set of results, including the number of results and tokens for paging forwards and backward wealthasset fields name type description id id! the identifier of a particular asset, which could be of any classification and type (e g , alternate asset property) owner \[persondetails] the individual(s) who hold ownership or beneficial interest in the asset name string the name or identifying label of the asset (e g , “abc holdings llc”, “tesla inc ”) classification string the high level classification of the asset from a financial perspective (alternative assets, cash & others, common stock, private holdings, or stock options) type string the type of the asset from a physical perspective (e g, cryptocurrency, gold, property, etc ) liquiditytype string the type of the asset from an asset liquidity perspective, i e , the ease with which the asset can be converted to cash (e g , illiquid, or liquid) remarks string additional notes, context, or commentary about the asset, such as valuation method, market notes, or source value float this is the current value of the asset in usd, which is usually estimated ownershippercentage float the is the percentage of ownership in the asset that a person has, which may be an estimate ownershipvalue float this is the value of the ownership in the asset that a person has for their share, which may be an estimate relatedorganization relatedorganizationdetails the organization in which the asset represents ownership purchasedate dateinformation the date the asset was purchased organizationticker string an organization's ticker, also known as a ticker symbol, is a unique series of letters, and sometimes numbers, that serves as an abbreviation to identify its publicly traded securities on a stock exchange if the onwed asset is a stock, then the tickcer is used an identifier of the organization relatedorganizationdetails fields name type description id id! unique identifier for an organization organizationname string an official (full name) of organization organizationtype string denotes the nature or type of business sectorprimary string company sector information associated with the organization headofficeaddress address represents the address of the organization headquarters latestdailymarketcapital float the latest market capital $ amount for the organization latestannualmarketrevenue float the latest annual market revenue $ amount for the organization latestannualnumberofemployeesdisclosed int the latest figure for the number of employees the organization has organizationcurrency fields name type description disclosedvaluemin float represents the lowest monetary amount in the organization's financial disclosure, denominated in its specific currency disclosedvaluemax float represents the highest monetary amount in the organization's financial disclosure, denominated in its specific currency usdvaluemin float represents the lowest currency value in united states dollars (usd) usdvaluemax float represents the maximum currency value in united states dollars (usd) currencyname string full name of the currency measurementdate dateinformation the date the organization numeric value was taken periodname string represents the financial reporting period when transactions and financial data are recorded organizationnumeric fields name type description organizationnumericvalue float refers to a numeric value associated to an organization stored as an integer or fractional part measurementdate dateinformation the date the organization numeric value was taken periodname string represents the financial reporting period of the numeric value award fields name type description id id! unique identifier for the entity person persondetails query to return people organization organizationdetails query to return organizations awarddate dateinformation represents the date on which an person received the specific award or recognition award string signifies a formal recognition or honor received by an person for their achievements or contributions