APIs & Services
Profile API
Example queries
10 min
we have supplied example graphql queries that you can copy and pasted into your graphql query builder can't find the field you're looking for? remember that you can customise each of the provided example queries to return the information that matters to you person keyword search find one or more people using a search keyword the searchkeyword operates over the firstname , lastname and organizationname a combination of firstname , lastname and organizationname can be used to further refine search results query myquery { personkeywordsearch(filter {searchkeyword "david mcdonald"}) { on personpagedresult { typename items { firstname lastname rolesboard { items { organization { organizationname } startdate { displaydate } enddate { displaydate } } } rolesemployment { items { organization { organizationname organizationtype } } } education { items { person { name } organization { organizationname organizationtype } startdate { displaydate } enddate { displaydate } qualification qualificationcategory } } } } on genericerror { typename errorcode errormessage } on validationerror { typename errorcode errormessage } } } person id search search for a specific individual using their altrata id query myquery { personidsearch(id "1 per 4518022") { on person { name gender } on genericerror { typename errorcode errormessage } on validationerror { typename errorcode errormessage } } } person bulk id search search for up to 100 people using their altrata ids query myquery { personbulkidsearch(filter {ids \["1 per 41000090", "1 per 4518022"]}) { on personpagedresult { typename items { firstname rolesemployment { items { title } } } } on genericerror { typename errorcode errormessage } on validationerror { typename errorcode errormessage } } } organization keyword search find one or more organizations using a search keyword the searchkeyword operates over the organizationname query myquery { organizationkeywordsearch(filter {searchkeyword "microsoft"}) { on organizationpagedresult { typename items { organizationname organizationtype website latestdailymarketcapital latestannualmarketrevenue headofficeaddress { address city country } rolesboard { items { person { name } type title } } rolesemployment { items { person { name } type title } } } } on genericerror { typename errorcode errormessage } on validationerror { typename errorcode errormessage } } } organization id search search for a specific organization using their altrata id query myquery { organizationidsearch(id "1 org 3303587") { on organization { organizationname id organizationtype tickerprimary industryprimary sectorprimary headofficeaddress { address zip state city country } website datefounded { displaydate } latestdailymarketcapital latestannualmarketrevenue } on genericerror { typename errorcode errormessage } on validationerror { typename errorcode errormessage } } } organization bulk id search search for up to 100 organizations using their altrata ids query myquery { organizationbulkidsearch(filter {ids \["1 org 3303587", "1 org 426502756"]}) { on organizationpagedresult { typename items { organizationname id organizationtype tickerprimary industryprimary } } on genericerror { typename errorcode errormessage } on validationerror { typename errorcode errormessage } } } person search facilitates searching for individuals based on various attributes such as name, employment history, role details, and professional status sample request query myquery { personsearch( filter {age {gte 35, lte 65}, gender {searchvalues "female"}, roletitlecategory {searchvalues "ceo"}} ) { on personsearchpagedresult { typename items { name age gender roletitle rolestatus organizationname } } } } sample response { "data" { "personsearch" { " typename" "personsearchpagedresult", "items" \[ { "name" "kristi longdes", "age" 58, "gender" "female", "roletitle" "chief executive officer", "rolestatus" "prior", "organizationname" "ji org se" }, { "name" "frances kalto", "age" 60, "gender" "female", "roletitle" "joint chief executive officer", "rolestatus" "current", "organizationname" "corestandard plc" } organization search enables users to find organizations based on specific parameters such as company size, industry, revenue, and market capitalization sample request query myquery { organizationsearch( filter {country {searchvalues "united states"}, industryprimary {searchvalues "accounting & financial services"}, marketcap {gte 10000000, lte 1000000000}} ) { on organizationpagedresult { typename items { organizationname headofficeaddress { country state } latestdailymarketcapital industryprimary } } } } sample response { "data" { "organizationsearch" { " typename" "organizationpagedresult", "items" \[ { "organizationname" "polurt ab holdings, inc ", "headofficeaddress" { "country" "united states", "state" "texas" }, "latestdailymarketcapital" 76064400, "industryprimary" "accounting & financial services" }, { "organizationname" "mango financial corp ", "headofficeaddress" { "country" "united states", "state" "new york" }, "latestdailymarketcapital" 891081900, "industryprimary" "accounting & financial services" }