### RevenueRange Object Example Source: https://developer.leadiq.com/index An example of the 'RevenueRange' object, which includes start and end values for revenue, along with a description. ```json { "start": 1, "end": 1, "description": "xyz789" } ``` -------------------------------- ### Example String Value Source: https://developer.leadiq.com/index An example of a string literal value, representing a simple text string. ```json "abc123" ``` -------------------------------- ### Plan Object Example Source: https://developer.leadiq.com/index An example of the 'Plan' object, which includes details about a subscription plan such as its name, associated product, status, and next billing period. ```json { "name": "abc123", "product": "DataHub", "status": "Active", "nextBillingPeriod": "2021-10-02T00:00:00.000Z" } ``` -------------------------------- ### DataHubCost Structure Example Source: https://developer.leadiq.com/index Provides an example of the DataHubCost structure, which maps a specific SKU to a list of associated costs for data points. ```json {"sku": "AccountTracking", "costs": ["DataPointCost"]} ``` -------------------------------- ### DataPointCost Structure Example Source: https://developer.leadiq.com/index Shows an example of the DataPointCost structure, defining the cost associated with a specific data point. ```json {"dataPoint": "Company", "cost": 123} ``` -------------------------------- ### PlanStatus Enum Example Source: https://developer.leadiq.com/index This example illustrates a value from the 'PlanStatus' enum, representing the current state of a plan. ```json "Active" ``` -------------------------------- ### DateRange Structure Example Source: https://developer.leadiq.com/index Illustrates the DateRange structure, which defines a time interval with start and end dates. ```json { "start": "2021-10-02T00:00:00.000Z", "end": "2021-10-02T00:00:00.000Z" } ``` -------------------------------- ### DateRangeFilter Structure Example Source: https://developer.leadiq.com/index Provides an example of the DateRangeFilter structure, used for filtering based on a start and end timestamp. ```json {"start": 1, "end": 1} ``` -------------------------------- ### SearchCompanyInput Object Example Source: https://developer.leadiq.com/index An example of the 'SearchCompanyInput' object, used as input for searching companies, including fields like source, name, domain, and LinkedIn details. ```json { "source": "abc123", "name": "abc123", "domain": "xyz789", "linkedinId": "abc123", "linkedinUrl": "xyz789", "strict": false } ``` -------------------------------- ### DataHubVisibility Structure Example Source: https://developer.leadiq.com/index An example demonstrating the DataHubVisibility structure, which specifies the SKU and a list of data points that are visible for a given plan. ```json {"sku": "AccountTracking", "dataPoints": ["Company"]} ``` -------------------------------- ### ProductName Enum Example Source: https://developer.leadiq.com/index Example of a 'ProductName' enum value, used to identify different product categories. ```json "DataHub" ``` -------------------------------- ### SKU Enum Example Source: https://developer.leadiq.com/index Example of an 'SKU' enum value, representing a specific product category. ```json "AccountTracking" ``` -------------------------------- ### FundingInfo Object Example with Funding Details Source: https://developer.leadiq.com/index Shows an example of the FundingInfo object, which contains details about a company's funding. It includes the number of funding rounds, total USD funded, date and type of the last funding, and the amount of the last funding in USD. ```graphql { "fundingRounds": "2", "fundingTotalUsd": 40000000, "lastFundingOn": "2021-10-02T00:00:00.000Z", "lastFundingType": "Series B", "lastFundingUsd": 30000000 } ``` -------------------------------- ### ZonedDateTime Example Source: https://developer.leadiq.com/index This example shows the string format for a ZonedDateTime value. It represents a specific point in time with timezone information. ```json "2021-10-02T00:00:00.000Z" ``` -------------------------------- ### Example Visibility Data Structure Source: https://developer.leadiq.com/index This example shows the expected JSON structure for associating a subproduct SKU with visible data points. It's used to define which data points are accessible for a given SKU. ```json { "sku": "AccountTracking", "dataPoints": ["Company"] } ``` -------------------------------- ### Example UniversalPlan Payload Source: https://developer.leadiq.com/index An example JSON object representing a `UniversalPlan`. It details plan attributes like name, product, status, billing cycle, credit usage, and associated costs and visibility. ```json { "name": "abc123", "product": "DataHub", "status": "Active", "nextBillingPeriod": "2021-10-02T00:00:00.000Z", "available": 987, "used": 123, "visibility": [UniversalVisibility], "costs": [UniversalCost] } ``` -------------------------------- ### QualityFilter Object Example Source: https://developer.leadiq.com/index An example of the 'QualityFilter' object, used to specify filtering criteria for phone quality. ```json {"phone": "HigherQualityPhones"} ``` -------------------------------- ### Account Type Example Source: https://developer.leadiq.com/index This JSON object represents an example of the `Account` type, detailing its fields related to subscribed plans and specific plan types like DataHub and Universal. ```json { "plans": [Plan], "dataHubPlan": DataHubPlan, "universalPlan": UniversalPlan } ``` -------------------------------- ### Example Seniority Value Source: https://developer.leadiq.com/index An example of a single enum value for the `Seniority` type, representing a 'VP' level. ```json "VP" ``` -------------------------------- ### EducationRecord Structure Example Source: https://developer.leadiq.com/index An example of the EducationRecord structure, detailing educational background information including institution name, degrees, majors, and date ranges. ```json { "name": "xyz789", "type": "xyz789", "linkedinUrl": "abc123", "facebookUrl": "abc123", "twitterUrl": "xyz789", "linkedinId": "abc123", "website": "xyz789", "domain": "abc123", "degrees": ["abc123"], "majors": ["xyz789"], "grades": "abc123", "dateRange": "DateRange", "activities": "xyz789", "description": "abc123" } ``` -------------------------------- ### DataHubPlan Structure Example Source: https://developer.leadiq.com/index Illustrates the structure of a DataHubPlan, detailing its name, product, status, billing period, available and used credits, visibility settings, and associated costs. ```json { "name": "abc123", "product": "DataHub", "status": "Active", "nextBillingPeriod": "2021-10-02T00:00:00.000Z", "available": 123, "used": 123, "visibility": ["DataHubVisibility"], "costs": ["DataHubCost"] } ``` -------------------------------- ### FlatSearchInput Example with Filters and Sorting Source: https://developer.leadiq.com/index Provides an example of the FlatSearchInput object, used for flat search queries. It includes fields for filtering companies and contacts, pagination (skip, limit), and sorting contacts. Dependencies include CompanyFilter, ContactFilter, and ContactSortingOption. ```graphql { "companyFilter": CompanyFilter, "companyExcludedFilter": CompanyFilter, "contactFilter": ContactFilter, "contactExcludedFilter": ContactFilter, "skip": 123, "limit": 987, "sortContactsBy": ["RoleAsc"] } ``` -------------------------------- ### SICCode Object Example Source: https://developer.leadiq.com/index Example of an 'SICCode' object, containing a Standard Industrial Classification code and its description. ```json { "code": "abc123", "description": "abc123" } ``` -------------------------------- ### Example UniversalCost Payload Source: https://developer.leadiq.com/index An example JSON object illustrating the `UniversalCost` type. It specifies a 'sku' and provides a list of `DataPointCost` objects. ```json {"sku": "AccountTracking", "costs": [DataPointCost]} ``` -------------------------------- ### Work Phone Record Example Source: https://developer.leadiq.com/index This example illustrates a WorkPhoneRecordType object, detailing the phone type, verification status, update timestamp, and phone number. It also includes a verificationStatus field. ```json { "type": "WorkPhone", "status": "Verified", "verificationStatus": "LikelyAccurate", "updatedAt": "2021-10-02T00:00:00.000Z", "value": "xyz789" } ``` -------------------------------- ### SICCodeFilter Object Example Source: https://developer.leadiq.com/index An example of the 'SICCodeFilter' object, used for filtering based on SIC code and its description. ```json { "code": "abc123", "description": "xyz789" } ``` -------------------------------- ### ContactSortingOption Enum Example Source: https://developer.leadiq.com/index Shows an example of how to specify sorting preferences for contact information, including options for ascending or descending order by role, name, seniority, or ID. ```json "RoleAsc" ``` -------------------------------- ### Work Email Record Example Source: https://developer.leadiq.com/index This example demonstrates the structure of a WorkEmailRecordType object. It includes the email type, verification status, last updated timestamp, and the email address value. ```json { "type": "WorkEmail", "status": "Verified", "updatedAt": "2021-10-02T00:00:00.000Z", "value": "abc123" } ``` -------------------------------- ### Example TechnologyInfo Payload Source: https://developer.leadiq.com/index An example JSON object representing technology information. It details the technology's name, its classification into categories and attributes, and parent categories. ```json { "name": "Amazon Web Services (AWS)", "category": "Infrastructure as a Service (IaaS)", "parentCategory": "Cloud Services", "attributes": ["Software as a Service (SaaS)"], "categories": ["xyz789"] } ``` -------------------------------- ### Example Usage of EmailBounceCode Source: https://developer.leadiq.com/index Provides a simple example of how an email bounce code might be represented as a string literal. This demonstrates the format for referencing specific bounce codes. ```json "EmailBounceCode513" ``` -------------------------------- ### Example SocialNetworkType Value Source: https://developer.leadiq.com/index An example of a single enum value for the `SocialNetworkType` type, representing 'Twitter'. ```json "Twitter" ``` -------------------------------- ### Configurable Data Point Enum Example Source: https://developer.leadiq.com/index This example demonstrates a possible value for a configurable data point, specifying the type of data to be retrieved. Options include Company, Person, PersonEmail, and PersonPhone, with specific conditions for Person data availability. ```json "Company" ``` -------------------------------- ### Company Sorting Option Example Source: https://developer.leadiq.com/index This example shows a string value representing an option for sorting company search results. The available options include sorting by ID, size, name, and industry in ascending or descending order. ```json "IdDesc" ``` -------------------------------- ### WorkPhone Enum Example Source: https://developer.leadiq.com/index This snippet shows an example of the 'WorkPhone' enum value, used to categorize phone number types. ```json "WorkPhone" ``` -------------------------------- ### Workato Token Response Success Example Source: https://developer.leadiq.com/index This example depicts a successful Workato token response. It contains the authentication token, customer account ID, and API key required for subsequent operations. ```json { "token": "abc123", "customerAccountId": "abc123", "apiKey": "abc123" } ``` -------------------------------- ### GroupedSearchInput Example for Advanced Grouped Search Source: https://developer.leadiq.com/index Provides an example of the GroupedSearchInput object, designed for advanced search queries that return grouped results. It includes comprehensive filtering for companies and contacts, pagination, per-company limits, and sorting options for both companies and contacts. ```graphql { "companyFilter": CompanyFilter, "companyExcludedFilter": CompanyFilter, "contactFilter": ContactFilter, "contactExcludedFilter": ContactFilter, "skip": 123, "limit": 123, "limitPerCompany": 987, "sortCompaniesBy": ["IdDesc"], "sortContactsBy": ["RoleAsc"] } ``` -------------------------------- ### PositionRecord Object Example Source: https://developer.leadiq.com/index Example of a 'PositionRecord' object, detailing a person's employment history, including company ID, title, date range, contact information, and other relevant details. ```json { "companyId": "xyz789", "title": "abc123", "dateRange": DateRange, "updatedAt": "2021-10-02T00:00:00.000Z", "emails": [WorkEmailRecordType], "phones": [WorkPhoneRecordType], "companyInfo": CompanyInfo, "seniority": "xyz789", "function": "xyz789", "matchedQuery": true } ``` -------------------------------- ### Verification Status Enum Example Source: https://developer.leadiq.com/index This example shows a value from the VerificationStatusType enumeration, representing the confidence level of a verified status. Possible values include LikelyAccurate and None. ```json "LikelyAccurate" ``` -------------------------------- ### Company Type Example Source: https://developer.leadiq.com/index An example JSON representation of the `Company` type, showcasing its various fields including identification, industry, location, employee count, and other related information. ```json { "id": "abc123", "name": "abc123", "industry": "abc123", "description": "abc123", "linkedinId": "xyz789", "domain": "xyz789", "employeeCount": 987, "city": "abc123", "country": "xyz789", "countryCode2": "xyz789", "countryCode3": "abc123", "state": "xyz789", "postalCode": "xyz789", "score": 123.45, "companyTechnologies": ["xyz789"], "companyTechnologyCategories": ["xyz789"], "revenueRange": RevenueRange, "fundingInfo": FundingInfo, "naicsCode": NAICSCode, "sicCode": SICCode } ``` -------------------------------- ### Workato Token Response Failure Example Source: https://developer.leadiq.com/index This example shows the JSON structure for a failed Workato token response. It typically includes an error message indicating the reason for failure. ```json { "message": "xyz789" } ``` -------------------------------- ### ProfileFilterType Enum Example Source: https://developer.leadiq.com/index This snippet shows an example of the 'ProfileFilterType' enum, used for filtering profiles based on contact information. ```json "HasVerifiedWorkPhone" ``` -------------------------------- ### AdvancedSearchEmailVerificationStatusType Enum Example Source: https://developer.leadiq.com/index This example shows the possible string values for the `AdvancedSearchEmailVerificationStatusType` enum, representing different email verification statuses. ```string "Verified" ``` -------------------------------- ### Example SearchResult Payload Source: https://developer.leadiq.com/index An example JSON object representing a search result from the LeadIQ platform. It demonstrates the fields `totalResults`, `hasMore`, and `results`, which contains a placeholder for `PersonRecord`. ```json { "totalResults": 123, "hasMore": false, "results": [PersonRecord] } ``` -------------------------------- ### Example LeadIQ Search Query Payload Source: https://developer.leadiq.com/index An example JSON payload demonstrating how to structure a search query for the LeadIQ platform. It showcases the usage of various fields including pagination, personal information, company details, and filtering options. ```json { "skip": 123, "limit": 123, "id": "xyz789", "firstName": "xyz789", "lastName": "xyz789", "middleName": "xyz789", "fullName": "xyz789", "company": CompanyDetails, "linkedinId": "xyz789", "linkedinUrl": "xyz789", "email": "abc123", "hashedEmail": "xyz789", "phone": "abc123", "workEmailStatusIn": ["Verified"], "containsWorkContactInfo": true, "profileFilter": ["HasVerifiedWorkPhone"], "includeInvalid": true, "qualityFilter": QualityFilter, "minConfidence": 987 } ``` -------------------------------- ### Types: ZonedDateTime Source: https://developer.leadiq.com/index Provides an example of the ZonedDateTime format. ```APIDOC ## Type: ZonedDateTime ### Description Represents a zoned date and time. ### Example ```json "2021-10-02T00:00:00.000Z" ``` ``` -------------------------------- ### Example SocialProfile Payload Source: https://developer.leadiq.com/index An example JSON object representing a social profile. It includes fields for the social network, user identifiers, URL, status, and the last update time. ```json { "network": "Twitter", "id": "xyz789", "username": "abc123", "url": "abc123", "status": "Valid", "updatedAt": "2021-10-02T00:00:00.000Z" } ``` -------------------------------- ### Company Information Structure Example Source: https://developer.leadiq.com/index This comprehensive JSON object outlines the detailed information available for a company. It includes identifiers, names, contact details, location, industry, financial information, technologies, and hierarchical relationships. Note that some fields like 'country' suggest using 'locationInfo' as a preferred alternative. ```json { "source": "abc123", "name": "abc123", "alternativeNames": ["abc123"], "domain": "abc123", "description": "abc123", "emailDomains": ["xyz789"], "type": "xyz789", "phones": ["abc123"], "country": "abc123", "address": "xyz789", "locationInfo": LocationInfo, "logoUrl": "abc123", "linkedinId": "xyz789", "linkedinUrl": "abc123", "numberOfEmployees": 123, "industry": "abc123", "specialities": ["xyz789"], "fundingInfo": FundingInfo, "technologies": [TechnologyInfo], "revenueRange": RevenueRange, "sicCode": SICCode, "secondarySicCodes": [SICCode], "naicsCode": NAICSCode, "employeeRange": "xyz789", "crunchbaseUrl": "xyz789", "facebookUrl": "abc123", "twitterUrl": "xyz789", "foundedYear": 123, "companyHierarchy": CompanyHierarchy, "updatedDate": "2021-10-02T00:00:00.000Z", "isExcluded": false } ``` -------------------------------- ### ContactInfoType Enum Example Source: https://developer.leadiq.com/index Demonstrates the various types of contact information that can be specified, such as personal or work-related emails and phone numbers. ```json "PersonalMobile" ``` -------------------------------- ### EmailType Enum Example Source: https://developer.leadiq.com/index Demonstrates the EmailType enumeration, specifying whether an email is for work or personal use. ```json "WorkEmail" ``` -------------------------------- ### Project: /websites/developer_leadiq Source: https://developer.leadiq.com/index Details regarding the fields and examples for the developer_leadiq project. ```APIDOC ## Project: /websites/developer_leadiq ### Description This section details the fields available for the developer_leadiq project and provides an example of its usage. ### Fields - **sku** (SKU!) - The subproduct that this visibility is associated with. - **dataPoints** ([UnlockableDataPoint!]!) - A list of dataPoints that are visible. ### Request Example ```json { "sku": "AccountTracking", "dataPoints": ["Company"] } ``` ``` -------------------------------- ### CompanyDetails Input Example Source: https://developer.leadiq.com/index This JSON object demonstrates the structure for the `CompanyDetails` input type, used for searching or filtering company information. It includes fields like company ID, name, domain, and search parameters. ```json { "companyId": "abc123", "name": "xyz789", "domain": "xyz789", "emailDomain": "xyz789", "linkedinId": "xyz789", "country": "abc123", "searchInPastCompanies": true, "strict": true } ``` -------------------------------- ### FundingInfoFilter Example for Funding Criteria Source: https://developer.leadiq.com/index Demonstrates the FundingInfoFilter input object, used to filter funding information. It allows filtering based on a date range for the last funding and a numerical range for the last funding amount. Dependencies include DateRangeFilter and RangeFilter. ```graphql { "lastFundingDateRange": DateRangeFilter, "lastFundingRange": RangeFilter } ``` -------------------------------- ### ContactInfoStatus Enum Example Source: https://developer.leadiq.com/index Illustrates the usage of the ContactInfoStatus enumeration, which defines possible states for contact information. ```json "Correct" ``` -------------------------------- ### Company Search Filter Example Source: https://developer.leadiq.com/index This JSON object demonstrates how to structure a filter for searching companies. It includes various fields like IDs, names, domains, and advanced filtering options for industries, sizes, locations, and financial information. Some fields accept predefined filter types like CompanySizeFilter. ```json { "ids": ["xyz789"], "names": ["xyz789"], "domains": ["abc123"], "linkedinIds": ["xyz789"], "industries": ["xyz789"], "sizes": [CompanySizeFilter], "locations": [LocationFilterInput], "descriptions": ["abc123"], "technologies": ["abc123"], "technologyCategories": ["abc123"], "revenueRanges": [RangeFilter], "fundingInfoFilters": [FundingInfoFilter], "naicsCodeFilters": [NAICSCodeFilter], "sicCodeFilters": [SICCodeFilter] } ``` -------------------------------- ### Company Size Filter Example Source: https://developer.leadiq.com/index This JSON object defines a filter for company size, allowing specification of a minimum and maximum number of employees. ```json {"min": 123, "max": 123} ``` -------------------------------- ### Company Search Response Example Source: https://developer.leadiq.com/index This JSON object represents the response structure for a company search query. It contains the total number of companies found and a list of companies with associated people information. ```json {"totalCompanies": 1, "companies": [CompanyWithPeople]} ``` -------------------------------- ### Company Search Result Example Source: https://developer.leadiq.com/index This JSON structure details the results of a company search. It includes the total number of results, a boolean indicating if more results are available, and an array of company information objects. ```json { "totalResults": 123, "hasMore": true, "results": [CompanyInfo] } ``` -------------------------------- ### Submit Person Feedback Mutation Example Source: https://developer.leadiq.com/index This GraphQL mutation allows submitting feedback for a person contact. It requires an `ApiPersonFeedback` input object and returns an `ID!` upon successful submission. ```graphql mutation SubmitPersonFeedback($input: ApiPersonFeedback!) { submitPersonFeedback(input: $input) } ``` ```json { "input": { "personId": "xyz789", "linkedinUrl": "xyz789", "linkedinId": "xyz789", "name": "abc123", "companyId": "xyz789", "companyName": "abc123", "companyDomain": "abc123", "title": "abc123", "value": "abc123", "status": "Correct", "invalidReason": "EmailBounceCode513", "type": "PersonalMobile", "lastSeen": "2021-10-02T00:00:00.000Z" } } ``` ```json { "data": { "submitPersonFeedback": 4 } } ``` -------------------------------- ### Company With People Structure Example Source: https://developer.leadiq.com/index This JSON object combines company information with a list of associated people. It also includes the total count of contacts within that company. ```json { "company": Company, "people": [Person], "totalContactsInCompany": 1 } ``` -------------------------------- ### Company Hierarchy Node Example Source: https://developer.leadiq.com/index This JSON object represents a node within a company's hierarchy. It typically contains the unique identifier (id) and the name of the company node. ```json { "id": "xyz789", "name": "xyz789" } ``` -------------------------------- ### EmailVerificationStatusTypeInput Enum Example Source: https://developer.leadiq.com/index Demonstrates the possible string values for the EmailVerificationStatusTypeInput enum, used to indicate the verification status of an email address. These values include Verified, Unverified, VerifiedLikely, and Invalid. ```graphql "Verified" "Unverified" "VerifiedLikely" "Invalid" ``` -------------------------------- ### GenericFieldStatus Enum Example Source: https://developer.leadiq.com/index Presents the GenericFieldStatus enum, used to denote a generic status for a field. The possible values are Valid and Invalid. ```graphql "Valid" "Invalid" ``` -------------------------------- ### Int Scalar Type Example Source: https://developer.leadiq.com/index Illustrates the Int scalar type, representing signed whole numbers within the range of -(2^31) to 2^31 - 1. This is a standard integer type for whole number values. ```graphql 123 ``` -------------------------------- ### Float Scalar Type Example Source: https://developer.leadiq.com/index Illustrates the Float scalar type, representing signed double-precision fractional numbers according to IEEE 754. This is a standard numerical type for representing decimal values. ```graphql 123.45 ``` -------------------------------- ### Company Hierarchy Structure Example Source: https://developer.leadiq.com/index This JSON structure represents the hierarchical relationship of a company. It includes a boolean indicating if it's the ultimate parent, and references to its direct parent and ultimate parent companies. The nested CompanyHierarchyNode type provides basic ID and name information. ```json { "isUltimate": true, "parent": CompanyHierarchyNode, "ultimateParent": CompanyHierarchyNode } ``` -------------------------------- ### ID Scalar Type Example Source: https://developer.leadiq.com/index Demonstrates the ID scalar type, which represents a unique identifier. While it appears as a String in JSON responses, it's intended for internal use like cache keys or refetching objects. Input can be either a String or an Int. ```graphql 4 ``` -------------------------------- ### GraphQL Type Definition for UniversalPlan Source: https://developer.leadiq.com/index Defines a universal plan, including its name, product, status, billing information, available and used credits, visibility settings, and associated costs. ```graphql type UniversalPlan { name: String! product: ProductName! status: PlanStatus! nextBillingPeriod: ZonedDateTime available: Int! used: Int! visibility: [UniversalVisibility!] costs: [UniversalCost!] } ``` -------------------------------- ### DateRange Input Source: https://developer.leadiq.com/index Represents a period defined by a start and end date/time. ```APIDOC ## DateRange Input ### Description This input type defines a date range with a start and end. ### Fields - **start** (ZonedDateTime) - The start date and time. - **end** (ZonedDateTime) - The end date and time. ### Example ```json { "start": "2021-10-02T00:00:00.000Z", "end": "2021-10-02T00:00:00.000Z" } ``` ``` -------------------------------- ### Query: Account Details in LeadIQ API Source: https://developer.leadiq.com/index Fetches the current user's account details, including plan information such as name, product, status, and billing periods for Data Hub and Universal plans. It also provides visibility and cost details for data points. ```GraphQL query Account { account { plans { name product status nextBillingPeriod } dataHubPlan { name product status nextBillingPeriod available used visibility { sku dataPoints } costs { sku costs { dataPoint cost } } } universalPlan { name product status nextBillingPeriod available used visibility { sku dataPoints } costs { sku costs { dataPoint cost } } } } } ``` -------------------------------- ### DataHubPlan Input Source: https://developer.leadiq.com/index Details of a DataHub plan, including availability, usage, and costs. ```APIDOC ## DataHubPlan Input ### Description This input type represents a DataHub plan, outlining its features and usage metrics. ### Fields - **name** (String!) - The human-readable name of the plan (e.g., Enterprise Annual). - **product** (ProductName!) - The product associated with the plan. - **status** (PlanStatus!) - The current status of the plan. - **nextBillingPeriod** (ZonedDateTime) - The date and time of the next billing period. - **available** (Int!) - The number of credits available for use. - **used** (Int!) - The number of credits used in the current billing period. - **visibility** (DataHubVisibility!) - The visibility settings for data points within the plan. - **costs** (DataHubCost!) - The costs associated with data points for this plan. ### Example ```json { "name": "abc123", "product": "DataHub", "status": "Active", "nextBillingPeriod": "2021-10-02T00:00:00.000Z", "available": 123, "used": 123, "visibility": [DataHubVisibility], "costs": [DataHubCost] } ``` ``` -------------------------------- ### GenericFieldType Enum Example Source: https://developer.leadiq.com/index Illustrates the GenericFieldType enum, representing a generic type for a field. The only defined value is NotApplicable. ```graphql "NotApplicable" ``` -------------------------------- ### Account API Source: https://developer.leadiq.com/index Retrieves details about the current user's account, including plan information and usage statistics. ```APIDOC ## GET /graphql ### Description The `account` query returns the current user's account details, including information about their plans, data hub plan, and universal plan. ### Method GET ### Endpoint https://api.leadiq.com/graphql ### Parameters #### Query Parameters None #### Request Body None ### Request Example ```graphql query Account { account { plans { name product status nextBillingPeriod } dataHubPlan { name product status nextBillingPeriod available used visibility { sku dataPoints } costs { sku costs { dataPoint cost } } } universalPlan { name product status nextBillingPeriod available used visibility { sku dataPoints } costs { sku costs { dataPoint cost } } } } } ``` ### Response #### Success Response (200) - **data** (object) - Contains the account details. - **account** (object) - Details of the user's account. - **plans** (array) - List of user's plans. - **dataHubPlan** (object) - Details of the Data Hub plan. - **universalPlan** (object) - Details of the Universal plan. #### Response Example ```json { "data": { "account": { "plans": [Plan], "dataHubPlan": DataHubPlan, "universalPlan": UniversalPlan } } } ``` ``` -------------------------------- ### GraphQL Type Definition for TechnologyInfo Source: https://developer.leadiq.com/index Defines the structure for technology information, including its name, category, parent category, and associated attributes and categories. ```graphql type TechnologyInfo { name: String! category: String parentCategory: String attributes: [String!]! categories: [String!] } ``` -------------------------------- ### Types: WorkPhoneRecordType Source: https://developer.leadiq.com/index Details the structure of a WorkPhoneRecordType. ```APIDOC ## Type: WorkPhoneRecordType ### Description Represents a work phone record. ### Fields - **type** (PhoneType!) - - **status** (PhoneVerificationStatusType!) - - **verificationStatus** (VerificationStatusType!) - - **updatedAt** (ZonedDateTime!) - - **value** (String!) - ### Example ```json { "type": "WorkPhone", "status": "Verified", "verificationStatus": "LikelyAccurate", "updatedAt": "2021-10-02T00:00:00.000Z", "value": "xyz789" } ``` ``` -------------------------------- ### Account Type Source: https://developer.leadiq.com/index Represents an account and its associated plans. ```APIDOC ## Account ### Description Represents an account and its associated plans. ### Fields - **plans** (Array of Plan!) - Required - Returns the set of subscribed plans, this will include all plans, including trial plans. - **dataHubPlan** (DataHubPlan) - Returns the datahub plan if it is present. - **universalPlan** (UniversalPlan) - Returns the universal plan if it is present. ### Example ```json { "plans": [Plan], "dataHubPlan": DataHubPlan, "universalPlan": UniversalPlan } ``` ``` -------------------------------- ### Types: WorkEmailRecordType Source: https://developer.leadiq.com/index Details the structure of a WorkEmailRecordType. ```APIDOC ## Type: WorkEmailRecordType ### Description Represents a work email record. ### Fields - **type** (EmailType!) - - **status** (EmailVerificationStatusType!) - - **updatedAt** (ZonedDateTime!) - - **value** (String!) - ### Example ```json { "type": "WorkEmail", "status": "Verified", "updatedAt": "2021-10-02T00:00:00.000Z", "value": "abc123" } ``` ``` -------------------------------- ### GraphQL Type Definition for String Source: https://developer.leadiq.com/index Represents textual data as UTF-8 character sequences. This is a standard scalar type used for free-form human-readable text in GraphQL. ```graphql scalar String ``` -------------------------------- ### GraphQL Query for Searching People Source: https://developer.leadiq.com/index This GraphQL query facilitates searching for individuals based on provided input. It returns details such as total results, whether more results are available, and a list of matching individuals with their associated information including names, positions, company details, and social profiles. Dependencies include the SearchPeopleInput type. ```graphql query SearchPeople($input: SearchPeopleInput!) { searchPeople(input: $input) { totalResults hasMore results { _id name { first fullName last middle } currentPositions { companyId title dateRange { start end } updatedAt emails { type status updatedAt value } phones { type status verificationStatus updatedAt value } companyInfo { source name alternativeNames domain description emailDomains type phones country address locationInfo { ...LocationInfoFragment } logoUrl linkedinId linkedinUrl numberOfEmployees industry specialities fundingInfo { ...FundingInfoFragment } technologies { ...TechnologyInfoFragment } revenueRange { ...RevenueRangeFragment } sicCode { ...SICCodeFragment } secondarySicCodes { ...SICCodeFragment } naicsCode { ...NAICSCodeFragment } employeeRange crunchbaseUrl facebookUrl twitterUrl foundedYear companyHierarchy { ...CompanyHierarchyFragment } updatedDate isExcluded } seniority function matchedQuery } pastPositions { companyId title dateRange { start end } updatedAt emails { type status updatedAt value } phones { type status verificationStatus updatedAt value } companyInfo { source name alternativeNames domain description emailDomains type phones country address locationInfo { ...LocationInfoFragment } logoUrl linkedinId linkedinUrl numberOfEmployees industry specialities fundingInfo { ...FundingInfoFragment } technologies { ...TechnologyInfoFragment } revenueRange { ...RevenueRangeFragment } sicCode { ...SICCodeFragment } secondarySicCodes { ...SICCodeFragment } naicsCode { ...NAICSCodeFragment } employeeRange crunchbaseUrl facebookUrl twitterUrl foundedYear companyHierarchy { ...CompanyHierarchyFragment } updatedDate isExcluded } seniority function matchedQuery } linkedin { linkedinId linkedinUrl salesUrls type status updatedAt guid } profiles { network id username url status updatedAt } location { fullAddress areaLevel1 city country countryCode2 countryCode3 type status updatedAt } education { name type linkedinUrl facebookUrl twitterUrl linkedinId website domain degrees majors grades dateRange { start end } activities description } updatedAt personalEmails { type status updatedAt value } personalPhones { type status verificationStatus updatedAt value } confidence } } } ``` -------------------------------- ### GraphQL Query for Workato Token Source: https://developer.leadiq.com/index This GraphQL query retrieves a token for accessing Workato. It accepts the `orgDomainUrl` as a required string argument. The response can either be a `WorkatoTokenResponseFailure` containing an error `message` or a `WorkatoTokenResponseSuccess` with a `token`, `customerAccountId`, and `apiKey`. ```graphql query WorkatoToken($orgDomainUrl: String!) { workatoToken(orgDomainUrl: $orgDomainUrl) { ... on WorkatoTokenResponseFailure { message } ... on WorkatoTokenResponseSuccess { token customerAccountId apiKey } } } ``` -------------------------------- ### EducationRecord Input Source: https://developer.leadiq.com/index Represents educational background information. ```APIDOC ## EducationRecord Input ### Description This input type captures details about an individual's education. ### Fields - **name** (String!) - The name of the institution. - **type** (String) - The type of education (e.g., University, College). - **linkedinUrl** (String) - URL to the LinkedIn profile for this education. - **facebookUrl** (String) - URL to the Facebook profile for this education. - **twitterUrl** (String) - URL to the Twitter profile for this education. - **linkedinId** (String) - LinkedIn ID for this education record. - **website** (String) - Website of the institution. - **domain** (String) - Domain of the institution's website. - **degrees** (String!) - A list of degrees obtained. - **majors** (String!) - A list of majors studied. - **grades** (String) - Grade information. - **dateRange** (DateRange) - The period during which the education took place. - **activities** (String) - Extracurricular activities. - **description** (String) - A description of the education record. ### Example ```json { "name": "xyz789", "type": "xyz789", "linkedinUrl": "abc123", "facebookUrl": "abc123", "twitterUrl": "xyz789", "linkedinId": "abc123", "website": "xyz789", "domain": "abc123", "degrees": ["abc123"], "majors": ["xyz789"], "grades": "abc123", "dateRange": {"start": "2021-10-02T00:00:00.000Z", "end": "2021-10-02T00:00:00.000Z"}, "activities": "xyz789", "description": "abc123" } ``` ``` -------------------------------- ### GraphQL Query for Company Search Source: https://developer.leadiq.com/index This GraphQL query enables searching for companies using identifying information such as name and domain. It returns a `CompanySearchResult` object containing details like total results, more data availability, and a list of matching companies. The query requires a `SearchCompanyInput` object. ```graphql query SearchCompany($input: SearchCompanyInput!) { searchCompany(input: $input) { totalResults hasMore results { source name alternativeNames domain description emailDomains type phones country address locationInfo { formattedAddress street1 street2 city areaLevel1 country countryCode2 countryCode3 postalCode } logoUrl linkedinId linkedinUrl numberOfEmployees industry specialities fundingInfo { fundingRounds fundingTotalUsd lastFundingOn lastFundingType lastFundingUsd } technologies { name category parentCategory attributes categories } revenueRange { start end description } sicCode { code description } secondarySicCodes { code description } naicsCode { code description } employeeRange crunchbaseUrl facebookUrl twitterUrl foundedYear companyHierarchy { isUltimate parent { id name } ultimateParent { id name } } updatedDate isExcluded } } } ``` -------------------------------- ### GraphQL Endpoint for LeadIQ API Source: https://developer.leadiq.com/index The GraphQL endpoint for interacting with the LeadIQ Public API. This is the base URL for all API requests. ```GraphQL https://api.leadiq.com/graphql ``` -------------------------------- ### Types: WorkatoTokenResponseSuccess Source: https://developer.leadiq.com/index Details the structure of a WorkatoTokenResponseSuccess. ```APIDOC ## Type: WorkatoTokenResponseSuccess ### Description Represents a successful Workato token response. ### Fields - **token** (String!) - The authentication token. - **customerAccountId** (String) - The customer account ID. - **apiKey** (String) - The API key. ### Example ```json { "token": "abc123", "customerAccountId": "abc123", "apiKey": "abc123" } ``` ``` -------------------------------- ### GraphQL Input Fields for LeadIQ Search Source: https://developer.leadiq.com/index Defines the input fields for searching within the LeadIQ platform. Includes parameters for pagination, identification, personal and company details, and various filtering options. Hashed email is supported for privacy-preserving searches. ```graphql input LeadIQSearchInput { skip: Int limit: Int id: String firstName: String lastName: String middleName: String fullName: String company: CompanyDetails linkedinId: String linkedinUrl: String email: String hashedEmail: String # Search by SHA256 hashed email phone: String workEmailStatusIn: [EmailVerificationStatusTypeInput!] containsWorkContactInfo: Boolean profileFilter: [ProfileFilterType!] includeInvalid: Boolean qualityFilter: QualityFilter minConfidence: Int } ``` -------------------------------- ### DataHubCost Input Source: https://developer.leadiq.com/index Represents the cost associated with a specific data point within a plan. ```APIDOC ## DataHubCost Input ### Description This input type defines the cost for a specific data point within a DataHub plan. ### Fields - **sku** (SKU!) - The subproduct identifier. - **costs** (DataPointCost!) - A list of data point to cost mappings. ### Example ```json { "sku": "AccountTracking", "costs": [DataPointCost] } ``` ``` -------------------------------- ### GraphQL Query Variables for Searching People Source: https://developer.leadiq.com/index These are the variables required for the `SearchPeople` GraphQL query. The primary variable is `input`, which is of type `SearchPeopleInput`, defining the parameters for the search operation. This object structures the search criteria. ```json { "input": "SearchPeopleInput" } ``` -------------------------------- ### GraphQL Query Variables for Workato Token Source: https://developer.leadiq.com/index These are the variables required for the `WorkatoToken` GraphQL query. The `orgDomainUrl` variable, a string, specifies the organization's domain URL for which the token is requested. ```json { "orgDomainUrl": "abc123" } ``` -------------------------------- ### POST /submitPersonFeedback Source: https://developer.leadiq.com/index Submits feedback about a person contact. This mutation allows users to provide feedback on individual contacts, which can be used to improve data accuracy and user experience. ```APIDOC ## POST /submitPersonFeedback ### Description Submit feedback about a person contact. ### Method POST ### Endpoint /submitPersonFeedback ### Parameters #### Request Body - **input** (ApiPersonFeedback!) - Required - An object containing the feedback details for the person. ### Request Example ```json { "query": "mutation SubmitPersonFeedback($input: ApiPersonFeedback!) { submitPersonFeedback(input: $input) }", "variables": { "input": { "personId": "xyz789", "linkedinUrl": "xyz789", "linkedinId": "xyz789", "name": "abc123", "companyId": "xyz789", "companyName": "abc123", "companyDomain": "abc123", "title": "abc123", "value": "abc123", "status": "Correct", "invalidReason": "EmailBounceCode513", "type": "PersonalMobile", "lastSeen": "2021-10-02T00:00:00.000Z" } } } ``` ### Response #### Success Response (200) - **submitPersonFeedback** (ID!) - The ID of the submitted feedback. #### Response Example ```json { "data": { "submitPersonFeedback": 4 } } ``` ``` -------------------------------- ### Types: WorkatoTokenResponseFailure Source: https://developer.leadiq.com/index Details the structure of a WorkatoTokenResponseFailure. ```APIDOC ## Type: WorkatoTokenResponseFailure ### Description Represents a failed Workato token response. ### Fields - **message** (String!) - The error message. ### Example ```json { "message": "xyz789" } ``` ``` -------------------------------- ### Email Bounce Codes Source: https://developer.leadiq.com/index This section details the various email bounce codes that can be encountered, along with their corresponding descriptions. ```APIDOC ## Email Bounce Codes This endpoint provides a list of possible email bounce codes and their meanings. ### Description Provides a comprehensive list of email bounce codes with descriptions. ### Method GET ### Endpoint /websites/developer_leadiq/values ### Parameters #### Query Parameters - **value** (String) - Optional - Filters for a specific bounce code. ### Response #### Success Response (200) - **values** (Array) - A list of email bounce codes. #### Response Example ```json { "values": [ "EmailBounceCode513", "EmailBounceCode554", "EmailBounceCode500" ] } ``` ```