Example queries

7min
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.
GraphQL
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
    }
  }
}
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. 
Person Bulk ID Search
Search for up to 100 people using their Altrata IDs.
Organization Keyword Search
Find one or more organizations using a search keyword. The searchKeyword operates over the organizationName. 
Organization ID Search
Search for a specific organization using their Altrata ID. 
Organization Bulk ID Search
Search for up to 100 organizations using their Altrata IDs.
﻿
Updated 04 Oct 2024
Did this page help you?
Profile API
Matching API