Get Account

Query

query {
  accountItem(
    apiKey: String!
    id: String!
  ): AccountItem
}

Parameters

string

required

Your Tellscope API key

string

required

The unique identifier of the account

Response

Returns a single AccountItem or null if not found.

string

Unique identifier

string

Account/company name

string

Primary domain

string

Account description

string

Full website URL

float

Health score (0-1)

float

Churn risk score (0-1)

array

Tags assigned to this account

datetime

When the account was added

Example

query {
  accountItem(
    apiKey: "tellscp_sk_YOUR_API_KEY"
    id: "acc_xyz789"
  ) {
    id
    name
    domain
    description
    website
    score
    churnRisk
    tags
    createdAt
  }
}

{
  "data": {
    "accountItem": {
      "id": "acc_xyz789",
      "name": "TechStart Inc",
      "domain": "techstart.io",
      "description": "Enterprise software company specializing in workflow automation",
      "website": "https://techstart.io",
      "score": 0.85,
      "churnRisk": 0.12,
      "tags": ["enterprise", "annual", "champion"],
      "createdAt": "2023-03-20T08:00:00Z"
    }
  }
}

Understanding the Response

Health Score

The score field represents the overall health of the account based on:

Feedback sentiment trends
Engagement frequency
Support ticket patterns
Feature adoption

Score Range	Status
0.8 - 1.0	Healthy
0.5 - 0.79	Needs attention
0.0 - 0.49	At risk

Churn Risk

The churnRisk field indicates the likelihood of the account churning:

Risk Range	Level
0.0 - 0.2	Low
0.2 - 0.5	Medium
0.5 - 1.0	High

Error Responses

Account Not Found

{
  "data": {
    "accountItem": null
  }
}

Not Authorized

If trying to access an account from another organization:

{
  "errors": [
    {
      "message": "Not authorized to access this account",
      "extensions": {
        "code": "FORBIDDEN"
      }
    }
  ]
}

Overview

Feedback

Contacts

Accounts

Query

Parameters

Response

Example

Understanding the Response

Health Score

Churn Risk

Error Responses

Account Not Found

Not Authorized

​Query

​Parameters

​Response

​Example

​Understanding the Response

​Health Score

​Churn Risk

​Error Responses

​Account Not Found

​Not Authorized

Query

Parameters

Response

Example

Understanding the Response

Health Score

Churn Risk

Error Responses

Account Not Found

Not Authorized