Example queries

13min
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.
﻿
Person  Search
Facilitates searching for individuals based on various attributes such as name, employment history, role details, and professional status. 
Sample Request
GraphQL
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
      }
    }
  }
}
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
GraphQL
{
  "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"
          }
{
  "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
GraphQL
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
      }
    }
  }
}
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
GraphQL
{
  "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"
        }
{
  "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"
        }
﻿
Export Person
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.
Sample Request
GraphQL
query MyQuery {
  exportPerson(documentType: PDF, id: "1-per-79142259") {
    url
  }
}
query MyQuery {
  exportPerson(documentType: PDF, id: "1-per-79142259") {
    url
  }
}
﻿
Sample Response
GraphQL
{
  "data": {
    "exportPerson": {
      "url": "https://alt-bucket-reports-service-ppe-v1.s3.us-east-2.amazonaws.com//reports/William_Henry_Gates%20III-2025-03-10T08-27-32.pdf?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Content-Sha256=UNSIGNED-PAYLOAD&X-Amz-Credential=ASIAT2IPICHXAZ27MZU2%2F20250310%2Fus-east-2%2Fs3%2Faws4_request&X-Amz-Date=20250310T082734Z&X-Amz-Expires=60&X-Amz-Security-Token=IQoJb3JpZ2luX2VjEEAaCXVzLWVhc3QtMiJHMEUCIQDEjP4gfF8BqsFZ6PoauYy%2B8ejyzyI1EvxTlAWp3XZ%2FwgIgZYCmo4hZs67aKV5qVpky2Edx%2Fbc3ErK9%2Bzpk3pN3Q4YqpAMIif%2F%2F%2F%2F%2F%2F%2F%2F%2F%2FARABGgwyNjI1NjE4NjIxMjYiDOnTjqYkPqZGZV%2FfRir4AuXC0VzYq0dJHH%2F9FSM405a1Rh0QIHsGcKU99rVNxHicrHhcoow1IJbuTeUbf%2BwQnPaXjKFQfkx%2BiWW%2BDkYKd%2BV3eBH9Zmxstt7eipAD2e6%2BLxM99tckgrIlFT1wA7CbcORjZwRiejsmLl%2Fu%2BcAaWqIgP3v0sVarxYDdO7DLY%2FzPt5MoaYgNd6W9aZ%2Fw2mNR593ZdAbpnY2L%2Bjm7WJ%2BsvmoMwIeEIDY1nIRDGVfM3tc3jEfPnZ1CfEJ4Po4nwNymoodTTYTKZd7Mep5K%2B9PdPBXszbsaE4LIDnkv4LglFvuZ3jnUzaRhTYbgfn3MPfnT8IFdNKSka%2BvgH8vVXA8YJemQJkehaSyvTXTGrhqGl159ZXSJNb5BtMmXG%2BpgNq4s6o9p%2FkI27Bt%2FPIPYycGuMzegRnskG8nNTiVOTiPZ%2BtR6bJwYWHcWnHp30ngLRBmkSZWLs7tIIaci%2BBegsA9zo%2FGsW4eUMwSO554gw%2FBMVYkxgnmuPihly2cwjcC6vgY6nQFEO87qrqOQOzMWbPiDdVsu9OJpyxA9o06CH5WdIJgV2xQync%2FDrc2S9hJFcmEAMCttg0YAXfwhIjbeZR%2FpvgVWmYYc4sspnehwrsErR6F%2FSPeOnqssXarNvj0GiYxSVDU%2FhGY1oTbohztK4VXk5%2B21MARKMA518h7a7qQYA8rL88paKb6%2F7nkYSctYhvKNUx7zy0DozoyumS1DL9TB&X-Amz-Signature=03b57c2449d6c31437d32626bb31083de23441ed839d61d6c2871d7fdc7f74db&X-Amz-SignedHeaders=host&response-content-disposition=attachment%3B%20filename%3D%22William_Henry_Gates%20III-2025-03-10T08-27-32.pdf%22&x-id=GetObject"
    }
  }
}
{
  "data": {
    "exportPerson": {
      "url": "https://alt-bucket-reports-service-ppe-v1.s3.us-east-2.amazonaws.com//reports/William_Henry_Gates%20III-2025-03-10T08-27-32.pdf?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Content-Sha256=UNSIGNED-PAYLOAD&X-Amz-Credential=ASIAT2IPICHXAZ27MZU2%2F20250310%2Fus-east-2%2Fs3%2Faws4_request&X-Amz-Date=20250310T082734Z&X-Amz-Expires=60&X-Amz-Security-Token=IQoJb3JpZ2luX2VjEEAaCXVzLWVhc3QtMiJHMEUCIQDEjP4gfF8BqsFZ6PoauYy%2B8ejyzyI1EvxTlAWp3XZ%2FwgIgZYCmo4hZs67aKV5qVpky2Edx%2Fbc3ErK9%2Bzpk3pN3Q4YqpAMIif%2F%2F%2F%2F%2F%2F%2F%2F%2F%2FARABGgwyNjI1NjE4NjIxMjYiDOnTjqYkPqZGZV%2FfRir4AuXC0VzYq0dJHH%2F9FSM405a1Rh0QIHsGcKU99rVNxHicrHhcoow1IJbuTeUbf%2BwQnPaXjKFQfkx%2BiWW%2BDkYKd%2BV3eBH9Zmxstt7eipAD2e6%2BLxM99tckgrIlFT1wA7CbcORjZwRiejsmLl%2Fu%2BcAaWqIgP3v0sVarxYDdO7DLY%2FzPt5MoaYgNd6W9aZ%2Fw2mNR593ZdAbpnY2L%2Bjm7WJ%2BsvmoMwIeEIDY1nIRDGVfM3tc3jEfPnZ1CfEJ4Po4nwNymoodTTYTKZd7Mep5K%2B9PdPBXszbsaE4LIDnkv4LglFvuZ3jnUzaRhTYbgfn3MPfnT8IFdNKSka%2BvgH8vVXA8YJemQJkehaSyvTXTGrhqGl159ZXSJNb5BtMmXG%2BpgNq4s6o9p%2FkI27Bt%2FPIPYycGuMzegRnskG8nNTiVOTiPZ%2BtR6bJwYWHcWnHp30ngLRBmkSZWLs7tIIaci%2BBegsA9zo%2FGsW4eUMwSO554gw%2FBMVYkxgnmuPihly2cwjcC6vgY6nQFEO87qrqOQOzMWbPiDdVsu9OJpyxA9o06CH5WdIJgV2xQync%2FDrc2S9hJFcmEAMCttg0YAXfwhIjbeZR%2FpvgVWmYYc4sspnehwrsErR6F%2FSPeOnqssXarNvj0GiYxSVDU%2FhGY1oTbohztK4VXk5%2B21MARKMA518h7a7qQYA8rL88paKb6%2F7nkYSctYhvKNUx7zy0DozoyumS1DL9TB&X-Amz-Signature=03b57c2449d6c31437d32626bb31083de23441ed839d61d6c2871d7fdc7f74db&X-Amz-SignedHeaders=host&response-content-disposition=attachment%3B%20filename%3D%22William_Henry_Gates%20III-2025-03-10T08-27-32.pdf%22&x-id=GetObject"
    }
  }
}
﻿
Note - Once we have received a response to our query, copy the URL into your browser and press enter; the pdf file will be downloaded immediately.
Export Organization
Query to initiate the generation of a downloadable file containing an organization's profile data, allowing users to retrieve and export relevant organizational information.
Sample Request
GraphQL
query MyQuery {
  exportOrganization(documentType: PDF, id: "1-org-154701") {
    url
  }
}
query MyQuery {
  exportOrganization(documentType: PDF, id: "1-org-154701") {
    url
  }
}
﻿
Sample Response
GraphQL
{
  "data": {
    "exportOrganization": {
      "url": "https://alt-bucket-reports-service-ppe-v1.s3.us-east-2.amazonaws.com//reports/Microsoft%20Corporation-2025-03-10T08-19-11.pdf?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Content-Sha256=UNSIGNED-PAYLOAD&X-Amz-Credential=ASIAT2IPICHXAZ27MZU2%2F20250310%2Fus-east-2%2Fs3%2Faws4_request&X-Amz-Date=20250310T081923Z&X-Amz-Expires=60&X-Amz-Security-Token=IQoJb3JpZ2luX2VjEEAaCXVzLWVhc3QtMiJHMEUCIQDEjP4gfF8BqsFZ6PoauYy%2B8ejyzyI1EvxTlAWp3XZ%2FwgIgZYCmo4hZs67aKV5qVpky2Edx%2Fbc3ErK9%2Bzpk3pN3Q4YqpAMIif%2F%2F%2F%2F%2F%2F%2F%2F%2F%2FARABGgwyNjI1NjE4NjIxMjYiDOnTjqYkPqZGZV%2FfRir4AuXC0VzYq0dJHH%2F9FSM405a1Rh0QIHsGcKU99rVNxHicrHhcoow1IJbuTeUbf%2BwQnPaXjKFQfkx%2BiWW%2BDkYKd%2BV3eBH9Zmxstt7eipAD2e6%2BLxM99tckgrIlFT1wA7CbcORjZwRiejsmLl%2Fu%2BcAaWqIgP3v0sVarxYDdO7DLY%2FzPt5MoaYgNd6W9aZ%2Fw2mNR593ZdAbpnY2L%2Bjm7WJ%2BsvmoMwIeEIDY1nIRDGVfM3tc3jEfPnZ1CfEJ4Po4nwNymoodTTYTKZd7Mep5K%2B9PdPBXszbsaE4LIDnkv4LglFvuZ3jnUzaRhTYbgfn3MPfnT8IFdNKSka%2BvgH8vVXA8YJemQJkehaSyvTXTGrhqGl159ZXSJNb5BtMmXG%2BpgNq4s6o9p%2FkI27Bt%2FPIPYycGuMzegRnskG8nNTiVOTiPZ%2BtR6bJwYWHcWnHp30ngLRBmkSZWLs7tIIaci%2BBegsA9zo%2FGsW4eUMwSO554gw%2FBMVYkxgnmuPihly2cwjcC6vgY6nQFEO87qrqOQOzMWbPiDdVsu9OJpyxA9o06CH5WdIJgV2xQync%2FDrc2S9hJFcmEAMCttg0YAXfwhIjbeZR%2FpvgVWmYYc4sspnehwrsErR6F%2FSPeOnqssXarNvj0GiYxSVDU%2FhGY1oTbohztK4VXk5%2B21MARKMA518h7a7qQYA8rL88paKb6%2F7nkYSctYhvKNUx7zy0DozoyumS1DL9TB&X-Amz-Signature=3c35b9a86a26a47c83fbbe79f5cb99588a3edcf7dcf814ad6066726ec75daf0f&X-Amz-SignedHeaders=host&response-content-disposition=attachment%3B%20filename%3D%22Microsoft%20Corporation-2025-03-10T08-19-11.pdf%22&x-id=GetObject"
    }
  }
}
{
  "data": {
    "exportOrganization": {
      "url": "https://alt-bucket-reports-service-ppe-v1.s3.us-east-2.amazonaws.com//reports/Microsoft%20Corporation-2025-03-10T08-19-11.pdf?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Content-Sha256=UNSIGNED-PAYLOAD&X-Amz-Credential=ASIAT2IPICHXAZ27MZU2%2F20250310%2Fus-east-2%2Fs3%2Faws4_request&X-Amz-Date=20250310T081923Z&X-Amz-Expires=60&X-Amz-Security-Token=IQoJb3JpZ2luX2VjEEAaCXVzLWVhc3QtMiJHMEUCIQDEjP4gfF8BqsFZ6PoauYy%2B8ejyzyI1EvxTlAWp3XZ%2FwgIgZYCmo4hZs67aKV5qVpky2Edx%2Fbc3ErK9%2Bzpk3pN3Q4YqpAMIif%2F%2F%2F%2F%2F%2F%2F%2F%2F%2FARABGgwyNjI1NjE4NjIxMjYiDOnTjqYkPqZGZV%2FfRir4AuXC0VzYq0dJHH%2F9FSM405a1Rh0QIHsGcKU99rVNxHicrHhcoow1IJbuTeUbf%2BwQnPaXjKFQfkx%2BiWW%2BDkYKd%2BV3eBH9Zmxstt7eipAD2e6%2BLxM99tckgrIlFT1wA7CbcORjZwRiejsmLl%2Fu%2BcAaWqIgP3v0sVarxYDdO7DLY%2FzPt5MoaYgNd6W9aZ%2Fw2mNR593ZdAbpnY2L%2Bjm7WJ%2BsvmoMwIeEIDY1nIRDGVfM3tc3jEfPnZ1CfEJ4Po4nwNymoodTTYTKZd7Mep5K%2B9PdPBXszbsaE4LIDnkv4LglFvuZ3jnUzaRhTYbgfn3MPfnT8IFdNKSka%2BvgH8vVXA8YJemQJkehaSyvTXTGrhqGl159ZXSJNb5BtMmXG%2BpgNq4s6o9p%2FkI27Bt%2FPIPYycGuMzegRnskG8nNTiVOTiPZ%2BtR6bJwYWHcWnHp30ngLRBmkSZWLs7tIIaci%2BBegsA9zo%2FGsW4eUMwSO554gw%2FBMVYkxgnmuPihly2cwjcC6vgY6nQFEO87qrqOQOzMWbPiDdVsu9OJpyxA9o06CH5WdIJgV2xQync%2FDrc2S9hJFcmEAMCttg0YAXfwhIjbeZR%2FpvgVWmYYc4sspnehwrsErR6F%2FSPeOnqssXarNvj0GiYxSVDU%2FhGY1oTbohztK4VXk5%2B21MARKMA518h7a7qQYA8rL88paKb6%2F7nkYSctYhvKNUx7zy0DozoyumS1DL9TB&X-Amz-Signature=3c35b9a86a26a47c83fbbe79f5cb99588a3edcf7dcf814ad6066726ec75daf0f&X-Amz-SignedHeaders=host&response-content-disposition=attachment%3B%20filename%3D%22Microsoft%20Corporation-2025-03-10T08-19-11.pdf%22&x-id=GetObject"
    }
  }
}
﻿
Note - Once we have received a response to our query, copy the URL into your browser and press enter; the pdf file will be downloaded immediately.
Profile API
Matching API