Welcome to the TruVoice API

Welcome to the TruVoice GraphQL API reference. This reference includes a set of GraphQL types, queries, and their parameters for accessing data within TruVoice.

API Endpoints
https://api.primary-intel.com/v2

The Basics

The TruVoice GraphQL API allows developers to programmatically access data inside a TruVoice account.

If you want to get started right away, check out these frequently-used links:

Authentication

Before you can start querying the TruVoice GraphQL API, you'll need to provide authentication with a valid API token and your TruVoice Client ID. Please reach out to your CSM for this information if they have not already provided it.

Using API Tokens and Client ID

Once you've received your API token and Client ID you can start making requests with the API. You will need to pass the token and the client ID to the API in the header of your requests.

Send the API token in the "apikey" header:
"apikey: xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx"

Send the Client ID in the "truvoice-client" header: 
"truvoice-client: xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx"

Getting Help

If you need additional support with the TruVoice API you can reach out to our Developer Support team by opening a ticket at https://support.truvoice.io. We're here to help with:

  • Bug reports
  • Feature requests and enhancements
  • Questions about this API

Queries

contact

Response

Returns a Contact!

Arguments
Name Description
id - String! A unique contact identifier.

Example

Query
query contact($id: String!) {
  contact(id: $id) {
    id
    crm_ID
    first_name
    last_name
    email
    title
    phone
    outcome
    outcome_value
    outcome_type
    outcome_type_value
    outcome_strength
    outcome_strength_value
    published
    published_at
    decision_date
    decision_at
    created
    created_at
    surveyed_at
    interviewed_at
    tags
    buyer_roles
    price_position {
      ...PricePositionFragment
    }
    advantage_score
    retention_score
    feedback_type
    feedback_type_value
    customer_type
    customer_type_value
    decision_type
    decision_type_value
    purchase_type
    purchase_type_value
    evaluation_type
    evaluation_type_value
    result_type
    value_position
    value_position_value
    experience_type
    experience_type_value
    lifecycle_stage
    lifecycle_stage_value
    nps_type
    nps_type_value
    future_business_type
    future_business_type_value
    advisor_type
    advisor_type_value
    roi_type
    roi_type_value
    experience_condition
    experience_condition_value
    experience_strength
    experience_strength_value
    experience_quality
    effort_level
    effort_level_value
    effort_to_value
    value_direction
    value_direction_value
    value_level
    value_level_value
    status
    winnable
    winnable_value
    nps_score
    future_business_score
    advisor_score
    roi_score
    transcript_url
    activities {
      ...ActivityFragment
    }
    insights {
      ...InsightFragment
    }
    vendors {
      ...VendorFragment
    }
    criteria {
      ...CriterionFragment
    }
    questions {
      ...QuestionFragment
    }
    opportunity {
      ...OpportunityFragment
    }
    custom_fields {
      ...CustomFieldFragment
    }
  }
}
Variables
{"id": "xyz789"}
Response
{
  "data": {
    "contact": {
      "id": "58af4d9fb310d92314626f9b",
      "crm_ID": "xyz789",
      "first_name": "Jane",
      "last_name": "Smith",
      "email": "[email protected]",
      "title": "abc123",
      "phone": "abc123",
      "outcome": "abc123",
      "outcome_value": 987,
      "outcome_type": "xyz789",
      "outcome_type_value": 123,
      "outcome_strength": "xyz789",
      "outcome_strength_value": 123,
      "published": "2021-10-07",
      "published_at": "2022-10-07",
      "decision_date": "2021-10-07",
      "decision_at": "2022-10-07",
      "created": "2021-10-07",
      "created_at": "2022-10-07",
      "surveyed_at": "2022-10-07",
      "interviewed_at": "2022-10-07",
      "tags": ["xyz789"],
      "buyer_roles": "abc123",
      "price_position": PricePosition,
      "advantage_score": 987.65,
      "retention_score": 123.45,
      "feedback_type": "abc123",
      "feedback_type_value": 123,
      "customer_type": "abc123",
      "customer_type_value": 987,
      "decision_type": "abc123",
      "decision_type_value": 987,
      "purchase_type": "xyz789",
      "purchase_type_value": 987,
      "evaluation_type": "abc123",
      "evaluation_type_value": 123,
      "result_type": "abc123",
      "value_position": "abc123",
      "value_position_value": 987,
      "experience_type": "abc123",
      "experience_type_value": 987,
      "lifecycle_stage": "xyz789",
      "lifecycle_stage_value": 987,
      "nps_type": "abc123",
      "nps_type_value": 987,
      "future_business_type": "xyz789",
      "future_business_type_value": 987,
      "advisor_type": "abc123",
      "advisor_type_value": 123,
      "roi_type": "xyz789",
      "roi_type_value": 123,
      "experience_condition": "abc123",
      "experience_condition_value": 987,
      "experience_strength": "xyz789",
      "experience_strength_value": 123,
      "experience_quality": "abc123",
      "effort_level": "xyz789",
      "effort_level_value": 123,
      "effort_to_value": "abc123",
      "value_direction": "abc123",
      "value_direction_value": 123,
      "value_level": "abc123",
      "value_level_value": 987,
      "status": "xyz789",
      "winnable": "xyz789",
      "winnable_value": 123,
      "nps_score": 123,
      "future_business_score": 123,
      "advisor_score": 123,
      "roi_score": 987,
      "transcript_url": "xyz789",
      "activities": [Activity],
      "insights": [Insight],
      "vendors": [Vendor],
      "criteria": [Criterion],
      "questions": [Question],
      "opportunity": Opportunity,
      "custom_fields": [CustomField]
    }
  }
}
Queries

contacts

Response

Returns [Contact!]!

Arguments
Name Description
ids - [String!] A list of unique contact identifier(s).
published_from - DateTime From date in ISO format (i.e. 2021-12-01). If the include_unpublished argument is set to true then this argument is ignored.
published_to - DateTime To date in ISO format (i.e. 2021-12-31). If the include_unpublished argument is set to true then this argument is ignored.
include_unpublished - Boolean! Boolean to only include contact's which have a published profile. Default = false
decision_from - DateTime From date in ISO format (i.e. 2021-12-01).
decision_to - DateTime To date in ISO format (i.e. 2021-12-31).
tags - [String!] Tags that can be used to filter the contacts returned.
order_by - ContactOrderBy The order in which to retrieve your contacts.
initiative_ids - [String!] A list of unique initiative identifier(s).
has_opportunity_crm_id - Boolean! When true, indicates the opportunity must have a CRM ID to include the contact. Default = false
page - Int! The page number returned if you implement pagination. Default = 1
limit - Int! The number of contacts returned. Providing a value implements pagination. Max limit is 250. Default = 100

Example

Query
query contacts(
  $ids: [String!],
  $published_from: DateTime,
  $published_to: DateTime,
  $include_unpublished: Boolean!,
  $decision_from: DateTime,
  $decision_to: DateTime,
  $tags: [String!],
  $order_by: ContactOrderBy,
  $initiative_ids: [String!],
  $has_opportunity_crm_id: Boolean!,
  $page: Int!,
  $limit: Int!
) {
  contacts(
    ids: $ids,
    published_from: $published_from,
    published_to: $published_to,
    include_unpublished: $include_unpublished,
    decision_from: $decision_from,
    decision_to: $decision_to,
    tags: $tags,
    order_by: $order_by,
    initiative_ids: $initiative_ids,
    has_opportunity_crm_id: $has_opportunity_crm_id,
    page: $page,
    limit: $limit
  ) {
    id
    crm_ID
    first_name
    last_name
    email
    title
    phone
    outcome
    outcome_value
    outcome_type
    outcome_type_value
    outcome_strength
    outcome_strength_value
    published
    published_at
    decision_date
    decision_at
    created
    created_at
    surveyed_at
    interviewed_at
    tags
    buyer_roles
    price_position {
      ...PricePositionFragment
    }
    advantage_score
    retention_score
    feedback_type
    feedback_type_value
    customer_type
    customer_type_value
    decision_type
    decision_type_value
    purchase_type
    purchase_type_value
    evaluation_type
    evaluation_type_value
    result_type
    value_position
    value_position_value
    experience_type
    experience_type_value
    lifecycle_stage
    lifecycle_stage_value
    nps_type
    nps_type_value
    future_business_type
    future_business_type_value
    advisor_type
    advisor_type_value
    roi_type
    roi_type_value
    experience_condition
    experience_condition_value
    experience_strength
    experience_strength_value
    experience_quality
    effort_level
    effort_level_value
    effort_to_value
    value_direction
    value_direction_value
    value_level
    value_level_value
    status
    winnable
    winnable_value
    nps_score
    future_business_score
    advisor_score
    roi_score
    transcript_url
    activities {
      ...ActivityFragment
    }
    insights {
      ...InsightFragment
    }
    vendors {
      ...VendorFragment
    }
    criteria {
      ...CriterionFragment
    }
    questions {
      ...QuestionFragment
    }
    opportunity {
      ...OpportunityFragment
    }
    custom_fields {
      ...CustomFieldFragment
    }
  }
}
Variables
{
  "ids": ["xyz789"],
  "published_from": "2022-10-07T01:08:03.420Z",
  "published_to": "2022-10-07T01:08:03.420Z",
  "include_unpublished": false,
  "decision_from": "2022-10-07T01:08:03.420Z",
  "decision_to": "2022-10-07T01:08:03.420Z",
  "tags": ["xyz789"],
  "order_by": "CREATED_AT",
  "initiative_ids": ["abc123"],
  "has_opportunity_crm_id": false,
  "page": 1,
  "limit": 100
}
Response
{
  "data": {
    "contacts": [
      {
        "id": "58af4d9fb310d92314626f9b",
        "crm_ID": "xyz789",
        "first_name": "Jane",
        "last_name": "Smith",
        "email": "[email protected]",
        "title": "xyz789",
        "phone": "abc123",
        "outcome": "abc123",
        "outcome_value": 123,
        "outcome_type": "abc123",
        "outcome_type_value": 987,
        "outcome_strength": "abc123",
        "outcome_strength_value": 123,
        "published": "2021-10-07",
        "published_at": "2022-10-07",
        "decision_date": "2021-10-07",
        "decision_at": "2022-10-07",
        "created": "2021-10-07",
        "created_at": "2022-10-07",
        "surveyed_at": "2022-10-07",
        "interviewed_at": "2022-10-07",
        "tags": ["abc123"],
        "buyer_roles": "xyz789",
        "price_position": PricePosition,
        "advantage_score": 987.65,
        "retention_score": 123.45,
        "feedback_type": "xyz789",
        "feedback_type_value": 987,
        "customer_type": "abc123",
        "customer_type_value": 123,
        "decision_type": "xyz789",
        "decision_type_value": 123,
        "purchase_type": "xyz789",
        "purchase_type_value": 123,
        "evaluation_type": "abc123",
        "evaluation_type_value": 987,
        "result_type": "xyz789",
        "value_position": "xyz789",
        "value_position_value": 123,
        "experience_type": "xyz789",
        "experience_type_value": 987,
        "lifecycle_stage": "abc123",
        "lifecycle_stage_value": 123,
        "nps_type": "xyz789",
        "nps_type_value": 987,
        "future_business_type": "xyz789",
        "future_business_type_value": 987,
        "advisor_type": "abc123",
        "advisor_type_value": 123,
        "roi_type": "xyz789",
        "roi_type_value": 123,
        "experience_condition": "abc123",
        "experience_condition_value": 123,
        "experience_strength": "xyz789",
        "experience_strength_value": 123,
        "experience_quality": "xyz789",
        "effort_level": "abc123",
        "effort_level_value": 123,
        "effort_to_value": "abc123",
        "value_direction": "xyz789",
        "value_direction_value": 123,
        "value_level": "xyz789",
        "value_level_value": 987,
        "status": "abc123",
        "winnable": "xyz789",
        "winnable_value": 987,
        "nps_score": 987,
        "future_business_score": 987,
        "advisor_score": 123,
        "roi_score": 123,
        "transcript_url": "xyz789",
        "activities": [Activity],
        "insights": [Insight],
        "vendors": [Vendor],
        "criteria": [Criterion],
        "questions": [Question],
        "opportunity": Opportunity,
        "custom_fields": [CustomField]
      }
    ]
  }
}
Queries

initiative

Response

Returns an Initiative!

Arguments
Name Description
id - String!

Example

Query
query initiative($id: String!) {
  initiative(id: $id) {
    id
    name
    program_type
    industry
    updated
    buyer_roles {
      ...BuyerRoleFragment
    }
    buyer_types {
      ...BuyerTypeFragment
    }
    opportunities {
      ...OpportunityFragment
    }
  }
}
Variables
{"id": "xyz789"}
Response
{
  "data": {
    "initiative": {
      "id": "58af4d9fb310d92314626f9b",
      "name": "xyz789",
      "program_type": "abc123",
      "industry": "abc123",
      "updated": "2021-10-07",
      "buyer_roles": [BuyerRole],
      "buyer_types": [BuyerType],
      "opportunities": [Opportunity]
    }
  }
}
Queries

initiatives

Response

Returns [Initiative!]!

Arguments
Name Description
ids - [String!]! A list of unique initiative identifier(s).

Example

Query
query initiatives($ids: [String!]!) {
  initiatives(ids: $ids) {
    id
    name
    program_type
    industry
    updated
    buyer_roles {
      ...BuyerRoleFragment
    }
    buyer_types {
      ...BuyerTypeFragment
    }
    opportunities {
      ...OpportunityFragment
    }
  }
}
Variables
{"ids": ["xyz789"]}
Response
{
  "data": {
    "initiatives": [
      {
        "id": "58af4d9fb310d92314626f9b",
        "name": "abc123",
        "program_type": "abc123",
        "industry": "xyz789",
        "updated": "2021-10-07",
        "buyer_roles": [BuyerRole],
        "buyer_types": [BuyerType],
        "opportunities": [Opportunity]
      }
    ]
  }
}
Queries

opportunities

Response

Returns [Opportunity!]!

Arguments
Name Description
ids - [String!] A list of unique opportunity identifier(s).
include_unpublished - Boolean! Boolean to only include opportunities with at least one published profile. Default = false
newest_first - Boolean! Get the recently created opportunity at the top of the list. Default = false
research_types - [ResearchType!] A list of opportunity research types.
tags - [String!] Tags that can be used to filter the opportunities returned.
page - Int! The page number returned if you implement pagination. Default = 1
limit - Int! The number of opportunities returned. Providing a value implements pagination. Max limit is 250. Default = 100

Example

Query
query opportunities(
  $ids: [String!],
  $include_unpublished: Boolean!,
  $newest_first: Boolean!,
  $research_types: [ResearchType!],
  $tags: [String!],
  $page: Int!,
  $limit: Int!
) {
  opportunities(
    ids: $ids,
    include_unpublished: $include_unpublished,
    newest_first: $newest_first,
    research_types: $research_types,
    tags: $tags,
    page: $page,
    limit: $limit
  ) {
    id
    name
    account_name
    crm_account_id
    crm_owner_id
    custom_ID
    outcome
    outcome_value
    opportunity_value
    close_date
    created
    research_type
    research_type_value
    website
    tags
    outcome_reasons {
      ...OutcomeReasonFragment
    }
    contacts {
      ...ContactFragment
    }
    competitors {
      ...VendorFragment
    }
    sales_reps {
      ...BasicUserFragment
    }
    sales_managers {
      ...BasicUserFragment
    }
    account_managers {
      ...BasicUserFragment
    }
    products
    industry
    custom_fields {
      ...CustomFieldFragment
    }
    initiative_id
  }
}
Variables
{
  "ids": ["xyz789"],
  "include_unpublished": false,
  "newest_first": false,
  "research_types": ["DECISION"],
  "tags": ["xyz789"],
  "page": 1,
  "limit": 100
}
Response
{
  "data": {
    "opportunities": [
      {
        "id": "58af4d9fb310d92314626f9b",
        "name": "abc123",
        "account_name": "xyz789",
        "crm_account_id": "abc123",
        "crm_owner_id": "abc123",
        "custom_ID": "abc123",
        "outcome": "abc123",
        "outcome_value": 987,
        "opportunity_value": 123.45,
        "close_date": "2021-10-07",
        "created": "2021-10-07",
        "research_type": "xyz789",
        "research_type_value": 123,
        "website": "abc123",
        "tags": ["abc123"],
        "outcome_reasons": [OutcomeReason],
        "contacts": [Contact],
        "competitors": [Vendor],
        "sales_reps": [BasicUser],
        "sales_managers": [BasicUser],
        "account_managers": [BasicUser],
        "products": ["abc123"],
        "industry": "abc123",
        "custom_fields": [CustomField],
        "initiative_id": "abc123"
      }
    ]
  }
}
Queries

opportunity

Response

Returns an Opportunity!

Arguments
Name Description
id - String! A unique opportunity or CRM identifier.

Example

Query
query opportunity($id: String!) {
  opportunity(id: $id) {
    id
    name
    account_name
    crm_account_id
    crm_owner_id
    custom_ID
    outcome
    outcome_value
    opportunity_value
    close_date
    created
    research_type
    research_type_value
    website
    tags
    outcome_reasons {
      ...OutcomeReasonFragment
    }
    contacts {
      ...ContactFragment
    }
    competitors {
      ...VendorFragment
    }
    sales_reps {
      ...BasicUserFragment
    }
    sales_managers {
      ...BasicUserFragment
    }
    account_managers {
      ...BasicUserFragment
    }
    products
    industry
    custom_fields {
      ...CustomFieldFragment
    }
    initiative_id
  }
}
Variables
{"id": "xyz789"}
Response
{
  "data": {
    "opportunity": {
      "id": "58af4d9fb310d92314626f9b",
      "name": "abc123",
      "account_name": "xyz789",
      "crm_account_id": "xyz789",
      "crm_owner_id": "xyz789",
      "custom_ID": "xyz789",
      "outcome": "abc123",
      "outcome_value": 123,
      "opportunity_value": 123.45,
      "close_date": "2021-10-07",
      "created": "2021-10-07",
      "research_type": "abc123",
      "research_type_value": 123,
      "website": "abc123",
      "tags": ["abc123"],
      "outcome_reasons": [OutcomeReason],
      "contacts": [Contact],
      "competitors": [Vendor],
      "sales_reps": [BasicUser],
      "sales_managers": [BasicUser],
      "account_managers": [BasicUser],
      "products": ["xyz789"],
      "industry": "xyz789",
      "custom_fields": [CustomField],
      "initiative_id": "xyz789"
    }
  }
}
Queries

organization

Response

Returns an Organization!

Arguments
Name Description
id - String!

Example

Query
query organization($id: String!) {
  organization(id: $id) {
    id
    name
    sso_enabled
    email_domain
    email_subdomain
    domains
    created
    initiatives {
      ...InitiativeFragment
    }
    users {
      ...UserFragment
    }
    products {
      ...ProductFragment
    }
    competitors {
      ...CompetitorFragment
    }
    buyer_roles {
      ...BuyerRoleFragment
    }
    research_types {
      ...BasicItemFragment
    }
    outcome_types {
      ...BasicItemFragment
    }
    price_positions {
      ...BasicItemFragment
    }
    decision_types {
      ...BasicItemFragment
    }
    customer_types {
      ...BasicItemFragment
    }
    nps_types {
      ...BasicItemFragment
    }
    future_business_types {
      ...BasicItemFragment
    }
    advisor_types {
      ...BasicItemFragment
    }
    roi_types {
      ...BasicItemFragment
    }
    experience_condition_types {
      ...BasicItemFragment
    }
    experience_strength_types {
      ...BasicItemFragment
    }
    experience_types {
      ...BasicItemFragment
    }
    effort_level_types {
      ...BasicItemFragment
    }
    insight_types {
      ...BasicItemFragment
    }
    insight_attributes {
      ...InsightAttributeTypeFragment
    }
    insight_impacts {
      ...BasicItemFragment
    }
    insight_classifications {
      ...BasicItemFragment
    }
    feedback_types {
      ...BasicItemFragment
    }
    value_positions {
      ...BasicItemFragment
    }
    lifecycle_stages {
      ...BasicItemFragment
    }
    outcome_strengths {
      ...BasicItemFragment
    }
    winnable_statuses {
      ...BasicItemFragment
    }
    evaluation_types {
      ...BasicItemFragment
    }
    purchase_types {
      ...BasicItemFragment
    }
    value_directions {
      ...BasicItemFragment
    }
    value_levels {
      ...BasicItemFragment
    }
  }
}
Variables
{"id": "abc123"}
Response
{
  "data": {
    "organization": {
      "id": "58af4d9fb310d92314626f9b",
      "name": "xyz789",
      "sso_enabled": false,
      "email_domain": "abc123",
      "email_subdomain": "abc123",
      "domains": ["abc123"],
      "created": "2021-10-07",
      "initiatives": [Initiative],
      "users": [User],
      "products": [Product],
      "competitors": [Competitor],
      "buyer_roles": [BuyerRole],
      "research_types": [BasicItem],
      "outcome_types": [BasicItem],
      "price_positions": [BasicItem],
      "decision_types": [BasicItem],
      "customer_types": [BasicItem],
      "nps_types": [BasicItem],
      "future_business_types": [BasicItem],
      "advisor_types": [BasicItem],
      "roi_types": [BasicItem],
      "experience_condition_types": [BasicItem],
      "experience_strength_types": [BasicItem],
      "experience_types": [BasicItem],
      "effort_level_types": [BasicItem],
      "insight_types": [BasicItem],
      "insight_attributes": [InsightAttributeType],
      "insight_impacts": [BasicItem],
      "insight_classifications": [BasicItem],
      "feedback_types": [BasicItem],
      "value_positions": [BasicItem],
      "lifecycle_stages": [BasicItem],
      "outcome_strengths": [BasicItem],
      "winnable_statuses": [BasicItem],
      "evaluation_types": [BasicItem],
      "purchase_types": [BasicItem],
      "value_directions": [BasicItem],
      "value_levels": [BasicItem]
    }
  }
}
Queries

organizations

Response

Returns [Organization!]!

Arguments
Name Description
ids - [String!] A list of unique organization identifier(s).

Example

Query
query organizations($ids: [String!]) {
  organizations(ids: $ids) {
    id
    name
    sso_enabled
    email_domain
    email_subdomain
    domains
    created
    initiatives {
      ...InitiativeFragment
    }
    users {
      ...UserFragment
    }
    products {
      ...ProductFragment
    }
    competitors {
      ...CompetitorFragment
    }
    buyer_roles {
      ...BuyerRoleFragment
    }
    research_types {
      ...BasicItemFragment
    }
    outcome_types {
      ...BasicItemFragment
    }
    price_positions {
      ...BasicItemFragment
    }
    decision_types {
      ...BasicItemFragment
    }
    customer_types {
      ...BasicItemFragment
    }
    nps_types {
      ...BasicItemFragment
    }
    future_business_types {
      ...BasicItemFragment
    }
    advisor_types {
      ...BasicItemFragment
    }
    roi_types {
      ...BasicItemFragment
    }
    experience_condition_types {
      ...BasicItemFragment
    }
    experience_strength_types {
      ...BasicItemFragment
    }
    experience_types {
      ...BasicItemFragment
    }
    effort_level_types {
      ...BasicItemFragment
    }
    insight_types {
      ...BasicItemFragment
    }
    insight_attributes {
      ...InsightAttributeTypeFragment
    }
    insight_impacts {
      ...BasicItemFragment
    }
    insight_classifications {
      ...BasicItemFragment
    }
    feedback_types {
      ...BasicItemFragment
    }
    value_positions {
      ...BasicItemFragment
    }
    lifecycle_stages {
      ...BasicItemFragment
    }
    outcome_strengths {
      ...BasicItemFragment
    }
    winnable_statuses {
      ...BasicItemFragment
    }
    evaluation_types {
      ...BasicItemFragment
    }
    purchase_types {
      ...BasicItemFragment
    }
    value_directions {
      ...BasicItemFragment
    }
    value_levels {
      ...BasicItemFragment
    }
  }
}
Variables
{"ids": ["xyz789"]}
Response
{
  "data": {
    "organizations": [
      {
        "id": "58af4d9fb310d92314626f9b",
        "name": "xyz789",
        "sso_enabled": false,
        "email_domain": "abc123",
        "email_subdomain": "abc123",
        "domains": ["abc123"],
        "created": "2021-10-07",
        "initiatives": [Initiative],
        "users": [User],
        "products": [Product],
        "competitors": [Competitor],
        "buyer_roles": [BuyerRole],
        "research_types": [BasicItem],
        "outcome_types": [BasicItem],
        "price_positions": [BasicItem],
        "decision_types": [BasicItem],
        "customer_types": [BasicItem],
        "nps_types": [BasicItem],
        "future_business_types": [BasicItem],
        "advisor_types": [BasicItem],
        "roi_types": [BasicItem],
        "experience_condition_types": [BasicItem],
        "experience_strength_types": [BasicItem],
        "experience_types": [BasicItem],
        "effort_level_types": [BasicItem],
        "insight_types": [BasicItem],
        "insight_attributes": [InsightAttributeType],
        "insight_impacts": [BasicItem],
        "insight_classifications": [BasicItem],
        "feedback_types": [BasicItem],
        "value_positions": [BasicItem],
        "lifecycle_stages": [BasicItem],
        "outcome_strengths": [BasicItem],
        "winnable_statuses": [BasicItem],
        "evaluation_types": [BasicItem],
        "purchase_types": [BasicItem],
        "value_directions": [BasicItem],
        "value_levels": [BasicItem]
      }
    ]
  }
}
Queries

user

Response

Returns a User!

Arguments
Name Description
id - String!

Example

Query
query user($id: String!) {
  user(id: $id) {
    id
    first_name
    last_name
    full_name
    email
    title
    company
    phone
    is_enabled
    created
    last_login
    login_count
    sso_enabled
  }
}
Variables
{"id": "xyz789"}
Response
{
  "data": {
    "user": {
      "id": "58af4d9fb310d92314626f9b",
      "first_name": "Jane",
      "last_name": "Smith",
      "full_name": "Jane Smith",
      "email": "[email protected]",
      "title": "abc123",
      "company": "abc123",
      "phone": "abc123",
      "is_enabled": true,
      "created": "2021-10-07",
      "last_login": "2021-10-07T01:08:03.420Z",
      "login_count": 987,
      "sso_enabled": true
    }
  }
}
Queries

users

Response

Returns [User!]!

Arguments
Name Description
ids - [String!]! A list of unique user identifier(s).
include_disabled - Boolean! Boolean to only include disabled users, otherwise only enabled users will be included. Default = false

Example

Query
query users(
  $ids: [String!]!,
  $include_disabled: Boolean!
) {
  users(
    ids: $ids,
    include_disabled: $include_disabled
  ) {
    id
    first_name
    last_name
    full_name
    email
    title
    company
    phone
    is_enabled
    created
    last_login
    login_count
    sso_enabled
  }
}
Variables
{
  "ids": ["xyz789"],
  "include_disabled": false
}
Response
{
  "data": {
    "users": [
      {
        "id": "58af4d9fb310d92314626f9b",
        "first_name": "Jane",
        "last_name": "Smith",
        "full_name": "Jane Smith",
        "email": "[email protected]",
        "title": "xyz789",
        "company": "abc123",
        "phone": "abc123",
        "is_enabled": false,
        "created": "2021-10-07",
        "last_login": "2021-10-07T01:08:03.420Z",
        "login_count": 123,
        "sso_enabled": false
      }
    ]
  }
}

Types

Activity

Description

An activity completed for a contact.

Fields
Field Name Description
disposition_value - Int The ID of the disposition that was applied to the activity.
disposition - String The name of the disposition that was applied to the activity.
completed - DateTime When the activity was completed.
completed_by - String Who completed the activity.
callback - DateTime The date/time of the scheduled callback.
notes - String Additional notes for the activity.
Example
{
  "disposition_value": 987,
  "disposition": "xyz789",
  "completed": "2022-10-07T01:08:03.420Z",
  "completed_by": "abc123",
  "callback": "2022-10-07T01:08:03.420Z",
  "notes": "xyz789"
}
Types

Answer

Description

An answer associated with a contact question.

Fields
Field Name Description
value - Int! The answer's unique identifier.
text - String! The text for the answer.
order - Int The order the answer is displayed.
column_value - Int
column_label - String
selected_value - Int
selected_text - String
definition - String The detailed description for the answer.
is_write_in - Boolean! When true, indicates that the answer was a write-in.
write_in_value - String When is_write_in is true, this is the write-in response.
is_selected - Boolean When true, indicates that the answer was selected.
low_value - Int When the answer represents a range, this is the low value for the range.
high_value - Int When the answer represents a range, this is the high value for the range.
response - String The free form response.
instances - [LoopInstance!] A list of loop instances.
Example
{
  "value": 987,
  "text": "xyz789",
  "order": 987,
  "column_value": 987,
  "column_label": "abc123",
  "selected_value": 123,
  "selected_text": "abc123",
  "definition": "xyz789",
  "is_write_in": true,
  "write_in_value": "abc123",
  "is_selected": true,
  "low_value": 987,
  "high_value": 123,
  "response": "xyz789",
  "instances": [LoopInstance]
}
Types

Aspect

Description

An aspect associated with an insight attribute.

Fields
Field Name Description
name - String!
definition - String
Example
{
  "name": "abc123",
  "definition": "xyz789"
}
Types

BasicItem

Description

A generic item with a value and label, typically used for static lists.

Fields
Field Name Description
value - Int! A unique numeric value for the item.
label - String! The label, or name, for the item.
Example
{"value": 123, "label": "xyz789"}
Types

BasicUser

Description

A user with a basic set of information.

Fields
Field Name Description
id - ID! The user's unique identifier.
full_name - String The user's full name.
email - String The user's email address.
Example
{
  "id": "58af4d9fb310d92314626f9b",
  "full_name": "abc123",
  "email": "abc123"
}
Types

Boolean

Description

The Boolean scalar type represents true or false.

Example
true
Types

BuyerRole

Description

The role the buyer had during the decision.

Fields
Field Name Description
id - String! The buyer type/role's unique identifier.
name - String! The name of the buyer type/role.
definition - String The detailed description for the buyer type/role.
is_enabled - Boolean When true, indicates the buyer role is enabled.
Example
{
  "id": "xyz789",
  "name": "xyz789",
  "definition": "abc123",
  "is_enabled": true
}
Types

BuyerType

Description

The type of buyer for the decision.

Fields
Field Name Description
id - String! The buyer type/role's unique identifier.
name - String! The name of the buyer type/role.
definition - String The detailed description for the buyer type/role.
is_enabled - Boolean When true, indicates the buyer role is enabled.
Example
{
  "id": "xyz789",
  "name": "abc123",
  "definition": "abc123",
  "is_enabled": true
}
Types

Competitor

Description

A competitor to the organization

Fields
Field Name Description
id - ID! The competitor's unique identifier.
value - Int! The unique numeric value for the competitor.
name - String! The name of the competitor.
Example
{
  "id": "58af4d9fb310d92314626f9b",
  "value": 987,
  "name": "xyz789"
}
Types

Contact

Description

A contact for an opportunity.

Fields
Field Name Description
id - ID! The contact's unique identifier.
crm_ID - String The identifier for the contact which comes from your CRM.
first_name - String The contact's first name.
last_name - String The contact's last name.
email - String The contact's email address.
title - String The contact's title.
phone - String The contact's phone number.
outcome - String The outcome for the contact.
outcome_value - Int The identifier for the contact's outcome.
outcome_type - String The outcome type for the contact.
outcome_type_value - Int The identifier for the contact's outcome type.
outcome_strength - String The strength of the outcome.
outcome_strength_value - Int The unique identifier for the outcome strength.
published - Date The date the contact interview was published, returned as YYYY-MM-DD. This field is being replaced by published_at.
published_at - Date The date the contact interview was published, returned as YYYY-MM-DD.
decision_date - Date The date the contact's decision was made, or when the opportunity was closed, returned as YYYY-MM-DD. This field is being replaced by decision_at.
decision_at - Date The date the contact's decision was made, or when the opportunity was closed, returned as YYYY-MM-DD.
created - Date When the contact was created, returned as YYYY-MM-DD. This field is being replaced by created_at.
created_at - Date When the contact was created, returned as YYYY-MM-DD.
surveyed_at - Date The date the survey was completed with the contact.
interviewed_at - Date The date the interview was completed with the contact (a null value means an interview was not completed).
tags - [String!] A list of tags assigned to the contact.
buyer_roles - String The contact's role(s) in purchase decisions
price_position - PricePosition The price position data for the client versus the strongest competitor.
advantage_score - Float
retention_score - Float
feedback_type - String
feedback_type_value - Int
customer_type - String
customer_type_value - Int
decision_type - String
decision_type_value - Int
purchase_type - String
purchase_type_value - Int
evaluation_type - String
evaluation_type_value - Int
result_type - String
value_position - String
value_position_value - Int
experience_type - String
experience_type_value - Int
lifecycle_stage - String
lifecycle_stage_value - Int
nps_type - String
nps_type_value - Int
future_business_type - String
future_business_type_value - Int
advisor_type - String
advisor_type_value - Int
roi_type - String
roi_type_value - Int
experience_condition - String
experience_condition_value - Int
experience_strength - String
experience_strength_value - Int
experience_quality - String
effort_level - String
effort_level_value - Int
effort_to_value - String
value_direction - String
value_direction_value - Int
value_level - String
value_level_value - Int
status - String
winnable - String
winnable_value - Int
nps_score - Int
future_business_score - Int
advisor_score - Int
roi_score - Int
transcript_url - String URL to verbatim transcript of the contact's feedback.
activities - [Activity!]! The list of activites conducted with the contact.
Arguments
newest_first - Boolean!

Get the recently created activities at the top of the list.

from - DateTime

From date in ISO format (i.e. 2021-12-01).

to - DateTime

To date in ISO format (i.e. 2021-12-31).
insights - [Insight!] The list of insights for the contact.
Arguments
text_format - TextFormat

Return the text in either HTML or plain text format.

convert_html - Boolean
vendors - [Vendor!] The list of vendors the contact evaluated.
Arguments
only_selected - Boolean

When true, only include vendors that were selected.

only_strongest - Boolean

When true, only include competitors that were considered the strongest amongst all competitors in the decision.

exclude_client - Boolean

When true, exclude the client vendor.
criteria - [Criterion!]!
Arguments
has_impact - Boolean

When true, only include criteria that had an impact on the decision.

has_ranking - Boolean

When true, only include criteria that were ranked among criteria within their respective driver.

has_rating - Boolean

When true, only include criteria that had a valid rating.

has_top_ranking - Boolean

When true, only include criteria that were ranked among all ranked driver criteria.

kind - CriteriaKind

The kind of criteria (all / driver / KPI / pricing).
questions - [Question!] The list of survey/interview questions the contact answered.
Arguments
category_ids - [Int!]
text_format - TextFormat

Return the text in either HTML or plain text format.

question_types - [QuestionType!]

The types of questions to return.

question_names - [String!]

Returns all questions that have matching names to those provided. This will perform a case-insensitive search on question names to find a match.
opportunity - Opportunity The decision, experience, or research opportunity for this contact.
custom_fields - [CustomField!] The list of custom fields for the contact.
Example
{
  "id": "58af4d9fb310d92314626f9b",
  "crm_ID": "abc123",
  "first_name": "Jane",
  "last_name": "Smith",
  "email": "[email protected]",
  "title": "xyz789",
  "phone": "abc123",
  "outcome": "xyz789",
  "outcome_value": 987,
  "outcome_type": "xyz789",
  "outcome_type_value": 123,
  "outcome_strength": "abc123",
  "outcome_strength_value": 123,
  "published": "2021-10-07",
  "published_at": "2022-10-07",
  "decision_date": "2021-10-07",
  "decision_at": "2022-10-07",
  "created": "2021-10-07",
  "created_at": "2022-10-07",
  "surveyed_at": "2022-10-07",
  "interviewed_at": "2022-10-07",
  "tags": ["xyz789"],
  "buyer_roles": "abc123",
  "price_position": PricePosition,
  "advantage_score": 123.45,
  "retention_score": 123.45,
  "feedback_type": "xyz789",
  "feedback_type_value": 987,
  "customer_type": "xyz789",
  "customer_type_value": 987,
  "decision_type": "abc123",
  "decision_type_value": 123,
  "purchase_type": "xyz789",
  "purchase_type_value": 123,
  "evaluation_type": "xyz789",
  "evaluation_type_value": 123,
  "result_type": "xyz789",
  "value_position": "xyz789",
  "value_position_value": 987,
  "experience_type": "xyz789",
  "experience_type_value": 987,
  "lifecycle_stage": "xyz789",
  "lifecycle_stage_value": 123,
  "nps_type": "xyz789",
  "nps_type_value": 123,
  "future_business_type": "abc123",
  "future_business_type_value": 987,
  "advisor_type": "abc123",
  "advisor_type_value": 987,
  "roi_type": "abc123",
  "roi_type_value": 987,
  "experience_condition": "abc123",
  "experience_condition_value": 987,
  "experience_strength": "abc123",
  "experience_strength_value": 987,
  "experience_quality": "abc123",
  "effort_level": "abc123",
  "effort_level_value": 987,
  "effort_to_value": "xyz789",
  "value_direction": "abc123",
  "value_direction_value": 123,
  "value_level": "xyz789",
  "value_level_value": 123,
  "status": "xyz789",
  "winnable": "xyz789",
  "winnable_value": 987,
  "nps_score": 123,
  "future_business_score": 123,
  "advisor_score": 987,
  "roi_score": 123,
  "transcript_url": "xyz789",
  "activities": [Activity],
  "insights": [Insight],
  "vendors": [Vendor],
  "criteria": [Criterion],
  "questions": [Question],
  "opportunity": Opportunity,
  "custom_fields": [CustomField]
}
Types

ContactOrderBy

Description

The order in which to retrieve your contacts.

Values
Enum Value Description

CREATED_AT

PUBLISHED_AT
Example
"CREATED_AT"
Types

CriteriaKind

Description

The kind of criteria (all / driver / KPI / pricing).

Values
Enum Value Description

ALL

DRIVER

KPI

PRICING
Example
"ALL"
Types

Criterion

Description

A criterion which has been given an impact, ranking, and/or rating by a contact.

Fields
Field Name Description
id - Int! The criterion's unique identifier.
name - String! The name of the criterion.
type - String! The criterion type (Driver / KPI / Pricing).
driver - String The driver that the criterion belongs to.
definition - String The detailed description for the criterion.
impact - String The impact that the criterion had on the decision/experience.
ranking - Int The rank value for the criterion within its driver (the lower the number, the higher the ranking).
rating - Int The rating value for the criterion within its driver.
importance - Int The overall rank value for the criterion amongst all ranked criteria (the lower the number, the higher the ranking).
vendors - [RatedVendor!] The list of evaluated vendors.
Example
{
  "id": 123,
  "name": "xyz789",
  "type": "xyz789",
  "driver": "abc123",
  "definition": "xyz789",
  "impact": "abc123",
  "ranking": 987,
  "rating": 123,
  "importance": 123,
  "vendors": [RatedVendor]
}
Types

CustomField

Fields
Field Name Description
name - String! The name for the custom field.
data_type - String! The data type for the custom field.
definition - String The definition for the custom field.
numeric_value - Float The value for the custom field when the data type is numeric (i.e. Number, Currency, or Boolean).
text_value - String The text value for the custom field when the data type is non-numeric.
values - [String!] The list of selected values for the custom field, if the data type is a List - Multi-Select.
Example
{
  "name": "xyz789",
  "data_type": "xyz789",
  "definition": "abc123",
  "numeric_value": 987.65,
  "text_value": "abc123",
  "values": ["abc123"]
}
Types

Date

Description

A short date string in a YYYY-MM-DD format.

Example
"2022-10-07"
Types

DateTime

Description

A date-time string at UTC, such as 2019-12-03T09:54:33Z, compliant with the date-time format.

Example
"2022-10-07T01:08:03.420Z"
Types

Float

Description

The Float scalar type represents signed double-precision fractional values as specified by IEEE 754.

Example
987.65
Types

ID

Description

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.

Example
"58af4d9fb310d92314626f9b"
Types

Initiative

Description

An initiative for a client organization, usually based on a product or product family.

Fields
Field Name Description
id - ID! The initiative's unique identifier.
name - String! The name of the initiative.
program_type - String! The program type for the initiative (Voice of the Buyer, Win Loss, Customer Experience, etc.)
industry - String The initiative's industry.
updated - Date The last time the initiative was updated, returned as YYYY-MM-DD.
buyer_roles - [BuyerRole!]!
buyer_types - [BuyerType!]!
opportunities - [Opportunity!] The list of opportunities for the initiative.
Arguments
ids - [String!]

A list of unique opportunity identifier(s).

include_unpublished - Boolean!

Boolean to only include opportunities with at least one published profile.

newest_first - Boolean!

Get the recently created opportunity at the top of the list.

research_types - [ResearchType!]

A list of opportunity research types.

tags - [String!]

Tags that can be used to filter the opportunities returned.

page - Int!

The page number returned if you implement pagination.

limit - Int!

The number of opportunities returned. Providing a value implements pagination. Max limit is 250.
Example
{
  "id": "58af4d9fb310d92314626f9b",
  "name": "xyz789",
  "program_type": "xyz789",
  "industry": "abc123",
  "updated": "2021-10-07",
  "buyer_roles": [BuyerRole],
  "buyer_types": [BuyerType],
  "opportunities": [Opportunity]
}
Types

Insight

Description

A decision/experience insight created during analysis.

Fields
Field Name Description
id - ID! The insight's unique identifier.
text - String The insight statement.
impact_value - Int The insight impact's unique identifier.
impact - String The impact of the insight (Major / Minor / No impact).
classification_value - Int The insight classification's unique identifier.
classification - String The classification for the insight.
type - String The insight type (Vendor / Buyer / Quote).
vendor_id - String When the insight type is "Vendor", this is unique identifier of the vendor for the insight.
vendor_name - String When the insight type is "Vendor", this is name of the vendor for the insight.
created - Date When the insight was created, returned as YYYY-MM-DD.
attributes - [InsightAttribute!] A list of insight attributes.
Example
{
  "id": "58af4d9fb310d92314626f9b",
  "text": "abc123",
  "impact_value": 987,
  "impact": "abc123",
  "classification_value": 987,
  "classification": "abc123",
  "type": "abc123",
  "vendor_id": "abc123",
  "vendor_name": "xyz789",
  "created": "2021-10-07",
  "attributes": [InsightAttribute]
}
Types

InsightAttribute

Description

An attribute for an insight, which could be an outcome reason.

Fields
Field Name Description
id - ID The insight attribute's unique identifier.
name - String The name of the insight attribute.
definition - String The detailed description of the insight attribute.
category - String The category assigned to the insight attribute.
aspects - [Aspect!] A list of attribute aspects.
Example
{
  "id": "58af4d9fb310d92314626f9b",
  "name": "xyz789",
  "definition": "abc123",
  "category": "abc123",
  "aspects": [Aspect]
}
Types

InsightAttributeType

Description

An insight attribute type.

Fields
Field Name Description
id - ID! A unique identifier for the attribute.
value - Int! The numeric value for the attribute.
label - String! The label for the attribute type.
type - Int! A numeric value describing the attribute type (1=Driver Criterion, 4=Result, 5=Trigger Event, 6=Static Attribute).
definition - String The detailed description for the attribut typee.
Example
{
  "id": "58af4d9fb310d92314626f9b",
  "value": 123,
  "label": "xyz789",
  "type": 123,
  "definition": "xyz789"
}
Types

Int

Description

The Int scalar type represents non-fractional signed whole numeric values. Int can represent values between -(2^31) and 2^31 - 1.

Example
987
Types

LoopInstance

Description

A looping instance for a question or answer.

Fields
Field Name Description
instance_value - Int The loop instance's unique identifier.
instance - String The name of the loop instance.
response_value - Int The answer value for the loop instance.
response - String The free form response for the loop instance.
is_selected - Boolean When true, indicates the loop instance was selected for the answer (only applies to single and multiple selected question types).
Example
{
  "instance_value": 987,
  "instance": "abc123",
  "response_value": 987,
  "response": "abc123",
  "is_selected": false
}
Types

Opportunity

Description

A decision, experience, or research opportunity for the initiative.

Fields
Field Name Description
id - ID! The opportunity's unique identifier.
name - String! The name of the opportunity.
account_name - String! The name of the account.
crm_account_id - String The account ID from your CRM system.
crm_owner_id - String The opportunity owner ID from your CRM system.
custom_ID - String A custom identifier for the opportunity. This is typically the opportunity ID from your CRM system.
outcome - String The outcome for the opportunity.
outcome_value - Int The identifier for the opportunity's outcome.
opportunity_value - Float
close_date - Date The date the opportunity was closed in your CRM, returned as YYYY-MM-DD.
created - Date When the opportunity was created, returned as YYYY-MM-DD.
research_type - String! The research type for the opportunity (Decision / Experience / Research).
research_type_value - Int! The unique identifier for the research type.
website - String The website URL for the opportunity.
tags - [String!] A list of tags assigned to the opportunity.
outcome_reasons - [OutcomeReason!]!
Arguments
only_client_reasons - Boolean
contacts - [Contact!]! The list of contacts for the opportunity.
Arguments
ids - [String!]

A list of unique contact identifier(s).

published_from - DateTime

From date in ISO format (i.e. 2021-12-01). If the include_unpublished argument is set to true then this argument is ignored.

published_to - DateTime

To date in ISO format (i.e. 2021-12-31). If the include_unpublished argument is set to true then this argument is ignored.

include_unpublished - Boolean!

Boolean to only include contact's which have a published profile.

decision_from - DateTime

From date in ISO format (i.e. 2021-12-01).

decision_to - DateTime

To date in ISO format (i.e. 2021-12-31).

tags - [String!]

Tags that can be used to filter the contacts returned.

order_by - ContactOrderBy

The order in which to retrieve your contacts.
competitors - [Vendor!]!
Arguments
only_selected - Boolean!
only_strongest - Boolean!
sales_reps - [BasicUser!]!
sales_managers - [BasicUser!] The list of sales managers for the opportunity.
account_managers - [BasicUser!] The list of account managers for the opportunity.
products - [String!] The list of products for the opportunity.
industry - String The industry for the opportunity.
custom_fields - [CustomField!] The list of custom fields for the opportunity.
initiative_id - String!
Example
{
  "id": "58af4d9fb310d92314626f9b",
  "name": "abc123",
  "account_name": "xyz789",
  "crm_account_id": "abc123",
  "crm_owner_id": "abc123",
  "custom_ID": "abc123",
  "outcome": "abc123",
  "outcome_value": 123,
  "opportunity_value": 987.65,
  "close_date": "2021-10-07",
  "created": "2021-10-07",
  "research_type": "xyz789",
  "research_type_value": 123,
  "website": "xyz789",
  "tags": ["xyz789"],
  "outcome_reasons": [OutcomeReason],
  "contacts": [Contact],
  "competitors": [Vendor],
  "sales_reps": [BasicUser],
  "sales_managers": [BasicUser],
  "account_managers": [BasicUser],
  "products": ["xyz789"],
  "industry": "abc123",
  "custom_fields": [CustomField],
  "initiative_id": "abc123"
}
Types

Organization

Description

A client organization.

Fields
Field Name Description
id - ID! The organization's unique identifier.
name - String! The name of the organization.
sso_enabled - Boolean When true, indicates SSO (single sign-on) is enabled for the organization.
email_domain - String The primary domain available to use for sending emails from TruVoice.
email_subdomain - String The primary subdomain available to use for sending emails from TruVoice.
domains - [String!] All domains available to use for sending emails from TruVoice.
created - Date When the organization was created, returned as YYYY-MM-DD.
initiatives - [Initiative!]! The list of initiatives for the organization.
Arguments
ids - [String!]

A list of unique initiative identifier(s).

program_types - [ProgramType!]

A list of initiative program types.
users - [User!]! The list of users for the organization.
Arguments
ids - [String!]

A list of unique user identifier(s).

include_disabled - Boolean!

Boolean to only include disabled users, otherwise only enabled users will be included.
products - [Product!]! This list of products for the organization.
Arguments
ids - [String!]

A list of unique product identifier(s).

include_disabled - Boolean!

Boolean to only include disabled products, otherwise only enabled products will be included.
competitors - [Competitor!]! This list of competitors for the organization.
Arguments
ids - [String!]

A list of unique competitor identifier(s).
buyer_roles - [BuyerRole!]!
Arguments
include_disabled - Boolean!

Boolean to only include disabled buyer roles, otherwise only enabled buyer roles will be included.
research_types - [BasicItem!]! A list of all possible research types.
outcome_types - [BasicItem!]! A list of all possible outcome types.
price_positions - [BasicItem!]! A list of all possible price positions.
decision_types - [BasicItem!]! A list of all possible decision types.
customer_types - [BasicItem!]! A list of all possible customer types.
nps_types - [BasicItem!]! A list of all possible NPS types.
future_business_types - [BasicItem!]! A list of all possible future business types.
advisor_types - [BasicItem!]! A list of all possible advisor types.
roi_types - [BasicItem!]! A list of all possible roi types.
experience_condition_types - [BasicItem!]! A list of all possible experience condition types.
experience_strength_types - [BasicItem!]! A list of all possible experience strength types.
experience_types - [BasicItem!]! A list of all possible experience types.
effort_level_types - [BasicItem!]! A list of all possible effort level types.
insight_types - [BasicItem!]! A list of all possible insight types.
insight_attributes - [InsightAttributeType!]!
insight_impacts - [BasicItem!]! A list of all possible insight impacts.
insight_classifications - [BasicItem!]! A list of all possible insight classifications.
feedback_types - [BasicItem!]! A list of all possible feedback types.
value_positions - [BasicItem!]! A list of all possible value positions.
lifecycle_stages - [BasicItem!]! A list of all possible lifecycle stages.
outcome_strengths - [BasicItem!]! A list of all possible outcome strengths.
winnable_statuses - [BasicItem!]! A list of all possible winnable statuses.
evaluation_types - [BasicItem!]! A list of all possible evaluation types.
purchase_types - [BasicItem!]! A list of all possible purchase types.
value_directions - [BasicItem!]! A list of all possible value directions.
value_levels - [BasicItem!]! A list of all possible value levels.
Example
{
  "id": "58af4d9fb310d92314626f9b",
  "name": "abc123",
  "sso_enabled": true,
  "email_domain": "abc123",
  "email_subdomain": "xyz789",
  "domains": ["abc123"],
  "created": "2021-10-07",
  "initiatives": [Initiative],
  "users": [User],
  "products": [Product],
  "competitors": [Competitor],
  "buyer_roles": [BuyerRole],
  "research_types": [BasicItem],
  "outcome_types": [BasicItem],
  "price_positions": [BasicItem],
  "decision_types": [BasicItem],
  "customer_types": [BasicItem],
  "nps_types": [BasicItem],
  "future_business_types": [BasicItem],
  "advisor_types": [BasicItem],
  "roi_types": [BasicItem],
  "experience_condition_types": [BasicItem],
  "experience_strength_types": [BasicItem],
  "experience_types": [BasicItem],
  "effort_level_types": [BasicItem],
  "insight_types": [BasicItem],
  "insight_attributes": [InsightAttributeType],
  "insight_impacts": [BasicItem],
  "insight_classifications": [BasicItem],
  "feedback_types": [BasicItem],
  "value_positions": [BasicItem],
  "lifecycle_stages": [BasicItem],
  "outcome_strengths": [BasicItem],
  "winnable_statuses": [BasicItem],
  "evaluation_types": [BasicItem],
  "purchase_types": [BasicItem],
  "value_directions": [BasicItem],
  "value_levels": [BasicItem]
}
Types

OutcomeReason

Description

Outcome reason.

Fields
Field Name Description
name - String! The name of the outcome reason.
insight - String! The insight statement for the outcome reason.
impact - String! The impact the reason had on the outcome.
Example
{
  "name": "xyz789",
  "insight": "abc123",
  "impact": "abc123"
}
Types

PricePosition

Description

The price position data for the client versus the strongest competitor.

Fields
Field Name Description
value - Int!
label - String!
vendor_value - Int!
vendor_name - String!
Example
{
  "value": 123,
  "label": "xyz789",
  "vendor_value": 123,
  "vendor_name": "xyz789"
}
Types

Product

Description

A product for the organization

Fields
Field Name Description
id - ID! The product's unique identifier.
name - String! The name of the product.
description - String The detailed description for the product.
is_enabled - Boolean When true, indicates the product is enabled.
Example
{
  "id": "58af4d9fb310d92314626f9b",
  "name": "abc123",
  "description": "xyz789",
  "is_enabled": false
}
Types

ProgramType

Description

The initiative program type.

Values
Enum Value Description

VOICE_OF_THE_BUYER

WIN_LOSS

CUSTOMER_EXPERIENCE

MARKET_RESEARCH
Example
"VOICE_OF_THE_BUYER"
Types

Question

Description

A survey/interview question that has been answered by the contact.

Fields
Field Name Description
id - String! The question's unique identifier.
name - String! The name of the question.
text - String! The text of the question.
question_type_value - Int The unique identifier for the question type.
question_type - String The type of question (single selection / multiple selection / open-end / ranking / matrix / date / form open-end).
is_looping - Boolean! When true, indicates the question is a looping style question.
category_id - Int The question category's unique identifier.
order - Int! The order the question is displayed.
response - String The free form response to the question (only available to non-looping qualitative questions).
additional_comments - String Additional comments provided by the respondent (only availabe to quantitative questions).
answers - [Answer!] A list of answers for the question.
triggers - [Trigger!] A list of trigger questions associated with the question.
Example
{
  "id": "xyz789",
  "name": "abc123",
  "text": "abc123",
  "question_type_value": 123,
  "question_type": "abc123",
  "is_looping": true,
  "category_id": 987,
  "order": 123,
  "response": "xyz789",
  "additional_comments": "abc123",
  "answers": [Answer],
  "triggers": [Trigger]
}
Types

QuestionType

Description

The question type.

Values
Enum Value Description

SINGLE_SELECTION

MULTIPLE_SELECTION

OPEN_ENDED

RANKING

MATRIX

DATE

FORM
Example
"SINGLE_SELECTION"
Types

RatedVendor

Description

A vendor that has received ratings for a criterion.

Fields
Field Name Description
id - String The vendor's unique identifier.
value - Int! The unique numeric value for the vendor.
name - String! The name of the vendor.
is_client - Boolean! When true, indicates the vendor is the client.
is_selected - Boolean! When true, indicates the vendor was selected for the decision.
is_strongest - Boolean! When true, indicates the vendor was the strongest amongst all competitors in the decision.
is_write_in - Boolean! When true, indicates the vendor was a write-in.
battlecard_url - String TruVoice URL to the battlecard for the competitor.
rating - Int The rating given to the vendor for a given criterion.
Example
{
  "id": "xyz789",
  "value": 123,
  "name": "xyz789",
  "is_client": false,
  "is_selected": false,
  "is_strongest": true,
  "is_write_in": true,
  "battlecard_url": "abc123",
  "rating": 123
}
Types

ResearchType

Description

The opportunity research type.

Values
Enum Value Description

DECISION

EXPERIENCE

RESEARCH
Example
"DECISION"
Types

String

Description

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.

Example
"xyz789"
Types

TextFormat

Description

The text format.

Values
Enum Value Description

HTML

PLAIN_TEXT
Example
"HTML"
Types

Trigger

Description

A trigger question associated with a survey/interview question.

Fields
Field Name Description
trigger_type - String! The type of trigger question.
text - String! The text for the trigger question.
vendor_value - Int The vendor's unique identifier.
vendor - String The name of the vendor.
criterion_value - Int The criterion's unique identifier.
criterion - String The criterion's unique identifier.
response - String! The free form response to the trigger question.
created - Date When the contact was created, returned as YYYY-MM-DD.
Example
{
  "trigger_type": "abc123",
  "text": "abc123",
  "vendor_value": 123,
  "vendor": "xyz789",
  "criterion_value": 987,
  "criterion": "abc123",
  "response": "xyz789",
  "created": "2021-10-07"
}
Types

User

Description

A user for a client organization.

Fields
Field Name Description
id - ID! The user's unique identifier.
first_name - String! The user's first name.
last_name - String! The user's last name.
full_name - String! The user's full name.
email - String! The user's email address.
title - String The user's title.
company - String The user's company.
phone - String The user's phone number.
is_enabled - Boolean! When true, indicates the user is enabled.
created - Date When the user was created, returned as YYYY-MM-DD.
last_login - DateTime The date the user last logged in.
login_count - Int! The total number of times the user has logged in.
sso_enabled - Boolean! When true, indicates SSO (single sign-on) is enabled for the user.
Example
{
  "id": "58af4d9fb310d92314626f9b",
  "first_name": "Jane",
  "last_name": "Smith",
  "full_name": "Jane Smith",
  "email": "[email protected]",
  "title": "abc123",
  "company": "xyz789",
  "phone": "abc123",
  "is_enabled": false,
  "created": "2021-10-07",
  "last_login": "2021-10-07T01:08:03.420Z",
  "login_count": 987,
  "sso_enabled": true
}
Types

Vendor

Description

An evaluated vendor for the decision.

Fields
Field Name Description
id - String The vendor's unique identifier.
value - Int! The unique numeric value for the vendor.
name - String! The name of the vendor.
is_client - Boolean! When true, indicates the vendor is the client.
is_selected - Boolean! When true, indicates the vendor was selected for the decision.
is_strongest - Boolean! When true, indicates the vendor was the strongest amongst all competitors in the decision.
is_write_in - Boolean! When true, indicates the vendor was a write-in.
battlecard_url - String TruVoice URL to the battlecard for the competitor.
Example
{
  "id": "xyz789",
  "value": 987,
  "name": "xyz789",
  "is_client": true,
  "is_selected": false,
  "is_strongest": false,
  "is_write_in": true,
  "battlecard_url": "abc123"
}