Data Dictionaries
Profile API
48 min
queries queries below is a list of available queries you can use to retrieve data from the profile api field description info query to return health info rolesemployment root query to return the employment roles an individual holds within an organization memberships root query to return organization details an individual is a member of personidsearch root query for searching a single person id personbulkidsearch root query for bulk search of person ids personkeywordsearch root query for keyword search of persons personsearch root query to search for people based on specified filters and criteria ,enabling users to retrieve relevant person data from the system personsearchcount root query to retrieve the total number of people that matched specified criteria,providing a count of the results before fetching the actual data organizationidsearch root query for searching a single organization by id organizationbulkidsearch root query for bulk search of organization ids organizationkeywordsearch root query for keyword search of organizations organizationsearch root 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 root 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 rolesboard root query that returns details of the board roles an individual holds within an organization rolesemployment root query to return the employment roles an individual holds within an organization rolescommittee 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 objects objects the following objects describe the structure of the data you’ll receive from the api, including field names, data types, and what each field represents address field type description address string https //github com/em altrata/prism/blob/fred branch archbee/docs/profile api graph ql schema graphql pure markdown without backslashes md#string the address line 1 of the organization headquarters location zip string https //github com/em altrata/prism/blob/fred branch archbee/docs/profile api graph ql schema graphql pure markdown without backslashes md#string the postcode or zip code of organization headquarter's location state string https //github com/em altrata/prism/blob/fred branch archbee/docs/profile api graph ql schema graphql pure markdown without backslashes md#string the state of the organization headquarter's location city string https //github com/em altrata/prism/blob/fred branch archbee/docs/profile api graph ql schema graphql pure markdown without backslashes md#string the city of the organization headquarter's location country string https //github com/em altrata/prism/blob/fred branch archbee/docs/profile api graph ql schema graphql pure markdown without backslashes md#string the country of the organization headquarter's location dateinformation field type description date awsdate https //github com/em altrata/prism/blob/fred branch archbee/docs/profile api graph ql schema graphql pure markdown without backslashes md#awsdate the date displayed as year month & day dateprecision dateprecision https //github com/em altrata/prism/blob/fred branch archbee/docs/profile api graph ql schema graphql pure markdown without backslashes md#dateprecision indicates the precision that date information is provided (to the day, month, or year) displaydate string https //github com/em altrata/prism/blob/fred branch archbee/docs/profile api graph ql schema graphql pure markdown without backslashes md#string refers to the date values which are accurate to the iso 8601 format for calendar dates education field type description id id https //github com/em altrata/prism/blob/fred branch archbee/docs/profile api graph ql schema graphql pure markdown without backslashes md#id unique identifier for the entity person persondetails https //github com/em altrata/prism/blob/fred branch archbee/docs/profile api graph ql schema graphql pure markdown without backslashes md#persondetails query to return people organization organizationdetails https //github com/em altrata/prism/blob/fred branch archbee/docs/profile api graph ql schema graphql pure markdown without backslashes md#organizationdetails query to return organizations startdate dateinformation https //github com/em altrata/prism/blob/fred branch archbee/docs/profile api graph ql schema graphql pure markdown without backslashes md#dateinformation the date for when the education commenced enddate dateinformation https //github com/em altrata/prism/blob/fred branch archbee/docs/profile api graph ql schema graphql pure markdown without backslashes md#dateinformation the date for when the education was completed qualification string https //github com/em altrata/prism/blob/fred branch archbee/docs/profile api graph ql schema graphql pure markdown without backslashes md#string the actual qualification gained qualificationcategory string https //github com/em altrata/prism/blob/fred branch archbee/docs/profile api graph ql schema graphql pure markdown without backslashes md#string categorization of obtained education to denote the level of the qualification educationorganizationname string https //profile altrata com/v1/graphiql/# an official (full name) of the education establishment educationqualification string https //profile altrata com/v1/graphiql/# the actual qualification gained educationqualificationcompletiondate awsdate https //github com/em altrata/prism/blob/fred branch archbee/docs/profile api graph ql schema graphql pure markdown without backslashes md#awsdate the date that the qualification was completed or ended errordetail field type description message string https //github com/em altrata/prism/blob/fred branch archbee/docs/profile api graph ql schema graphql pure markdown without backslashes md#string ! a brief description of the issue that occurred this message helps explain the error, though it may not provide specific technical details path string https //github com/em altrata/prism/blob/fred branch archbee/docs/profile api graph ql schema graphql pure markdown without backslashes md#string indicates the specific endpoint or resource path where the error occurred within the api this helps in identifying the exact location of the issue for debugging and troubleshooting code string https //github com/em altrata/prism/blob/fred branch archbee/docs/profile api graph ql schema graphql pure markdown without backslashes md#string represents a unique identifier for the specific error type, allowing clients to categorize and handle errors efficiently genericerror field type description errorcode string https //github com/em altrata/prism/blob/fred branch archbee/docs/profile api graph ql schema graphql pure markdown without backslashes md#string ! displays the error code correlationid string https //github com/em altrata/prism/blob/fred branch archbee/docs/profile api graph ql schema graphql pure markdown without backslashes md#string ! an id used to correlate logs and metrics across services and processes errormessage string https //github com/em altrata/prism/blob/fred branch archbee/docs/profile api graph ql schema graphql pure markdown without backslashes md#string ! a brief description of the issue that occurred this message helps explain the error, though it may not provide specific technical details validationerror field type description errorcode string https //github com/em altrata/prism/blob/fred branch archbee/docs/profile api graph ql schema graphql pure markdown without backslashes md#string ! displays the error code correlationid string https //github com/em altrata/prism/blob/fred branch archbee/docs/profile api graph ql schema graphql pure markdown without backslashes md#string ! the id used to correlate logs and metrics across services and processes errormessage string https //github com/em altrata/prism/blob/fred branch archbee/docs/profile api graph ql schema graphql pure markdown without backslashes md#string ! elaborates the requirement for the input values errordetails \[ errordetail https //github com/em altrata/prism/blob/fred branch archbee/docs/profile api graph ql schema graphql pure markdown without backslashes md#errordetail !] displays the detailed information about the error externalidentifier field type description source string https //github com/em altrata/prism/blob/fred branch archbee/docs/profile api graph ql schema graphql pure markdown without backslashes md#string ! the source or provider of the external id also includes other altrata products e g boardex or relsci value string https //github com/em altrata/prism/blob/fred branch archbee/docs/profile api graph ql schema graphql pure markdown without backslashes md#string the unique external id linked to the altrata id inforesponse field type description appversion string https //github com/em altrata/prism/blob/fred branch archbee/docs/profile api graph ql schema graphql pure markdown without backslashes md#string ! the app version, e g v0 1 0 163 g8ec2901 deployment string https //github com/em altrata/prism/blob/fred branch archbee/docs/profile api graph ql schema graphql pure markdown without backslashes md#string ! deployment used whether its blue or green or n/a environment string https //github com/em altrata/prism/blob/fred branch archbee/docs/profile api graph ql schema graphql pure markdown without backslashes md#string ! environment used whether its dev/qa/prod/etc healthy boolean https //github com/em altrata/prism/blob/fred branch archbee/docs/profile api graph ql schema graphql pure markdown without backslashes md#boolean ! returns the status of the service and the dependencies schemaversion string https //github com/em altrata/prism/blob/fred branch archbee/docs/profile api graph ql schema graphql pure markdown without backslashes md#string ! the metadata and appsync schema version matchdetails field type description name string https //github com/em altrata/prism/blob/fred branch archbee/docs/profile api graph ql schema graphql pure markdown without backslashes md#string the person name that is returned based on the details matched in the search criteria organization string https //github com/em altrata/prism/blob/fred branch archbee/docs/profile api graph ql schema graphql pure markdown without backslashes md#string the organization name that is returned based on the details matched in the search criteria membership field type description id id https //github com/em altrata/prism/blob/fred branch archbee/docs/profile api graph ql schema graphql pure markdown without backslashes md#id unique identifier for the entity person persondetails https //github com/em altrata/prism/blob/fred branch archbee/docs/profile api graph ql schema graphql pure markdown without backslashes md#persondetails key person attributes for the person the membership is associated to organization organizationdetails https //github com/em altrata/prism/blob/fred branch archbee/docs/profile api graph ql schema graphql pure markdown without backslashes md#organizationdetails key organization attributes for the person the membership is associated to title string https //github com/em altrata/prism/blob/fred branch archbee/docs/profile api graph ql schema graphql pure markdown without backslashes md#string the title associated to the person’s membership affiliation startdate dateinformation https //github com/em altrata/prism/blob/fred branch archbee/docs/profile api graph ql schema graphql pure markdown without backslashes md#dateinformation date year, month, and day when the person’s membership began enddate dateinformation https //github com/em altrata/prism/blob/fred branch archbee/docs/profile api graph ql schema graphql pure markdown without backslashes md#dateinformation date year, month, and day when the person’s membership ended currentpriorstatus currentpriorstatus https //github com/em altrata/prism/blob/fred branch archbee/docs/profile api graph ql schema graphql pure markdown without backslashes md#currentpriorstatus indicates if the membership is current or prior (historic) organization field type description matchtype matchtype https //github com/em altrata/prism/blob/fred branch archbee/docs/profile api graph ql schema graphql pure markdown without backslashes md#matchtype the match type of the query result {exact, fuzzy, combined, or combined fuzzy} id id https //github com/em altrata/prism/blob/fred branch archbee/docs/profile api graph ql schema graphql pure markdown without backslashes md#id unique identifier for an organization organizationname string https //github com/em altrata/prism/blob/fred branch archbee/docs/profile api graph ql schema graphql pure markdown without backslashes md#string the official (full name) of organization organizationtype string https //github com/em altrata/prism/blob/fred branch archbee/docs/profile api graph ql schema graphql pure markdown without backslashes md#string denotes the nature or type of business tickerprimary string https //github com/em altrata/prism/blob/fred branch archbee/docs/profile api graph ql schema graphql pure markdown without backslashes md#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 https //github com/em altrata/prism/blob/fred branch archbee/docs/profile api graph ql schema graphql pure markdown without backslashes md#dateinformation the date when the organization ceased to exist sectorprimary string https //github com/em altrata/prism/blob/fred branch archbee/docs/profile api graph ql schema graphql pure markdown without backslashes md#string a primary sector refers to a broader classification of the economic activity an organization is involved with, which comprises of 32 types e g banking & finance headofficeaddress address https //github com/em altrata/prism/blob/fred branch archbee/docs/profile api graph ql schema graphql pure markdown without backslashes md#address represents the address of the organization headquarters datefounded dateinformation https //github com/em altrata/prism/blob/fred branch archbee/docs/profile api graph ql schema graphql pure markdown without backslashes md#dateinformation the date when the organization was established website string https //github com/em altrata/prism/blob/fred branch archbee/docs/profile api graph ql schema graphql pure markdown without backslashes md#string the public website for an organization when available ultimateparentid id https //github com/em altrata/prism/blob/fred branch archbee/docs/profile api graph ql schema graphql pure markdown without backslashes md#id the unique id of ultimate parent company the topmost company within the hierarchy of the organization ultimateparentname string https //github com/em altrata/prism/blob/fred branch archbee/docs/profile api graph ql schema graphql pure markdown without backslashes md#string the name of ultimate parent company the topmost company within the hierarchy of the organization isultimateparent boolean https //github com/em altrata/prism/blob/fred branch archbee/docs/profile api graph ql schema graphql pure markdown without backslashes md#boolean indicator to identify if the organization is ultimate parent company or not latestdailymarketcapital float https //github com/em altrata/prism/blob/fred branch archbee/docs/profile api graph ql schema graphql pure markdown without backslashes md#float the latest market capital $ amount for the organization latestdailymarketcapitalmeasurementdate dateinformation https //github com/em altrata/prism/blob/fred branch archbee/docs/profile api graph ql schema graphql pure markdown without backslashes md#dateinformation the latest date the market capital $ amount was collected for the organization latestannualmarketrevenue float https //github com/em altrata/prism/blob/fred branch archbee/docs/profile api graph ql schema graphql pure markdown without backslashes md#float the latest annual market revenue $ amount for the organization latestannualmarketrevenuemeasurementdate dateinformation https //github com/em altrata/prism/blob/fred branch archbee/docs/profile api graph ql schema graphql pure markdown without backslashes md#dateinformation the latest date the annual market revenue $ amount was collected for the organization latestannualnumberofemployeesdisclosed int https //github com/em altrata/prism/blob/fred branch archbee/docs/profile api graph ql schema graphql pure markdown without backslashes md#int the latest figure for the number of employees the organization has latestannualnumberofemployeesdisclosedmeasurementdate dateinformation https //github com/em altrata/prism/blob/fred branch archbee/docs/profile api graph ql schema graphql pure markdown without backslashes md#dateinformation the latest date taken for the number of employees the organization has boardroles rolepagedresult https //github com/em altrata/prism/blob/fred branch archbee/docs/profile api graph ql schema graphql pure markdown without backslashes md#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 employmentroles rolepagedresult https //github com/em altrata/prism/blob/fred branch archbee/docs/profile api graph ql schema graphql pure markdown without backslashes md#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 https //github com/em altrata/prism/blob/fred branch archbee/docs/profile api graph ql schema graphql pure markdown without backslashes md#externalidentifier ] the list of external id’s associated to the organization profile from the altrata foundation brands country string https //profile altrata com/v1/graphiql/# the country of the organization headquarter's location marketcap float https //profile altrata com/v1/graphiql/# the latest market capital $ amount for the organization numberofemployees string https //profile altrata com/v1/graphiql/# the latest figure for the number of employees the organization has organizationlistids int https //profile altrata com/v1/graphiql/# query to filter person records based on a list of organization ids, enabling the search to be restricted to persons associated with specific organizations revenue float https //profile altrata com/v1/graphiql/# the latest annual market revenue $ amount for the organization state string https //profile altrata com/v1/graphiql/# the state of the organization headquarter's location organizationcountry string https //profile altrata com/v1/graphiql/# the country of the organization headquarter's location organizationprimaryindustry string https //profile altrata com/v1/graphiql/# a primary industry refers to a granular classification of the economic activity an organization is involved with, e g retail & commercial banking organizationprimarysector string https //profile altrata com/v1/graphiql/# a primary sector refers to a broader classification of the economic activity an organization is involved with, e g banking & finance organizationcurrency field type description disclosedvaluemin float https //github com/em altrata/prism/blob/fred branch archbee/docs/profile api graph ql schema graphql pure markdown without backslashes md#float represents the lowest monetary amount in the organization's financial disclosure, denominated in its specific currency disclosedvaluemax float https //github com/em altrata/prism/blob/fred branch archbee/docs/profile api graph ql schema graphql pure markdown without backslashes md#float represents the highest monetary amount in the organization's financial disclosure, denominated in its specific currency usdvaluemin float https //github com/em altrata/prism/blob/fred branch archbee/docs/profile api graph ql schema graphql pure markdown without backslashes md#float represents the lowest currency value in united states dollars (usd) usdvaluemax float https //github com/em altrata/prism/blob/fred branch archbee/docs/profile api graph ql schema graphql pure markdown without backslashes md#float represents the maximum currency value in united states dollars (usd) currencyname string https //github com/em altrata/prism/blob/fred branch archbee/docs/profile api graph ql schema graphql pure markdown without backslashes md#string full name of the currency measurementdate dateinformation https //github com/em altrata/prism/blob/fred branch archbee/docs/profile api graph ql schema graphql pure markdown without backslashes md#dateinformation the date the organization numeric value was taken periodname string https //github com/em altrata/prism/blob/fred branch archbee/docs/profile api graph ql schema graphql pure markdown without backslashes md#string represents the financial reporting period when transactions and financial data are recorded organizationdetails field type description id id https //github com/em altrata/prism/blob/fred branch archbee/docs/profile api graph ql schema graphql pure markdown without backslashes md#id ! unique identifier for an organization organizationname string https //github com/em altrata/prism/blob/fred branch archbee/docs/profile api graph ql schema graphql pure markdown without backslashes md#string the official (full name) of organization organizationtype string https //github com/em altrata/prism/blob/fred branch archbee/docs/profile api graph ql schema graphql pure markdown without backslashes md#string denotes the nature or type of business sectorprimary string https //github com/em altrata/prism/blob/fred branch archbee/docs/profile api graph ql schema graphql pure markdown without backslashes md#string company sector information associated with the organization headofficeaddress address https //github com/em altrata/prism/blob/fred branch archbee/docs/profile api graph ql schema graphql pure markdown without backslashes md#address represents the address of the organization headquarters latestdailymarketcapital float https //github com/em altrata/prism/blob/fred branch archbee/docs/profile api graph ql schema graphql pure markdown without backslashes md#float the latest market capital $ amount for the organization latestannualmarketrevenue float https //github com/em altrata/prism/blob/fred branch archbee/docs/profile api graph ql schema graphql pure markdown without backslashes md#float the latest annual market revenue $ amount for the organization latestannualnumberofemployeesdisclosed int https //github com/em altrata/prism/blob/fred branch archbee/docs/profile api graph ql schema graphql pure markdown without backslashes md#int the latest figure for the number of employees the organization has organizationnumeric field type description organizationnumericvalue float https //github com/em altrata/prism/blob/fred branch archbee/docs/profile api graph ql schema graphql pure markdown without backslashes md#float refers to a numeric value associated to an organization stored as an integer or fractional part measurementdate dateinformation https //github com/em altrata/prism/blob/fred branch archbee/docs/profile api graph ql schema graphql pure markdown without backslashes md#dateinformation the date the organization numeric value was taken periodname string https //github com/em altrata/prism/blob/fred branch archbee/docs/profile api graph ql schema graphql pure markdown without backslashes md#string represents the financial reporting period of the numeric value pageinfo field type description hasnextpage boolean https //github com/em altrata/prism/blob/fred branch archbee/docs/profile api graph ql schema graphql pure markdown without backslashes md#boolean when paginating forwards, are there more items startcursor string https //github com/em altrata/prism/blob/fred branch archbee/docs/profile api graph ql schema graphql pure markdown without backslashes md#string when paginating forwards, the token to continue endcursor string https //github com/em altrata/prism/blob/fred branch archbee/docs/profile api graph ql schema graphql pure markdown without backslashes md#string when paginating backwards, the token to continue pageinforesponse field type description totalcount int https //github com/em altrata/prism/blob/fred branch archbee/docs/profile api graph ql schema graphql pure markdown without backslashes md#int identifies the total count of items in the results pageinfo pageinfo https //github com/em altrata/prism/blob/fred branch archbee/docs/profile api graph ql schema graphql pure markdown without backslashes md#pageinfo information about pagination in a paged set of results person field type description matchtype matchtype https //github com/em altrata/prism/blob/fred branch archbee/docs/profile api graph ql schema graphql pure markdown without backslashes md#matchtype the match type of the query result {exact, fuzzy, combined, or combined fuzzy} matchdetails matchdetails https //github com/em altrata/prism/blob/fred branch archbee/docs/profile api graph ql schema graphql pure markdown without backslashes md#matchdetails the match details of the query result which include name and organization name string https //github com/em altrata/prism/blob/fred branch archbee/docs/profile api graph ql schema graphql pure markdown without backslashes md#string the individual's full name comprising of first, middle, & last names example satya nadella id id https //github com/em altrata/prism/blob/fred branch archbee/docs/profile api graph ql schema graphql pure markdown without backslashes md#id unique identifier for an individual profile firstname string https //github com/em altrata/prism/blob/fred branch archbee/docs/profile api graph ql schema graphql pure markdown without backslashes md#string the individual’s first name middlename string https //github com/em altrata/prism/blob/fred branch archbee/docs/profile api graph ql schema graphql pure markdown without backslashes md#string the individual’s middle name lastname string https //github com/em altrata/prism/blob/fred branch archbee/docs/profile api graph ql schema graphql pure markdown without backslashes md#string the individual’s last name suffix string https //github com/em altrata/prism/blob/fred branch archbee/docs/profile api graph ql schema graphql pure markdown without backslashes md#string follows an individual's full name and provides additional information about the person salutation string https //github com/em altrata/prism/blob/fred branch archbee/docs/profile api graph ql schema graphql pure markdown without backslashes md#string the individual’s title or prefix gender string https //github com/em altrata/prism/blob/fred branch archbee/docs/profile api graph ql schema graphql pure markdown without backslashes md#string value is provided as male or female, when available age int https //github com/em altrata/prism/blob/fred branch archbee/docs/profile api graph ql schema graphql pure markdown without backslashes md#int the individual's age derived from date of birth dateofbirth dateinformation https //github com/em altrata/prism/blob/fred branch archbee/docs/profile api graph ql schema graphql pure markdown without backslashes md#dateinformation a date or approximate date when individual is born (dddd mm dd) isdeceased boolean https //github com/em altrata/prism/blob/fred branch archbee/docs/profile api graph ql schema graphql pure markdown without backslashes md#boolean indicator to identify if the person is deceased or not dateofdeath dateinformation https //github com/em altrata/prism/blob/fred branch archbee/docs/profile api graph ql schema graphql pure markdown without backslashes md#dateinformation a date or approximate date when individual died (dddd mm dd) linkedinprimary string https //github com/em altrata/prism/blob/fred branch archbee/docs/profile api graph ql schema graphql pure markdown without backslashes md#string the linkedin url of the person rolesemployment rolepagedresult https //github com/em altrata/prism/blob/fred branch archbee/docs/profile api graph ql schema graphql pure markdown without backslashes md#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 https //github com/em altrata/prism/blob/fred branch archbee/docs/profile api graph ql schema graphql pure markdown without backslashes md#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 https //github com/em altrata/prism/blob/fred branch archbee/docs/profile api graph ql schema graphql pure markdown without backslashes md#educationpagedresult refers to the actual qualification gained memberships membershippagedresult https //github com/em altrata/prism/blob/fred branch archbee/docs/profile api graph ql schema graphql pure markdown without backslashes md#membershippagedresult all the memberships that are currently or historically held by the person externalidentifiers \[ externalidentifier https //github com/em altrata/prism/blob/fred branch archbee/docs/profile api graph ql schema graphql pure markdown without backslashes md#externalidentifier ] the list of external id’s associated to the person profile from the altrata foundation brands roleprimary role https //github com/em altrata/prism/blob/fred branch archbee/docs/profile api graph ql schema graphql pure markdown without backslashes md#role the role details associated to the primary role for the person executivesummary string https //github com/em altrata/prism/blob/fred branch archbee/docs/profile api graph ql schema graphql pure markdown without backslashes md#string the executive summary associated with the person personlistids int https //profile altrata com/v1/graphiql/# allows the query to filter person records based on a list of person ids, enabling the search to be refined by specifying which individuals to include in the results personkeywordsearchfilter string https //profile altrata com/v1/graphiql/# allows users to apply specific search terms or keywords to filter and narrow down query results based on relevant content persondetails field type description name string https //github com/em altrata/prism/blob/fred branch archbee/docs/profile api graph ql schema graphql pure markdown without backslashes md#string the individual's full name comprising of first, middle, & last names example satya nadella id id https //github com/em altrata/prism/blob/fred branch archbee/docs/profile api graph ql schema graphql pure markdown without backslashes md#id ! unique identifier for an individual profile age int https //github com/em altrata/prism/blob/fred branch archbee/docs/profile api graph ql schema graphql pure markdown without backslashes md#int the individual's age derived from date of birth gender string https //github com/em altrata/prism/blob/fred branch archbee/docs/profile api graph ql schema graphql pure markdown without backslashes md#string value is provided as male or female, when available role field type description id id https //github com/em altrata/prism/blob/fred branch archbee/docs/profile api graph ql schema graphql pure markdown without backslashes md#id unique identifier for the entity person persondetails https //github com/em altrata/prism/blob/fred branch archbee/docs/profile api graph ql schema graphql pure markdown without backslashes md#persondetails query to return core attributes of a person organization organizationdetails https //github com/em altrata/prism/blob/fred branch archbee/docs/profile api graph ql schema graphql pure markdown without backslashes md#organizationdetails query to return core details of an organization startdate dateinformation https //github com/em altrata/prism/blob/fred branch archbee/docs/profile api graph ql schema graphql pure markdown without backslashes md#dateinformation the start date for when the role began enddate dateinformation https //github com/em altrata/prism/blob/fred branch archbee/docs/profile api graph ql schema graphql pure markdown without backslashes md#dateinformation the end date for when the role ended type string https //github com/em altrata/prism/blob/fred branch archbee/docs/profile api graph ql schema graphql pure markdown without backslashes md#string denotes the type of a role a person holds i e board role or employment role status currentpriorstatus https //github com/em altrata/prism/blob/fred branch archbee/docs/profile api graph ql schema graphql pure markdown without backslashes md#currentpriorstatus refers to the status of the role a person holds title string https //github com/em altrata/prism/blob/fred branch archbee/docs/profile api graph ql schema graphql pure markdown without backslashes md#string denotes a specific designation or label given to an individual to indicate their role, responsibilities, and level within the organization titlecategory string https //github com/em altrata/prism/blob/fred branch archbee/docs/profile api graph ql schema graphql pure markdown without backslashes md#string they refer to a grouping or classification of roles based on common characteristics filter inputs filter inputs organizationsearchfilterinput field type description gte float https //profile altrata com/v1/graphiql/# use this string to restrict the query so it only returns float values greater than the input lte float https //profile altrata com/v1/graphiql/# use this string to restrict the query so it only returns float values less than the input searchvalues string https //github com/em altrata/prism/blob/fred branch archbee/docs/profile api graph ql schema graphql pure markdown without backslashes md#string the search values entered in the searchable strings filter ids boolean https //profile altrata com/v1/graphiql/# this boolean can be used to specify if you want to exclude the values you are searching for rather than including it exclude boolean https //profile altrata com/v1/graphiql/# this boolean can be used to specify if you want to exclude the values you are searching for rather than including them includenulls boolean https //profile altrata com/v1/graphiql/# this boolean can be used if you want to include null values in your search response membershipfilterinput field type description organizationid id https //github com/em altrata/prism/blob/fred branch archbee/docs/profile api graph ql schema graphql pure markdown without backslashes md#id query to return memberships based on organization id filter input personid id https //github com/em altrata/prism/blob/fred branch archbee/docs/profile api graph ql schema graphql pure markdown without backslashes md#id query to return memberships based on person id filter input currentpriorstatus \[ currentpriorstatus https //github com/em altrata/prism/blob/fred branch archbee/docs/profile api graph ql schema graphql pure markdown without backslashes md#currentpriorstatus !] filter to search individual roles by current or prior status startfromdate awsdate https //github com/em altrata/prism/blob/fred branch archbee/docs/profile api graph ql schema graphql pure markdown without backslashes md#awsdate query to return memberships based on start from date filter input starttodate awsdate https //github com/em altrata/prism/blob/fred branch archbee/docs/profile api graph ql schema graphql pure markdown without backslashes md#awsdate query to return memberships based on start to date filter input endfromdate awsdate https //github com/em altrata/prism/blob/fred branch archbee/docs/profile api graph ql schema graphql pure markdown without backslashes md#awsdate query to return memberships based on end from date filter input endtodate awsdate https //github com/em altrata/prism/blob/fred branch archbee/docs/profile api graph ql schema graphql pure markdown without backslashes md#awsdate query to return memberships based on end to date filter input organizationbulkidsearchfilterinput field type description ids \[ id https //github com/em altrata/prism/blob/fred branch archbee/docs/profile api graph ql schema graphql pure markdown without backslashes md#id ] query input for a list of ids to match against organizationfilterinput field type description searchkeyword string https //github com/em altrata/prism/blob/fred branch archbee/docs/profile api graph ql schema graphql pure markdown without backslashes md#string keyword input for a query to match against ids \[ id https //github com/em altrata/prism/blob/fred branch archbee/docs/profile api graph ql schema graphql pure markdown without backslashes md#id ] query input for a list of ids to match against organizationkeywordsearchfilterinput field type description searchkeyword string https //github com/em altrata/prism/blob/fred branch archbee/docs/profile api graph ql schema graphql pure markdown without backslashes md#string keyword input for a query to match against pageinfoinput field type description before string https //github com/em altrata/prism/blob/fred branch archbee/docs/profile api graph ql schema graphql pure markdown without backslashes md#string when paginating backwards, the token to continue last int https //github com/em altrata/prism/blob/fred branch archbee/docs/profile api graph ql schema graphql pure markdown without backslashes md#int when paginating forwards, the number of items to return after string https //github com/em altrata/prism/blob/fred branch archbee/docs/profile api graph ql schema graphql pure markdown without backslashes md#string when paginating forwards, the token to continue first int https //github com/em altrata/prism/blob/fred branch archbee/docs/profile api graph ql schema graphql pure markdown without backslashes md#int when paginating forwards, the number of items to return filter rolefilterinput https //github com/em altrata/prism/blob/fred branch archbee/docs/profile api graph ql schema graphql pure markdown without backslashes md#rolefilterinput ! used to retrieve a filtered list of based on specified criteria pageinfo pageinfoinput https //github com/em altrata/prism/blob/fred branch archbee/docs/profile api graph ql schema graphql pure markdown without backslashes md#pageinfoinput information about pagination in a paged set of results personbulkidsearchfilterinput field type description ids \[ id https //github com/em altrata/prism/blob/fred branch archbee/docs/profile api graph ql schema graphql pure markdown without backslashes md#id ] query input for a list of ids to match against personfilterinput field type description searchkeyword string https //github com/em altrata/prism/blob/fred branch archbee/docs/profile api graph ql schema graphql pure markdown without backslashes md#string keyword input for a query to match against ids \[ id https //github com/em altrata/prism/blob/fred branch archbee/docs/profile api graph ql schema graphql pure markdown without backslashes md#id ] query input for a list of ids to match against personkeywordsearchfilterinput field type description searchkeyword string https //github com/em altrata/prism/blob/fred branch archbee/docs/profile api graph ql schema graphql pure markdown without backslashes md#string keyword input for a query to match against rolefilterinput field type description organizationid id https //github com/em altrata/prism/blob/fred branch archbee/docs/profile api graph ql schema graphql pure markdown without backslashes md#id filter to search individual roles by organization id personid id https //github com/em altrata/prism/blob/fred branch archbee/docs/profile api graph ql schema graphql pure markdown without backslashes md#id filter to search individual roles by person id currentpriorstatus \[ currentpriorstatus https //github com/em altrata/prism/blob/fred branch archbee/docs/profile api graph ql schema graphql pure markdown without backslashes md#currentpriorstatus !] filter to search individual roles by current or prior status startfromdate awsdate https //github com/em altrata/prism/blob/fred branch archbee/docs/profile api graph ql schema graphql pure markdown without backslashes md#awsdate filter to search individual roles by role start from date starttodate awsdate https //github com/em altrata/prism/blob/fred branch archbee/docs/profile api graph ql schema graphql pure markdown without backslashes md#awsdate filter to search individual roles by role start to date endfromdate awsdate https //github com/em altrata/prism/blob/fred branch archbee/docs/profile api graph ql schema graphql pure markdown without backslashes md#awsdate filter to search individual roles by role end from date endtodate awsdate https //github com/em altrata/prism/blob/fred branch archbee/docs/profile api graph ql schema graphql pure markdown without backslashes md#awsdate filter to search individual roles by role end to date pagination pagination educationpagedresult field type description items \[ education https //github com/em altrata/prism/blob/fred branch archbee/docs/profile api graph ql schema graphql pure markdown without backslashes md#education !]! list of education items pageinforesponse pageinforesponse https //github com/em altrata/prism/blob/fred branch archbee/docs/profile api graph ql schema graphql pure markdown without backslashes md#pageinforesponse information about pagination in a paged set of results membershippagedresult field type description items \[ membership https //github com/em altrata/prism/blob/fred branch archbee/docs/profile api graph ql schema graphql pure markdown without backslashes md#membership ] list of membershipitems pageinforesponse pageinforesponse https //github com/em altrata/prism/blob/fred branch archbee/docs/profile api graph ql schema graphql pure markdown without backslashes md#pageinforesponse information about pagination in a paged set of results organizationpagedresult field type description items \[ organization https //github com/em altrata/prism/blob/fred branch archbee/docs/profile api graph ql schema graphql pure markdown without backslashes md#organization !]! list of organization items pageinforesponse pageinforesponse https //github com/em altrata/prism/blob/fred branch archbee/docs/profile api graph ql schema graphql pure markdown without backslashes md#pageinforesponse paging information linked to the paged set of results including the number of results and tokens for paging forwards and backward personpagedresult field type description items \[ person https //github com/em altrata/prism/blob/fred branch archbee/docs/profile api graph ql schema graphql pure markdown without backslashes md#person !]! list of person items pageinforesponse pageinforesponse https //github com/em altrata/prism/blob/fred branch archbee/docs/profile api graph ql schema graphql pure markdown without backslashes md#pageinforesponse paging information linked to the paged set of results, including the number of results and tokens for paging forwards and backward rolepagedresult field type description items \[ role https //github com/em altrata/prism/blob/fred branch archbee/docs/profile api graph ql schema graphql pure markdown without backslashes md#role ] list of role items pageinforesponse pageinforesponse https //github com/em altrata/prism/blob/fred branch archbee/docs/profile api graph ql schema graphql pure markdown without backslashes md#pageinforesponse paging information linked to the paged set of results, including the number of results and tokens for paging forwards and backward enums enums sort value description field the person field that drives the sortation of the query direction the direction the sortation takes can be either ascending or descending currentpriorstatus value description current indicates that the role is currently held by the individual prior indicates that the role was previously held by the individual unknown indicates that the status of the role as either current or prior is unknown dateprecision value description day indicates the precision of the date applied is to the day i e full date precision month indicates the precision of the date applied is to the month only year indicates the precision of the date applied is to the year only matchtype value description exact indicates the match type for the search response is exact fuzzy indicates the match type for the search response is fuzzy combined indicates the match type for the search response is combined combined fuzzy indicates the match type for the search response is combined fuzzy scalars scalars awsdate boolean the boolean scalar type represents true or false float the float scalar type represents signed double precision fractional values as specified by ieee 754 https //en wikipedia org/wiki/ieee floating point id the id scalar type represents a unique identifier, often used to refetch an object or as key for a cache the id type appears in a json response as a string; however, it is not intended to be human readable when expected as an input type, any string (such as "4") or integer (such as 4) input value will be accepted as an id int the int scalar type represents non fractional signed whole numeric values int can represent values between (2^31) and 2^31 1 string the string scalar type represents textual data, represented as utf 8 character sequences the string type is most often used by graphql to represent free form human readable text interfaces interfaces error field type description errorcode string https //github com/em altrata/prism/blob/fred branch archbee/docs/profile api graph ql schema graphql pure markdown without backslashes md#string ! displays the error code correlationid string https //github com/em altrata/prism/blob/fred branch archbee/docs/profile api graph ql schema graphql pure markdown without backslashes md#string ! an id used to correlate logs and metrics across services and processes errormessage string https //github com/em altrata/prism/blob/fred branch archbee/docs/profile api graph ql schema graphql pure markdown without backslashes md#string ! elaborates the requirement for the input values unions unions (errors) (errors) to know more about the union errors click here " union errors "