ChurnZero REST API for MarketingPony

Introduction

Sample Reference

Documentation based off of the ChurnZero demo customer, MarketingPony.

Login to view your personalized documentation.

The ChurnZero REST API is an OData v4 implementation that is accessible to developers and tools that know how to interact with OData v4 like Microsoft Excel, Tableau, or Microsoft Power BI. A subset of the query string options defined in OData v4 are available for use to tailor access to the data in your ChurnZero instance. This is a dynamic API that will adjust as customizations are made to your ChurnZero instance and as new features are developed for ChurnZero.

For example, if Zendesk Tickets are synced into ChurnZero, a new API endpoint for those tickets will be exposed and documented below. At some later point, if new fields are imported from those Zendesk Tickets they will become available on the exposed endpoint and documented below. Likewise, if fields are removed from the synced set of data those fields will cease to be available from the ChurnZero REST API.

In addition to instance specific customizations, new features will be added to the API as they become available. The new features, being new endpoints or properties on existing endpoints, will be exposed in an additive fashion.

Visit the Developers Guide to see more examples and to begin using the API.


Configuration

The ChurnZero REST API is an add-on feature that must be enabled and correctly configured with the necessary permissions to be used. If not already enabled, please contact your ChurnZero Customer Success Manager for pricing and feature activation.

User Permissions

The Developer Tools user permission is required to be set on the User Account configured to make requests.

Bulk Read Permissions

Due to the large amounts of data that can be accessed through the REST API, there is a group of Bulk Read Permissions that must be set in order to gain access to the available Entities. The permissions are made up of the following:

  • Bulk Read - Accounts
  • Bulk Read - Contacts
  • Bulk Read - Churn Scores
  • Bulk Read - Events
  • Bulk Read - Surveys
  • Bulk Read - Tasks
  • Bulk Read - UserAccounts
  • Bulk Read - Custom Tables

These permissions are configured for a User Permission Group and affect all users belonging to that group. They are set individually so that access to certain Entities can be controlled on a per-group basis.


Authentication

HTTP Basic Authentication

Given a username of someuser and a password of sup3rS3cr37! the following would be a cURL command manually encoding the header.

curl -X GET "https://app.churnzero.net/public/v1/Account" \
-H "Authorization: Basic c29tZXVzZXI6c3VwM3JTM2NyMzch"

HTTP Basic Authentication can be used with the ChurnZero REST API. To successfully make a request you will need to pass your ChurnZero username and an Api Key associated with your user as an authorization header with each request. To create a new Api Key, navigate to the Admin > Api Keys page. When building a request using Basic Authentication, make sure you add the Authorization header with a value of Basic <username>:<apikey> where <username>:<apikey> has been base64 encoded.


Rate Limiting

Rate limits are applied to a specific ChurnZero instance on a per minute basis. Two thresholds are tracked per minute. The first threshold is a soft max and the second threshold is a hard max. The number of requests under the soft max will execute at normal speed. Any number of requests greater than the soft max but less than the hard max will execute with a progressively longer delay. Requests above the hard max will result in a 429 Too Many Requests response. The intent of the soft and hard max thresholds is to coerce an API client into compliance rather than go to an immediate hard error.

Request Count Response
1 to 100 Normal Response
101 to 200 Delayed Response
greater than 200 429 Too Many Requests


Errors

{
	"error": {
		"code": "403",
		"message": "Forbidden"
	}
}

Errors will follow the standard OData error format as shown below. The code will just be the numeric HTTP Status code as a string, and the message will provide more detail if possible.

Code Meaning Description
400Bad RequestThis usually occurs because of a missing or malformed parameter. Check the documentation and the syntax of your request and try again.
401UnauthorizedA valid authentication token was not provided with the request, so the API could not associate a user with the request.
403ForbiddenThe authentication and request syntax was valid but the server is refusing to complete the request. This can happen if you try to read or write to objects or properties that the user does not have access to.
404Not FoundEither the request method and path supplied do not specify a known action in the API, or the object specified by the request does not exist.
409ConflictThe underlying model/schema has changed. Usually caused by a race condition. Sending the request again will succeed.
429Too Many RequestsYou have exceeded one of the enforced rate limits in the API. See the documentation on rate limiting for more information.
500Internal Server ErrorThere was a problem on ChurnZeros's end.


Query Parameters

Query parameters can control the amount and order of the data returned for the resource identified by the URL.

$filter

All Accounts with a BillingAddressState equal to 'VA'


GET /Account?$filter=BillingAddressState eq 'VA'

All Accounts with a TotalContractAmount greater than 10000


GET /Account?$filter=TotalContractAmount gt 10000

All Accounts that have IsActive equal to true


GET /Account?$filter=IsActive eq true

All Accounts that have a Name that starts with 'A'


GET /Account?$filter=startswith(Name, 'A')

All Accounts that have a ObjectCreatedDate greater than 2020-01-01


GET /Account?$filter=ObjectCreatedDate gt 2020-01-01

All Accounts that have the Custom Field Subscribed equal to true


GET /Account?$filter=Cf/Subscribed eq true

All Accounts with a BillingAddressState equal to 'VA' and a TotalContractAmount greater than 10000


GET /Account?$filter=BillingAddressState eq 'VA' and TotalContractAmount gt 10000

The $filter option allows limiting of resources in the collection that is returned for the requested URL. The filter is evaluated for each resource in the result set and only those resources that evaluated to true for the given filter will be included in the result. The ChurnZero REST API supports a limited set of filters described in the OData spec for filter options.

The operators below can be used with resource properties to produce simple or complex operands. A simple operand would deal with just one property such as BillingAddressState eq 'VA', while a complex operand combines simple operands with the and or or operartors. In a given filter operation, and and or operators cannot be combined. Additionally, there is a limit of 5 and or or operators in a single filter expression.

If the desired filter cannot be constructed with the available simple or complex operands, then ChurnZero Segments must be used.

When building out the filter operands it may be necessary to URL encode the operand. For example, Email eq 'user+1@domain.com' should be encoded as Email eq 'user%2B1@domain.com' or possibly Email%20eq%20%27user%2B1%40domain.com%27.

Query Operator Description
eq The eq operator returns true if the left operand is equal to the right operand, otherwise it returns false.
ne The ne operator returns true if the left operand is not equal to the right operand, otherwise it returns false.
gt The gt operator returns true if the left operand is greater than the right operand, otherwise it returns false.
ge The ge operator returns true if the left operand is greater than or equal to the right operand, otherwise it returns false.
lt The lt operator returns true if the left operand is less than the right operand, otherwise it returns false.
le The le operator returns true if the left operand is less than or equal to the right operand, otherwise it returns false.
and The and operator returns true if both the left and right operands evaluate to true, otherwise it returns false.
or The or operator returns false if both the left and right operands both evaluate to false, otherwise it returns true.
startswith() The startswith function with string parameter values returns true if the first string starts with the second string, otherwise it returns false. String comparison is always case-insenitive. Minimum of 2 characters.
endswith() The endswith function with string parameter values returns true if the first string ends with the second string, otherwise it returns false. String comparison is always case-insenitive. Minimum of 2 characters.
contains() The contains function with string parameter values returns true if the second string is a substring of the first string, otherwise it returns false. String comparison is always case-insenitive. Minimum of 2 characters.

$expand

All Accounts with the related UserAccount embedded inline.


GET /Account?$expand=UserAccount

All Accounts with the related UserAccount and PrimaryChurnScore embedded inline.


GET /Account?$expand=UserAccount,PrimaryChurnScore

All Accounts with all related resources embedded inline.


GET /Account?$expand=*

The $expand option allows related resources to be included in the response inline. For example, an Account references a UserAccount. When querying for Accounts you can include the UserAccount in the response if it is defined. If a particular resource is related to multiple resources, they can all be included by referencing the properties with a comma separated list.

The * option for $expand is a special option that means include all referenced entities.


$select

Select the Id, Name, and ExternalId for all Accounts


GET /Account?$select=Id,Name,ExternalId

Select the Id, Name, and ExternalId for all Accounts and the UserName of related UserAccounts


GET /Account?$select=Id,Name,ExternalId&$expand=UserAccount($select=UserName)

The $select option allows resource results to only include the specified properties. This is useful to tailor response payloads to reduce the amount of data being returned.

$select can be used in conjunction with $expand to tailor the payload for related resources that are inlined with the response.


$orderby

All Accounts ordered by ObjectLastModifiedDate in ascending order.


GET /Account?$orderby=ObjectLastModifiedDate

All Accounts ordered by LicenseCount in descending order, then by ObjectLastModifiedDate in ascending order.


GET /Account?$orderby=LicenseCount desc, ObjectLastModifiedDate asc

The $orderby option allows resources to be sorted in a particular order. Collections that support the $orderby operation will list the available resource properties that can be used for ordering. By default, ascending order is utilized unless the direction is specified with desc for descending sort order. Ascending order can be explicitly specified with asc.


$top and $skip

The top 10 Accounts ordered by ObjectLastModifiedDate


GET /Account?$top=10&$orderby=ObjectLastModifiedDate desc

The top 10 Accounts ordered by ObjectLastModifiedDate, but skip 30 Accounts.


GET /Account?$top=10&$skip=30&$orderby=ObjectLastModifiedDate desc

The $top option requests the number of resources to be queried in the collection. The $skip option requests the number of resources that are to be skipped and not included in the queried collection.


$count

Include the total count of Accounts in the query for the Id,Name, and ExternalId of all Accounts


GET /Account?$seelct=Id,Name,ExternalId&$count=true

{
    "@odata.count": 5043,
    "value": [
        {
            "Id": 22433,
            "ExternalId": "39537",
            "Name": "Abbott, Little and Stehr"
        },
        {
            "Id": 21389,
            "ExternalId": "61874",
            "Name": "Abbott, Reinger and Barrows"
        },
        ...
    ]
}

The $count option indicates that the collection response should include the overall count of resources in the collection. This count will take into account all the provided query options. Most notably, anything specified via $filter will affect the count returned.

The count property will reside at the same level as the values property and will have a key of @odata.count.


Segments

Discovering a Segment id (6763) from the URL within the ChurnZero application


https://app.churnzero.net/#/app/segment/edit/account/6763/b71bd622-dead-d606-0287-c068c79d6dc0

Retrieving All available Account Segments via the API


GET /Segment?$filter=Entity eq 'Account'

{
    "@odata.context": "https://app.churnzero.net/public/v1/$metadata#Segment",
    "value": [
        {
            "Id": 6763,
            "Entity": "Account",
            "IsGlobal": true,
            "Name": "All Accounts",
            "ObjectCreatedDate": "2018-10-14T01:38:36.7303441Z",
            "ObjectLastModifiedDate": "2020-09-03T14:56:56.0475134Z"
        },
        {
            "Id": 9943,
            "Entity": "Account",
            "IsGlobal": true,
            "Name": "Inactive Accounts",
            "ObjectCreatedDate": "2018-10-14T01:40:51.4381083Z",
            "ObjectLastModifiedDate": "2020-09-03T15:51:30.6379653Z"
        },
        ...
    ],
    "@odata.nextLink": "https://app.churnzero.net/public/v1/Segment?$skip=100"
}

Using a Segment id to retrieve All Accounts that meet the segment criteria for id 6763


GET /Account?$filter=Use/SegmentId eq 6763

Using a predefined Segment in the ChurnZero REST API is achieved by utilizing the Segment id in a $filter option on an entity that supports Segments. These are limited to Account, Contact, Event, and Custom Tables (examples: Zendesk Tickets, Salesforce Opportunities, Intercom Conversations). Specific Segment ids to use can be discovered either from inside the ChurnZero app or by making a request to the Segment endpoint.

Constraints

  • The entity must support Segments (see above).
  • The Segment must exist.
  • The Segment must belong to the entity in the request.
  • The segment filter operator must be 'eq'.
  • The Segment must belong to the authorized API User or be configured as a Global Segment.
  • All filters used in conjunction with Segments must use the 'and' operator.


Column Sets

Retrieving All available Account SegmentColumnSets via the API


GET /SegmentColumnSet?$filter=Entity eq 'Account'

Response:

{
    "@odata.context": "https://app.churnzero.net/public/v1/$metadata#SegmentColumnSet",
    "value": [
        {
            "Id": 25,
            "Entity": "Account",
            "Name": "Account Journeys and ChurnScoreHistory",
            "ObjectCreatedDate": "2020-12-09T21:37:06.5522053Z",
            "ObjectLastModifiedDate": "2020-12-10T15:08:37.3075938Z",
            "ShareType": "All",
            "UserAccountId": 1220,
            "UserAccount@odata.navigationLink": "https://app.churnzero.net/public/v1/SegmentColumnSet(25)/UserAccount"
        },
        {
            "Id": 16,
            "Entity": "Account",
            "Name": "Account Roles",
            "ObjectCreatedDate": "2020-12-03T15:31:42.7877055Z",
            "ObjectLastModifiedDate": "2020-12-09T20:01:09.7805178Z",
            "ShareType": "All",
            "UserAccountId": 1220,
            "UserAccount@odata.navigationLink": "https://app.churnzero.net/public/v1/SegmentColumnSet(16)/UserAccount"
        }
    ],
    "@odata.nextLink": "https://app.churnzero.net/public/v1/SegmentColumnSet?$skip=100"
}

Retrieve All Accounts and return only the fields configured for Segment Column Set id 25


GET /Account?$filter=Use/SegmentColumnSetId eq 25

Retrieve All Active Accounts and return only the fields configured for Segment Column Set id 25


GET /Account?$filter=IsActive eq true and Use/SegmentColumnSetId eq 25

Retrieve All Accounts for a defined Segment and return only the fields configured for Segment Column Set id 25


GET /Account?$filter=Use/SegmentId eq 6763 and Use/SegmentColumnSetId eq 25

Retrieve All Accounts for a defined Segment and return the fields configured for Segment Column Set id 25 along with Account Name


GET /Account?$select=Name&$filter=Use/SegmentId eq 6763 and Use/SegmentColumnSetId eq 25

Similar to using a Segment, using a predefined Segment Column Set in the ChurnZero REST API is achieved by utilizing the Segment Column Set id in a $filter option on an entity that supports Segments. These are limited to Account, Contact, Event, and Custom Table entities and can be discovered by making a request to the SegmentColumnSet endpoint.

When using a Column Set, the properties returned in the response are dynamic and determined by the fields configured on the Column Set in the ChurnZero application. These properties are automatically added to $select/$expand options where applicable.

For Column Set fields that do not have corresponding properties on the entity being returned, new dynamic properties will be returned under RelatedAttributes and/or RelatedAggregates properties accordingly.

Constraints

  • The entity must support Segments (see above).
  • The SegmentColumnSet must exist.
  • The SegmentColumnSet must belong to the entity in the request.
  • The SegmentColumnSet filter operator must be 'eq'.
  • The SegmentColumnSet must belong to the authorized API User or have a configured ShareType of 'All' or 'Domain'.
  • Any filters used in conjunction with the SegmentColumnSet must use the 'and' operator.


Pagination

The @odata.nextLink provides the URL to retrieve the next page of results.


GET /Account?$select=Id,Name

{
    "@odata.context": "https://app.churnzero.net//public/v1/$metadata#Account(Id,Name)",
    "value": [
        {
            "Id": 25024,
            "Name": "Auer LLC"
        },
        {
            "Id": 23908,
            "Name": "Auer, DuBuque and Wunsch"
        },
        ...
    ],
    "@odata.nextLink": "https://app.churnzero.net//public/v1/Account?$select=Id%2CName&$skip=100"
}

Using the provided @odata.nextLink the next page can be retrieved and a new newLink will be provided.


GET /Account?$select=Id,Name&$skip=100

{
    "@odata.context": "https://app.churnzero.net//public/v1/$metadata#Account(Id,Name)",
    "value": [
        {
            "Id": 22323,
            "Name": "Bahringer, Hessel and Schmitt"
        },
        {
            "Id": 25088,
            "Name": "Bahringer-Cruickshank"
        },
        ...
    ],
    "@odata.nextLink": "https://app.churnzero.net//public/v1/Account?$select=Id%2CName&$skip=200"
}

When there are no more results, an empty result set will be returned.


GET /Account?$select=Id,Name&$skip=6000

{
    "@odata.context": "https://app.churnzero.net//public/v1/$metadata#Account(Id,Name)",
    "value": []
}

The page size for all collection requests is 100 results. All resources of the collection can be addressed by using $skip as defined in the provided @odata.nextLink property. The end of the collection will be signified by a response with an empty result set.

If a different page size is desired, the $top operation can be used in conjunction with $skip. In the case of using $top, there will no provided @odata.nextLink property in the response. Instead, it will be incumbent on the caller to continue to increase $skip by the desired amount until an empty result set is observed.


Data Types

The following tables list some common data types supported by the ChurnZero REST API.

Inputs

Data Type Description Usage
string Text $filter=BillingAddressCity eq 'Baltimore'
string(date-time) DateTime formatted as ISO 8601 UTC $filter=ObjectCreatedDate gt 2020-04-10T18:21:23.1193978Z
string(date) Date formatted as yyyy-MM-dd $filter=CalculationDay gt 2020-07-01
string(picklist) A single string value that belongs to a picklist $filter=TicketStatus eq 'New'
integer(int32) Represents a 32-bit signed integer $filter=LicenseCount gt 400
integer(int64) Represents a 64-bit signed integer (used for internal identifiers) $filter=AccountId eq 32456678985
number A Positive or negative number with or without decimals $filter=TotalContractAmount gt 1000.0
boolean True/False $filter=IsActive eq true
array[string] An array of string values $orderby=ObjectCreatedDate,Name

Outputs

Data Type Description Example
string Text 'Baltimore'
string(date-time) DateTime formatted as ISO 8601 UTC 2020-04-10T18:21:23.1193978Z
string(date) Date formatted as yyyy-MM-dd 2020-07-01
string(picklist) A single string value that belongs to a picklist 'New'
integer(int32) Represents a 32-bit signed integer 3245
integer(int64) Represents a 64-bit signed integer (used for internal identifiers) 32456678985
number A Positive or negative number with or without decimals 1000.0
boolean True/False true
array[string] An array of string values [ "Another Tag", "My First Tag" ]


API Reference

Scroll down for code samples, example requests and responses.

This is the interface for interacting with the ChurnZero Platform. Our API reference is generated from our OpenAPI spec.


Account

Account available in ChurnZero.

Permissions

Bulk Read - Accounts


Get all Accounts

GET /Account

Code samples

curl -X GET "https://app.churnzero.net/public/v1/Account" \
-H "Authorization: Basic c29tZXVzZXI6c3VwM3JTM2NyMzch"

200 response

{
  "value": [
    {
      "Id": 8,
      "BillingAddressCity": "string",
      "BillingAddressCountry": "string",
      "BillingAddressLine1": "string",
      "BillingAddressLine2": "string",
      "BillingAddressState": "string",
      "BillingAddressZip": "string",
      "Cf": {
        "SupportOwnerId": 15,
        "ProductEdition": "string",
        "Emailcredits": 7.23,
        "AtRisk": true,
        "UpsellAmount": 5.0,
        "CustomerSentiment": "string",
        "SentimentLastUpdated": "2021-05-11",
        "ExecutiveSponsorHasLeft": true,
        "Industry": "string",
        "KpisMet": true,
        "Valuescore": 4.56,
        "Cstier": "string",
        "Elpmodel": "string",
        "EmailCreditsPurchased": 9.13,
        "GoLiveDate": "2021-05-11",
        "Lifecyclestage": "string",
        "OnboardingObjective": "string",
        "TrainingConfigurationNotes": "string",
        "EngagementScore": 9.11,
        "N30DayTimeSpent": 3.64,
        "TrainingConfigurationKpisMet": true,
        "SalesforceIntegration": true,
        "TwitterOauth": false,
        "CustomerFit110": 9.04,
        "CustomFitExplanation": "string",
        "Testpicklist": "string",
        "Outcomes": "string",
        "OverallColor": "string",
        "CustomerObjectives": "string",
        "CurrentSalesVolume": 0.99,
        "ToGoal": 4.94,
        "NumberOfProjects": 4.13,
        "ProjectEffort": "string",
        "ProjectImpact": "string",
        "BlogsPublishedLast7": 9.75,
        "WeeklyBlogsLimit": 9.86,
        "BlogsRemaining": 1.23,
        "NotesLastUpdated": "2021-05-11",
        "CompetitorsUsed": "string",
        "Employee": 5.02,
        "LicensesPurchased": 1.64,
        "AccountPenetration": 7.37,
        "ChurnReason": "string",
        "FeatureUse2": "string",
        "FeatureUse1": "string",
        "FeatureTurnedOn": "string",
        "Covid19IndustryRisk": "string",
        "Covid19CustomerNotes": "string",
        "Covid19Tier": "string",
        "SalesProductFit": "string",
        "SalesExpectations": "string",
        "SalesHandoverNotes": "string",
        "PartnerFit": "string",
        "PartnerCommunicationCadence": "string",
        "NumberOfSupportTicketsOverdue": "string",
        "NumberOfSupportEscalationslastMonth": "string",
        "WasTheCustomerAcquired": "string",
        "WasBudgetCut": "string",
        "DoWeHaveMultipleChampions": "string",
        "DidWeLoseAChampionThatHasNotBeenReplaced": "string",
        "Last90DaysNps": "string",
        "Last90DaysCsat": "string",
        "TotalPurchasedHoursForCurrentQuarter": "string",
        "TotalHoursUsed": "string",
        "FeatureRequests": "string",
        "Csm": "string",
        "SalesforceAccountOwner": "string",
        "SalesforceRegion": "string",
        "AdvId": "string",
        "AdSpendTotalLast30Days": 7.83,
        "ContractMinimum": 1.47,
        "BillingPeriodsInContractPerYear": "string",
        "ToContractMin": 8.81
      },
      "ContactsCount": 16,
      "CrmId": "string",
      "EndDate": "2021-05-11T16:38:27.7138801Z",
      "ExternalId": "string",
      "IsActive": true,
      "LicenseCount": 26,
      "Name": "string",
      "NextRenewalDate": "2021-05-11T16:38:27.7138801Z",
      "ObjectCreatedDate": "2021-05-11T16:38:27.7138801Z",
      "ObjectLastModifiedDate": "2021-05-11T16:38:27.7138801Z",
      "ParentAccountId": 29,
      "ParentNextRenewalDate": "2021-05-11T16:38:27.7138801Z",
      "ParentTotalContractAmount": 9.8,
      "PrimaryChurnScoreId": 9,
      "PrimaryChurnScoreValue": 8.95,
      "StartDate": "2021-05-11T16:38:27.7138801Z",
      "Tags": "string",
      "TenureInDays": 28,
      "TotalContractAmount": 1.22,
      "UsageFrequency": "string",
      "UserAccountId": 9,
      "PrimaryChurnScore@odata.navigationLink": "https://app.churnzero.net/public/v1/Account(8)/PrimaryChurnScore",
      "ParentAccount@odata.navigationLink": "https://app.churnzero.net/public/v1/Account(8)/ParentAccount",
      "UserAccount@odata.navigationLink": "https://app.churnzero.net/public/v1/Account(8)/UserAccount"
    }
  ],
  "@odata.nextLink": "https://app.churnzero.net/public/v1/Account?$skip=100"
}
Parameters
Name Description
?$filter array[string]

Filter items by property values

Name, NextRenewalDate, ParentNextRenewalDate, TotalContractAmount, ParentTotalContractAmount, BillingAddressLine1, BillingAddressLine2, BillingAddressCity, BillingAddressState, BillingAddressZip, BillingAddressCountry, StartDate, EndDate, LicenseCount, TenureInDays, PrimaryChurnScoreValue, ContactsCount, ObjectCreatedDate, ObjectLastModifiedDate, ExternalId, CrmId, UserAccountId, ParentAccountId, PrimaryChurnScoreId, IsActive, Cf/SupportOwnerId, Cf/ProductEdition, Cf/Emailcredits, Cf/AtRisk, Cf/UpsellAmount, Cf/CustomerSentiment, Cf/SentimentLastUpdated, Cf/ExecutiveSponsorHasLeft, Cf/Industry, Cf/KpisMet, Cf/Valuescore, Cf/Cstier, Cf/Elpmodel, Cf/EmailCreditsPurchased, Cf/GoLiveDate, Cf/EngagementScore, Cf/TrainingConfigurationKpisMet, Cf/SalesforceIntegration, Cf/TwitterOauth, Cf/CustomerFit110, Cf/Testpicklist, Cf/Outcomes, Cf/OverallColor, Cf/CurrentSalesVolume, Cf/ToGoal, Cf/NumberOfProjects, Cf/WeeklyBlogsLimit, Cf/NotesLastUpdated, Cf/Employee, Cf/Covid19IndustryRisk, Cf/Covid19Tier, Cf/SalesProductFit, Cf/SalesExpectations, Cf/SalesHandoverNotes, Cf/PartnerFit, Cf/PartnerCommunicationCadence, Cf/NumberOfSupportTicketsOverdue, Cf/NumberOfSupportEscalationslastMonth, Cf/WasTheCustomerAcquired, Cf/WasBudgetCut, Cf/DoWeHaveMultipleChampions, Cf/DidWeLoseAChampionThatHasNotBeenReplaced, Cf/Last90DaysNps, Cf/Last90DaysCsat, Cf/TotalPurchasedHoursForCurrentQuarter, Cf/TotalHoursUsed, Cf/FeatureRequests, Cf/Csm, Cf/SalesforceAccountOwner, Cf/SalesforceRegion, Cf/AdvId, Cf/ContractMinimum, Cf/BillingPeriodsInContractPerYear, Use/SegmentId, Use/SegmentColumnSetId
↓ Show Options ↓↑ Hide Options ↑
?$orderby array[string]

Order items by property values

Name, NextRenewalDate, ParentNextRenewalDate, TotalContractAmount, ParentTotalContractAmount, BillingAddressLine1, BillingAddressLine2, BillingAddressCity, BillingAddressState, BillingAddressZip, BillingAddressCountry, StartDate, EndDate, LicenseCount, TenureInDays, PrimaryChurnScoreValue, ContactsCount, ObjectCreatedDate, ObjectLastModifiedDate, Cf/ProductEdition, Cf/Emailcredits, Cf/AtRisk, Cf/UpsellAmount, Cf/CustomerSentiment, Cf/SentimentLastUpdated, Cf/ExecutiveSponsorHasLeft, Cf/Industry, Cf/KpisMet, Cf/Valuescore, Cf/Cstier, Cf/Elpmodel, Cf/EmailCreditsPurchased, Cf/GoLiveDate, Cf/EngagementScore, Cf/TrainingConfigurationKpisMet, Cf/SalesforceIntegration, Cf/TwitterOauth, Cf/CustomerFit110, Cf/Testpicklist, Cf/Outcomes, Cf/OverallColor, Cf/CurrentSalesVolume, Cf/ToGoal, Cf/NumberOfProjects, Cf/WeeklyBlogsLimit, Cf/NotesLastUpdated, Cf/Employee, Cf/Covid19IndustryRisk, Cf/Covid19Tier, Cf/SalesProductFit, Cf/SalesExpectations, Cf/SalesHandoverNotes, Cf/PartnerFit, Cf/PartnerCommunicationCadence, Cf/NumberOfSupportTicketsOverdue, Cf/NumberOfSupportEscalationslastMonth, Cf/WasTheCustomerAcquired, Cf/WasBudgetCut, Cf/DoWeHaveMultipleChampions, Cf/DidWeLoseAChampionThatHasNotBeenReplaced, Cf/Last90DaysNps, Cf/Last90DaysCsat, Cf/TotalPurchasedHoursForCurrentQuarter, Cf/TotalHoursUsed, Cf/FeatureRequests, Cf/Csm, Cf/SalesforceAccountOwner, Cf/SalesforceRegion, Cf/AdvId, Cf/ContractMinimum, Cf/BillingPeriodsInContractPerYear
↓ Show Options ↓↑ Hide Options ↑
?$select array[string]

Select properties to be returned

Id, Name, UserAccountId, NextRenewalDate, ParentNextRenewalDate, TotalContractAmount, ParentTotalContractAmount, IsActive, ExternalId, BillingAddressLine1, BillingAddressLine2, BillingAddressCity, BillingAddressState, BillingAddressZip, BillingAddressCountry, StartDate, EndDate, LicenseCount, CrmId, TenureInDays, PrimaryChurnScoreId, PrimaryChurnScoreValue, UsageFrequency, ContactsCount, ParentAccountId, Tags, ObjectCreatedDate, ObjectLastModifiedDate, Cf/SupportOwnerId, Cf/ProductEdition, Cf/Emailcredits, Cf/AtRisk, Cf/UpsellAmount, Cf/CustomerSentiment, Cf/SentimentLastUpdated, Cf/ExecutiveSponsorHasLeft, Cf/Industry, Cf/KpisMet, Cf/Valuescore, Cf/Cstier, Cf/Elpmodel, Cf/EmailCreditsPurchased, Cf/GoLiveDate, Cf/Lifecyclestage, Cf/OnboardingObjective, Cf/TrainingConfigurationNotes, Cf/EngagementScore, Cf/N30DayTimeSpent, Cf/TrainingConfigurationKpisMet, Cf/SalesforceIntegration, Cf/TwitterOauth, Cf/CustomerFit110, Cf/CustomFitExplanation, Cf/Testpicklist, Cf/Outcomes, Cf/OverallColor, Cf/CustomerObjectives, Cf/CurrentSalesVolume, Cf/ToGoal, Cf/NumberOfProjects, Cf/ProjectEffort, Cf/ProjectImpact, Cf/BlogsPublishedLast7, Cf/WeeklyBlogsLimit, Cf/BlogsRemaining, Cf/NotesLastUpdated, Cf/CompetitorsUsed, Cf/Employee, Cf/LicensesPurchased, Cf/AccountPenetration, Cf/ChurnReason, Cf/FeatureUse2, Cf/FeatureUse1, Cf/FeatureTurnedOn, Cf/Covid19IndustryRisk, Cf/Covid19CustomerNotes, Cf/Covid19Tier, Cf/SalesProductFit, Cf/SalesExpectations, Cf/SalesHandoverNotes, Cf/PartnerFit, Cf/PartnerCommunicationCadence, Cf/NumberOfSupportTicketsOverdue, Cf/NumberOfSupportEscalationslastMonth, Cf/WasTheCustomerAcquired, Cf/WasBudgetCut, Cf/DoWeHaveMultipleChampions, Cf/DidWeLoseAChampionThatHasNotBeenReplaced, Cf/Last90DaysNps, Cf/Last90DaysCsat, Cf/TotalPurchasedHoursForCurrentQuarter, Cf/TotalHoursUsed, Cf/FeatureRequests, Cf/Csm, Cf/SalesforceAccountOwner, Cf/SalesforceRegion, Cf/AdvId, Cf/AdSpendTotalLast30Days, Cf/ContractMinimum, Cf/BillingPeriodsInContractPerYear, Cf/ToContractMin
↓ Show Options ↓↑ Hide Options ↑
?$expand array[string]

Expand related entities

*, PrimaryChurnScore, ParentAccount, UserAccount
↓ Show Options ↓↑ Hide Options ↑
?$top integer(int32)

Show only the first n items

?$skip integer(int32)

Skip the first n items

?$count boolean

Include count of items

Responses
Status Description
200 array[Account]

Retrieved entities

400 Error

Bad Request

401 Error

Unauthorized

403 Error

Forbidden

409 Error

Conflict

429 Error

Too Many Requests

500 Error

Internal Server Error


Get an Account

GET /Account({Id})

Code samples

curl -X GET "https://app.churnzero.net/public/v1/Account(8)" \
-H "Authorization: Basic c29tZXVzZXI6c3VwM3JTM2NyMzch"

200 response

{
  "Id": 8,
  "BillingAddressCity": "string",
  "BillingAddressCountry": "string",
  "BillingAddressLine1": "string",
  "BillingAddressLine2": "string",
  "BillingAddressState": "string",
  "BillingAddressZip": "string",
  "Cf": {
    "SupportOwnerId": 15,
    "ProductEdition": "string",
    "Emailcredits": 7.23,
    "AtRisk": true,
    "UpsellAmount": 5.0,
    "CustomerSentiment": "string",
    "SentimentLastUpdated": "2021-05-11",
    "ExecutiveSponsorHasLeft": true,
    "Industry": "string",
    "KpisMet": true,
    "Valuescore": 4.56,
    "Cstier": "string",
    "Elpmodel": "string",
    "EmailCreditsPurchased": 9.13,
    "GoLiveDate": "2021-05-11",
    "Lifecyclestage": "string",
    "OnboardingObjective": "string",
    "TrainingConfigurationNotes": "string",
    "EngagementScore": 9.11,
    "N30DayTimeSpent": 3.64,
    "TrainingConfigurationKpisMet": true,
    "SalesforceIntegration": true,
    "TwitterOauth": false,
    "CustomerFit110": 9.04,
    "CustomFitExplanation": "string",
    "Testpicklist": "string",
    "Outcomes": "string",
    "OverallColor": "string",
    "CustomerObjectives": "string",
    "CurrentSalesVolume": 0.99,
    "ToGoal": 4.94,
    "NumberOfProjects": 4.13,
    "ProjectEffort": "string",
    "ProjectImpact": "string",
    "BlogsPublishedLast7": 9.75,
    "WeeklyBlogsLimit": 9.86,
    "BlogsRemaining": 1.23,
    "NotesLastUpdated": "2021-05-11",
    "CompetitorsUsed": "string",
    "Employee": 5.02,
    "LicensesPurchased": 1.64,
    "AccountPenetration": 7.37,
    "ChurnReason": "string",
    "FeatureUse2": "string",
    "FeatureUse1": "string",
    "FeatureTurnedOn": "string",
    "Covid19IndustryRisk": "string",
    "Covid19CustomerNotes": "string",
    "Covid19Tier": "string",
    "SalesProductFit": "string",
    "SalesExpectations": "string",
    "SalesHandoverNotes": "string",
    "PartnerFit": "string",
    "PartnerCommunicationCadence": "string",
    "NumberOfSupportTicketsOverdue": "string",
    "NumberOfSupportEscalationslastMonth": "string",
    "WasTheCustomerAcquired": "string",
    "WasBudgetCut": "string",
    "DoWeHaveMultipleChampions": "string",
    "DidWeLoseAChampionThatHasNotBeenReplaced": "string",
    "Last90DaysNps": "string",
    "Last90DaysCsat": "string",
    "TotalPurchasedHoursForCurrentQuarter": "string",
    "TotalHoursUsed": "string",
    "FeatureRequests": "string",
    "Csm": "string",
    "SalesforceAccountOwner": "string",
    "SalesforceRegion": "string",
    "AdvId": "string",
    "AdSpendTotalLast30Days": 7.83,
    "ContractMinimum": 1.47,
    "BillingPeriodsInContractPerYear": "string",
    "ToContractMin": 8.81
  },
  "ContactsCount": 16,
  "CrmId": "string",
  "EndDate": "2021-05-11T16:38:27.7138801Z",
  "ExternalId": "string",
  "IsActive": true,
  "LicenseCount": 26,
  "Name": "string",
  "NextRenewalDate": "2021-05-11T16:38:27.7138801Z",
  "ObjectCreatedDate": "2021-05-11T16:38:27.7138801Z",
  "ObjectLastModifiedDate": "2021-05-11T16:38:27.7138801Z",
  "ParentAccountId": 29,
  "ParentNextRenewalDate": "2021-05-11T16:38:27.7138801Z",
  "ParentTotalContractAmount": 9.8,
  "PrimaryChurnScoreId": 9,
  "PrimaryChurnScoreValue": 8.95,
  "StartDate": "2021-05-11T16:38:27.7138801Z",
  "Tags": "string",
  "TenureInDays": 28,
  "TotalContractAmount": 1.22,
  "UsageFrequency": "string",
  "UserAccountId": 9,
  "PrimaryChurnScore@odata.navigationLink": "https://app.churnzero.net/public/v1/Account(8)/PrimaryChurnScore",
  "ParentAccount@odata.navigationLink": "https://app.churnzero.net/public/v1/Account(8)/ParentAccount",
  "UserAccount@odata.navigationLink": "https://app.churnzero.net/public/v1/Account(8)/UserAccount"
}
Parameters
Name Description
Id integer(int64)

Id of the Account

?$select array[string]

Select properties to be returned

Id, Name, UserAccountId, NextRenewalDate, ParentNextRenewalDate, TotalContractAmount, ParentTotalContractAmount, IsActive, ExternalId, BillingAddressLine1, BillingAddressLine2, BillingAddressCity, BillingAddressState, BillingAddressZip, BillingAddressCountry, StartDate, EndDate, LicenseCount, CrmId, TenureInDays, PrimaryChurnScoreId, PrimaryChurnScoreValue, UsageFrequency, ContactsCount, ParentAccountId, Tags, ObjectCreatedDate, ObjectLastModifiedDate, Cf/SupportOwnerId, Cf/ProductEdition, Cf/Emailcredits, Cf/AtRisk, Cf/UpsellAmount, Cf/CustomerSentiment, Cf/SentimentLastUpdated, Cf/ExecutiveSponsorHasLeft, Cf/Industry, Cf/KpisMet, Cf/Valuescore, Cf/Cstier, Cf/Elpmodel, Cf/EmailCreditsPurchased, Cf/GoLiveDate, Cf/Lifecyclestage, Cf/OnboardingObjective, Cf/TrainingConfigurationNotes, Cf/EngagementScore, Cf/N30DayTimeSpent, Cf/TrainingConfigurationKpisMet, Cf/SalesforceIntegration, Cf/TwitterOauth, Cf/CustomerFit110, Cf/CustomFitExplanation, Cf/Testpicklist, Cf/Outcomes, Cf/OverallColor, Cf/CustomerObjectives, Cf/CurrentSalesVolume, Cf/ToGoal, Cf/NumberOfProjects, Cf/ProjectEffort, Cf/ProjectImpact, Cf/BlogsPublishedLast7, Cf/WeeklyBlogsLimit, Cf/BlogsRemaining, Cf/NotesLastUpdated, Cf/CompetitorsUsed, Cf/Employee, Cf/LicensesPurchased, Cf/AccountPenetration, Cf/ChurnReason, Cf/FeatureUse2, Cf/FeatureUse1, Cf/FeatureTurnedOn, Cf/Covid19IndustryRisk, Cf/Covid19CustomerNotes, Cf/Covid19Tier, Cf/SalesProductFit, Cf/SalesExpectations, Cf/SalesHandoverNotes, Cf/PartnerFit, Cf/PartnerCommunicationCadence, Cf/NumberOfSupportTicketsOverdue, Cf/NumberOfSupportEscalationslastMonth, Cf/WasTheCustomerAcquired, Cf/WasBudgetCut, Cf/DoWeHaveMultipleChampions, Cf/DidWeLoseAChampionThatHasNotBeenReplaced, Cf/Last90DaysNps, Cf/Last90DaysCsat, Cf/TotalPurchasedHoursForCurrentQuarter, Cf/TotalHoursUsed, Cf/FeatureRequests, Cf/Csm, Cf/SalesforceAccountOwner, Cf/SalesforceRegion, Cf/AdvId, Cf/AdSpendTotalLast30Days, Cf/ContractMinimum, Cf/BillingPeriodsInContractPerYear, Cf/ToContractMin
↓ Show Options ↓↑ Hide Options ↑
?$expand array[string]

Expand related entities

*, PrimaryChurnScore, ParentAccount, UserAccount
↓ Show Options ↓↑ Hide Options ↑
Responses
Status Description
200 Account

Retrieved entity

400 Error

Bad Request

401 Error

Unauthorized

403 Error

Forbidden

404 Error

Not Found

409 Error

Conflict

429 Error

Too Many Requests

500 Error

Internal Server Error


Get the ParentAccount

GET /Account({Id})/ParentAccount

Code samples

curl -X GET "https://app.churnzero.net/public/v1/Account(8)/ParentAccount" \
-H "Authorization: Basic c29tZXVzZXI6c3VwM3JTM2NyMzch"

200 response

{
  "Id": 8,
  "BillingAddressCity": "string",
  "BillingAddressCountry": "string",
  "BillingAddressLine1": "string",
  "BillingAddressLine2": "string",
  "BillingAddressState": "string",
  "BillingAddressZip": "string",
  "Cf": {
    "SupportOwnerId": 15,
    "ProductEdition": "string",
    "Emailcredits": 7.23,
    "AtRisk": true,
    "UpsellAmount": 5.0,
    "CustomerSentiment": "string",
    "SentimentLastUpdated": "2021-05-11",
    "ExecutiveSponsorHasLeft": true,
    "Industry": "string",
    "KpisMet": true,
    "Valuescore": 4.56,
    "Cstier": "string",
    "Elpmodel": "string",
    "EmailCreditsPurchased": 9.13,
    "GoLiveDate": "2021-05-11",
    "Lifecyclestage": "string",
    "OnboardingObjective": "string",
    "TrainingConfigurationNotes": "string",
    "EngagementScore": 9.11,
    "N30DayTimeSpent": 3.64,
    "TrainingConfigurationKpisMet": true,
    "SalesforceIntegration": true,
    "TwitterOauth": false,
    "CustomerFit110": 9.04,
    "CustomFitExplanation": "string",
    "Testpicklist": "string",
    "Outcomes": "string",
    "OverallColor": "string",
    "CustomerObjectives": "string",
    "CurrentSalesVolume": 0.99,
    "ToGoal": 4.94,
    "NumberOfProjects": 4.13,
    "ProjectEffort": "string",
    "ProjectImpact": "string",
    "BlogsPublishedLast7": 9.75,
    "WeeklyBlogsLimit": 9.86,
    "BlogsRemaining": 1.23,
    "NotesLastUpdated": "2021-05-11",
    "CompetitorsUsed": "string",
    "Employee": 5.02,
    "LicensesPurchased": 1.64,
    "AccountPenetration": 7.37,
    "ChurnReason": "string",
    "FeatureUse2": "string",
    "FeatureUse1": "string",
    "FeatureTurnedOn": "string",
    "Covid19IndustryRisk": "string",
    "Covid19CustomerNotes": "string",
    "Covid19Tier": "string",
    "SalesProductFit": "string",
    "SalesExpectations": "string",
    "SalesHandoverNotes": "string",
    "PartnerFit": "string",
    "PartnerCommunicationCadence": "string",
    "NumberOfSupportTicketsOverdue": "string",
    "NumberOfSupportEscalationslastMonth": "string",
    "WasTheCustomerAcquired": "string",
    "WasBudgetCut": "string",
    "DoWeHaveMultipleChampions": "string",
    "DidWeLoseAChampionThatHasNotBeenReplaced": "string",
    "Last90DaysNps": "string",
    "Last90DaysCsat": "string",
    "TotalPurchasedHoursForCurrentQuarter": "string",
    "TotalHoursUsed": "string",
    "FeatureRequests": "string",
    "Csm": "string",
    "SalesforceAccountOwner": "string",
    "SalesforceRegion": "string",
    "AdvId": "string",
    "AdSpendTotalLast30Days": 7.83,
    "ContractMinimum": 1.47,
    "BillingPeriodsInContractPerYear": "string",
    "ToContractMin": 8.81
  },
  "ContactsCount": 16,
  "CrmId": "string",
  "EndDate": "2021-05-11T16:38:27.7138801Z",
  "ExternalId": "string",
  "IsActive": true,
  "LicenseCount": 26,
  "Name": "string",
  "NextRenewalDate": "2021-05-11T16:38:27.7138801Z",
  "ObjectCreatedDate": "2021-05-11T16:38:27.7138801Z",
  "ObjectLastModifiedDate": "2021-05-11T16:38:27.7138801Z",
  "ParentAccountId": 29,
  "ParentNextRenewalDate": "2021-05-11T16:38:27.7138801Z",
  "ParentTotalContractAmount": 9.8,
  "PrimaryChurnScoreId": 9,
  "PrimaryChurnScoreValue": 8.95,
  "StartDate": "2021-05-11T16:38:27.7138801Z",
  "Tags": "string",
  "TenureInDays": 28,
  "TotalContractAmount": 1.22,
  "UsageFrequency": "string",
  "UserAccountId": 9,
  "PrimaryChurnScore@odata.navigationLink": "https://app.churnzero.net/public/v1/Account(8)/PrimaryChurnScore",
  "ParentAccount@odata.navigationLink": "https://app.churnzero.net/public/v1/Account(8)/ParentAccount",
  "UserAccount@odata.navigationLink": "https://app.churnzero.net/public/v1/Account(8)/UserAccount"
}
Parameters
Name Description
Id integer(int64)

Id of the Account

?$select array[string]

Select properties to be returned

Id, Name, UserAccountId, NextRenewalDate, ParentNextRenewalDate, TotalContractAmount, ParentTotalContractAmount, IsActive, ExternalId, BillingAddressLine1, BillingAddressLine2, BillingAddressCity, BillingAddressState, BillingAddressZip, BillingAddressCountry, StartDate, EndDate, LicenseCount, CrmId, TenureInDays, PrimaryChurnScoreId, PrimaryChurnScoreValue, UsageFrequency, ContactsCount, ParentAccountId, Tags, ObjectCreatedDate, ObjectLastModifiedDate, Cf/SupportOwnerId, Cf/ProductEdition, Cf/Emailcredits, Cf/AtRisk, Cf/UpsellAmount, Cf/CustomerSentiment, Cf/SentimentLastUpdated, Cf/ExecutiveSponsorHasLeft, Cf/Industry, Cf/KpisMet, Cf/Valuescore, Cf/Cstier, Cf/Elpmodel, Cf/EmailCreditsPurchased, Cf/GoLiveDate, Cf/Lifecyclestage, Cf/OnboardingObjective, Cf/TrainingConfigurationNotes, Cf/EngagementScore, Cf/N30DayTimeSpent, Cf/TrainingConfigurationKpisMet, Cf/SalesforceIntegration, Cf/TwitterOauth, Cf/CustomerFit110, Cf/CustomFitExplanation, Cf/Testpicklist, Cf/Outcomes, Cf/OverallColor, Cf/CustomerObjectives, Cf/CurrentSalesVolume, Cf/ToGoal, Cf/NumberOfProjects, Cf/ProjectEffort, Cf/ProjectImpact, Cf/BlogsPublishedLast7, Cf/WeeklyBlogsLimit, Cf/BlogsRemaining, Cf/NotesLastUpdated, Cf/CompetitorsUsed, Cf/Employee, Cf/LicensesPurchased, Cf/AccountPenetration, Cf/ChurnReason, Cf/FeatureUse2, Cf/FeatureUse1, Cf/FeatureTurnedOn, Cf/Covid19IndustryRisk, Cf/Covid19CustomerNotes, Cf/Covid19Tier, Cf/SalesProductFit, Cf/SalesExpectations, Cf/SalesHandoverNotes, Cf/PartnerFit, Cf/PartnerCommunicationCadence, Cf/NumberOfSupportTicketsOverdue, Cf/NumberOfSupportEscalationslastMonth, Cf/WasTheCustomerAcquired, Cf/WasBudgetCut, Cf/DoWeHaveMultipleChampions, Cf/DidWeLoseAChampionThatHasNotBeenReplaced, Cf/Last90DaysNps, Cf/Last90DaysCsat, Cf/TotalPurchasedHoursForCurrentQuarter, Cf/TotalHoursUsed, Cf/FeatureRequests, Cf/Csm, Cf/SalesforceAccountOwner, Cf/SalesforceRegion, Cf/AdvId, Cf/AdSpendTotalLast30Days, Cf/ContractMinimum, Cf/BillingPeriodsInContractPerYear, Cf/ToContractMin
↓ Show Options ↓↑ Hide Options ↑
?$expand array[string]

Expand related entities

*, PrimaryChurnScore, ParentAccount, UserAccount
↓ Show Options ↓↑ Hide Options ↑
Responses
Status Description
200 Account

Retrieved navigation property

400 Error

Bad Request

401 Error

Unauthorized

403 Error

Forbidden

404 Error

Not Found

409 Error

Conflict

429 Error

Too Many Requests

500 Error

Internal Server Error


Get the PrimaryChurnScore

GET /Account({Id})/PrimaryChurnScore

Code samples

curl -X GET "https://app.churnzero.net/public/v1/Account(8)/PrimaryChurnScore" \
-H "Authorization: Basic c29tZXVzZXI6c3VwM3JTM2NyMzch"

200 response

{
  "Id": 9,
  "GradingBottom": 6.1,
  "GradingTop": 1.36,
  "Name": "string"
}
Parameters
Name Description
Id integer(int64)

Id of the Account

?$select array[string]

Select properties to be returned

Id, Name, GradingBottom, GradingTop
↓ Show Options ↓↑ Hide Options ↑
?$expand array[string]

Expand related entities

*
↓ Show Options ↓↑ Hide Options ↑
Responses
Status Description
200 ChurnScore

Retrieved navigation property

400 Error

Bad Request

401 Error

Unauthorized

403 Error

Forbidden

404 Error

Not Found

409 Error

Conflict

429 Error

Too Many Requests

500 Error

Internal Server Error


Get the UserAccount

GET /Account({Id})/UserAccount

Code samples

curl -X GET "https://app.churnzero.net/public/v1/Account(8)/UserAccount" \
-H "Authorization: Basic c29tZXVzZXI6c3VwM3JTM2NyMzch"

200 response

{
  "Id": 8,
  "AvatarUrl": "string",
  "CanLogIn": false,
  "Cf": {
    "CalendarLink": "string"
  },
  "CrmId": "string",
  "Email": "string",
  "FirstName": "string",
  "HasAccounts": false,
  "IsActive": true,
  "LastName": "string",
  "MobilePhone": "string",
  "Name": "string",
  "ObjectCreatedDate": "2021-05-11T16:38:27.7373125Z",
  "ObjectLastModifiedDate": "2021-05-11T16:38:27.7373125Z",
  "OfficePhone": "string",
  "Title": "string",
  "UserName": "string"
}
Parameters
Name Description
Id integer(int64)

Id of the Account

?$select array[string]

Select properties to be returned

Id, UserName, FirstName, LastName, Name, Email, HasAccounts, AvatarUrl, MobilePhone, OfficePhone, Title, CanLogIn, CrmId, IsActive, ObjectCreatedDate, ObjectLastModifiedDate, Cf/CalendarLink
↓ Show Options ↓↑ Hide Options ↑
?$expand array[string]

Expand related entities

*
↓ Show Options ↓↑ Hide Options ↑
Responses
Status Description
200 UserAccount

Retrieved navigation property

400 Error

Bad Request

401 Error

Unauthorized

403 Error

Forbidden

404 Error

Not Found

409 Error

Conflict

429 Error

Too Many Requests

500 Error

Internal Server Error


Get an Account by AccountExternalId

GET /Account(AccountExternalId='{AccountExternalId}')

Code samples

curl -X GET "https://app.churnzero.net/public/v1/Account(AccountExternalId='string')" \
-H "Authorization: Basic c29tZXVzZXI6c3VwM3JTM2NyMzch"

200 response

{
  "Id": 8,
  "BillingAddressCity": "string",
  "BillingAddressCountry": "string",
  "BillingAddressLine1": "string",
  "BillingAddressLine2": "string",
  "BillingAddressState": "string",
  "BillingAddressZip": "string",
  "Cf": {
    "SupportOwnerId": 15,
    "ProductEdition": "string",
    "Emailcredits": 7.23,
    "AtRisk": true,
    "UpsellAmount": 5.0,
    "CustomerSentiment": "string",
    "SentimentLastUpdated": "2021-05-11",
    "ExecutiveSponsorHasLeft": true,
    "Industry": "string",
    "KpisMet": true,
    "Valuescore": 4.56,
    "Cstier": "string",
    "Elpmodel": "string",
    "EmailCreditsPurchased": 9.13,
    "GoLiveDate": "2021-05-11",
    "Lifecyclestage": "string",
    "OnboardingObjective": "string",
    "TrainingConfigurationNotes": "string",
    "EngagementScore": 9.11,
    "N30DayTimeSpent": 3.64,
    "TrainingConfigurationKpisMet": true,
    "SalesforceIntegration": true,
    "TwitterOauth": false,
    "CustomerFit110": 9.04,
    "CustomFitExplanation": "string",
    "Testpicklist": "string",
    "Outcomes": "string",
    "OverallColor": "string",
    "CustomerObjectives": "string",
    "CurrentSalesVolume": 0.99,
    "ToGoal": 4.94,
    "NumberOfProjects": 4.13,
    "ProjectEffort": "string",
    "ProjectImpact": "string",
    "BlogsPublishedLast7": 9.75,
    "WeeklyBlogsLimit": 9.86,
    "BlogsRemaining": 1.23,
    "NotesLastUpdated": "2021-05-11",
    "CompetitorsUsed": "string",
    "Employee": 5.02,
    "LicensesPurchased": 1.64,
    "AccountPenetration": 7.37,
    "ChurnReason": "string",
    "FeatureUse2": "string",
    "FeatureUse1": "string",
    "FeatureTurnedOn": "string",
    "Covid19IndustryRisk": "string",
    "Covid19CustomerNotes": "string",
    "Covid19Tier": "string",
    "SalesProductFit": "string",
    "SalesExpectations": "string",
    "SalesHandoverNotes": "string",
    "PartnerFit": "string",
    "PartnerCommunicationCadence": "string",
    "NumberOfSupportTicketsOverdue": "string",
    "NumberOfSupportEscalationslastMonth": "string",
    "WasTheCustomerAcquired": "string",
    "WasBudgetCut": "string",
    "DoWeHaveMultipleChampions": "string",
    "DidWeLoseAChampionThatHasNotBeenReplaced": "string",
    "Last90DaysNps": "string",
    "Last90DaysCsat": "string",
    "TotalPurchasedHoursForCurrentQuarter": "string",
    "TotalHoursUsed": "string",
    "FeatureRequests": "string",
    "Csm": "string",
    "SalesforceAccountOwner": "string",
    "SalesforceRegion": "string",
    "AdvId": "string",
    "AdSpendTotalLast30Days": 7.83,
    "ContractMinimum": 1.47,
    "BillingPeriodsInContractPerYear": "string",
    "ToContractMin": 8.81
  },
  "ContactsCount": 16,
  "CrmId": "string",
  "EndDate": "2021-05-11T16:38:27.7138801Z",
  "ExternalId": "string",
  "IsActive": true,
  "LicenseCount": 26,
  "Name": "string",
  "NextRenewalDate": "2021-05-11T16:38:27.7138801Z",
  "ObjectCreatedDate": "2021-05-11T16:38:27.7138801Z",
  "ObjectLastModifiedDate": "2021-05-11T16:38:27.7138801Z",
  "ParentAccountId": 29,
  "ParentNextRenewalDate": "2021-05-11T16:38:27.7138801Z",
  "ParentTotalContractAmount": 9.8,
  "PrimaryChurnScoreId": 9,
  "PrimaryChurnScoreValue": 8.95,
  "StartDate": "2021-05-11T16:38:27.7138801Z",
  "Tags": "string",
  "TenureInDays": 28,
  "TotalContractAmount": 1.22,
  "UsageFrequency": "string",
  "UserAccountId": 9,
  "PrimaryChurnScore@odata.navigationLink": "https://app.churnzero.net/public/v1/Account(8)/PrimaryChurnScore",
  "ParentAccount@odata.navigationLink": "https://app.churnzero.net/public/v1/Account(8)/ParentAccount",
  "UserAccount@odata.navigationLink": "https://app.churnzero.net/public/v1/Account(8)/UserAccount"
}
Parameters
Name Description
AccountExternalId string

ExternalId of the Account.

?$select array[string]

Select properties to be returned

Id, Name, UserAccountId, NextRenewalDate, ParentNextRenewalDate, TotalContractAmount, ParentTotalContractAmount, IsActive, ExternalId, BillingAddressLine1, BillingAddressLine2, BillingAddressCity, BillingAddressState, BillingAddressZip, BillingAddressCountry, StartDate, EndDate, LicenseCount, CrmId, TenureInDays, PrimaryChurnScoreId, PrimaryChurnScoreValue, UsageFrequency, ContactsCount, ParentAccountId, Tags, ObjectCreatedDate, ObjectLastModifiedDate, Cf/SupportOwnerId, Cf/ProductEdition, Cf/Emailcredits, Cf/AtRisk, Cf/UpsellAmount, Cf/CustomerSentiment, Cf/SentimentLastUpdated, Cf/ExecutiveSponsorHasLeft, Cf/Industry, Cf/KpisMet, Cf/Valuescore, Cf/Cstier, Cf/Elpmodel, Cf/EmailCreditsPurchased, Cf/GoLiveDate, Cf/Lifecyclestage, Cf/OnboardingObjective, Cf/TrainingConfigurationNotes, Cf/EngagementScore, Cf/N30DayTimeSpent, Cf/TrainingConfigurationKpisMet, Cf/SalesforceIntegration, Cf/TwitterOauth, Cf/CustomerFit110, Cf/CustomFitExplanation, Cf/Testpicklist, Cf/Outcomes, Cf/OverallColor, Cf/CustomerObjectives, Cf/CurrentSalesVolume, Cf/ToGoal, Cf/NumberOfProjects, Cf/ProjectEffort, Cf/ProjectImpact, Cf/BlogsPublishedLast7, Cf/WeeklyBlogsLimit, Cf/BlogsRemaining, Cf/NotesLastUpdated, Cf/CompetitorsUsed, Cf/Employee, Cf/LicensesPurchased, Cf/AccountPenetration, Cf/ChurnReason, Cf/FeatureUse2, Cf/FeatureUse1, Cf/FeatureTurnedOn, Cf/Covid19IndustryRisk, Cf/Covid19CustomerNotes, Cf/Covid19Tier, Cf/SalesProductFit, Cf/SalesExpectations, Cf/SalesHandoverNotes, Cf/PartnerFit, Cf/PartnerCommunicationCadence, Cf/NumberOfSupportTicketsOverdue, Cf/NumberOfSupportEscalationslastMonth, Cf/WasTheCustomerAcquired, Cf/WasBudgetCut, Cf/DoWeHaveMultipleChampions, Cf/DidWeLoseAChampionThatHasNotBeenReplaced, Cf/Last90DaysNps, Cf/Last90DaysCsat, Cf/TotalPurchasedHoursForCurrentQuarter, Cf/TotalHoursUsed, Cf/FeatureRequests, Cf/Csm, Cf/SalesforceAccountOwner, Cf/SalesforceRegion, Cf/AdvId, Cf/AdSpendTotalLast30Days, Cf/ContractMinimum, Cf/BillingPeriodsInContractPerYear, Cf/ToContractMin
↓ Show Options ↓↑ Hide Options ↑
?$expand array[string]

Expand related entities

*, PrimaryChurnScore, ParentAccount, UserAccount
↓ Show Options ↓↑ Hide Options ↑
Responses
Status Description
200 Account

Retrieved entity

400 Error

Bad Request

401 Error

Unauthorized

403 Error

Forbidden

404 Error

Not Found

409 Error

Conflict

429 Error

Too Many Requests

500 Error

Internal Server Error


Contact

Contact available in ChurnZero.

Permissions

Bulk Read - Contacts


Get all Contacts

GET /Contact

Code samples

curl -X GET "https://app.churnzero.net/public/v1/Contact" \
-H "Authorization: Basic c29tZXVzZXI6c3VwM3JTM2NyMzch"

200 response

{
  "value": [
    {
      "Id": 5,
      "AccountId": 20,
      "Cf": {
        "Role": "string",
        "AccountexternalId": 1.9,
        "Language": "string",
        "Admin": false,
        "Active": false,
        "LastLogin": "2021-05-11",
        "LicenseType": "string"
      },
      "CrmId": "string",
      "Email": "string",
      "ExternalId": "string",
      "FirstName": "string",
      "FullName": "string",
      "LastName": "string",
      "MarketingEmailUnsubscribed": false,
      "Name": "string",
      "ObjectCreatedDate": "2021-05-11T16:38:27.7261423Z",
      "ObjectLastModifiedDate": "2021-05-11T16:38:27.7261423Z",
      "Tags": "string",
      "Account@odata.navigationLink": "https://app.churnzero.net/public/v1/Contact(5)/Account"
    }
  ],
  "@odata.nextLink": "https://app.churnzero.net/public/v1/Contact?$skip=100"
}
Parameters
Name Description
?$filter array[string]

Filter items by property values

FirstName, LastName, FullName, Email, Name, MarketingEmailUnsubscribed, ObjectCreatedDate, ObjectLastModifiedDate, ExternalId, CrmId, AccountId, Cf/Role, Cf/AccountexternalId, Cf/Language, Cf/Admin, Cf/Active, Cf/LastLogin, Cf/LicenseType, Use/SegmentId, Use/SegmentColumnSetId
↓ Show Options ↓↑ Hide Options ↑
?$orderby array[string]

Order items by property values

FirstName, LastName, FullName, Email, Name, MarketingEmailUnsubscribed, ObjectCreatedDate, ObjectLastModifiedDate, Cf/Role, Cf/AccountexternalId, Cf/Language, Cf/Admin, Cf/Active, Cf/LastLogin, Cf/LicenseType
↓ Show Options ↓↑ Hide Options ↑
?$select array[string]

Select properties to be returned

Id, AccountId, FirstName, LastName, FullName, Email, Name, ExternalId, CrmId, MarketingEmailUnsubscribed, Tags, ObjectCreatedDate, ObjectLastModifiedDate, Cf/Role, Cf/AccountexternalId, Cf/Language, Cf/Admin, Cf/Active, Cf/LastLogin, Cf/LicenseType
↓ Show Options ↓↑ Hide Options ↑
?$expand array[string]

Expand related entities

*, Account
↓ Show Options ↓↑ Hide Options ↑
?$top integer(int32)

Show only the first n items

?$skip integer(int32)

Skip the first n items

?$count boolean

Include count of items

Responses
Status Description
200 array[Contact]

Retrieved entities

400 Error

Bad Request

401 Error

Unauthorized

403 Error

Forbidden

409 Error

Conflict

429 Error

Too Many Requests

500 Error

Internal Server Error


Get a Contact

GET /Contact({Id})

Code samples

curl -X GET "https://app.churnzero.net/public/v1/Contact(5)" \
-H "Authorization: Basic c29tZXVzZXI6c3VwM3JTM2NyMzch"

200 response

{
  "Id": 5,
  "AccountId": 20,
  "Cf": {
    "Role": "string",
    "AccountexternalId": 1.9,
    "Language": "string",
    "Admin": false,
    "Active": false,
    "LastLogin": "2021-05-11",
    "LicenseType": "string"
  },
  "CrmId": "string",
  "Email": "string",
  "ExternalId": "string",
  "FirstName": "string",
  "FullName": "string",
  "LastName": "string",
  "MarketingEmailUnsubscribed": false,
  "Name": "string",
  "ObjectCreatedDate": "2021-05-11T16:38:27.7261423Z",
  "ObjectLastModifiedDate": "2021-05-11T16:38:27.7261423Z",
  "Tags": "string",
  "Account@odata.navigationLink": "https://app.churnzero.net/public/v1/Contact(5)/Account"
}
Parameters
Name Description
Id integer(int64)

Id of the Contact

?$select array[string]

Select properties to be returned

Id, AccountId, FirstName, LastName, FullName, Email, Name, ExternalId, CrmId, MarketingEmailUnsubscribed, Tags, ObjectCreatedDate, ObjectLastModifiedDate, Cf/Role, Cf/AccountexternalId, Cf/Language, Cf/Admin, Cf/Active, Cf/LastLogin, Cf/LicenseType
↓ Show Options ↓↑ Hide Options ↑
?$expand array[string]

Expand related entities

*, Account
↓ Show Options ↓↑ Hide Options ↑
Responses
Status Description
200 Contact

Retrieved entity

400 Error

Bad Request

401 Error

Unauthorized

403 Error

Forbidden

404 Error

Not Found

409 Error

Conflict

429 Error

Too Many Requests

500 Error

Internal Server Error


Get the Account

GET /Contact({Id})/Account

Code samples

curl -X GET "https://app.churnzero.net/public/v1/Contact(5)/Account" \
-H "Authorization: Basic c29tZXVzZXI6c3VwM3JTM2NyMzch"

200 response

{
  "Id": 8,
  "BillingAddressCity": "string",
  "BillingAddressCountry": "string",
  "BillingAddressLine1": "string",
  "BillingAddressLine2": "string",
  "BillingAddressState": "string",
  "BillingAddressZip": "string",
  "Cf": {
    "SupportOwnerId": 15,
    "ProductEdition": "string",
    "Emailcredits": 7.23,
    "AtRisk": true,
    "UpsellAmount": 5.0,
    "CustomerSentiment": "string",
    "SentimentLastUpdated": "2021-05-11",
    "ExecutiveSponsorHasLeft": true,
    "Industry": "string",
    "KpisMet": true,
    "Valuescore": 4.56,
    "Cstier": "string",
    "Elpmodel": "string",
    "EmailCreditsPurchased": 9.13,
    "GoLiveDate": "2021-05-11",
    "Lifecyclestage": "string",
    "OnboardingObjective": "string",
    "TrainingConfigurationNotes": "string",
    "EngagementScore": 9.11,
    "N30DayTimeSpent": 3.64,
    "TrainingConfigurationKpisMet": true,
    "SalesforceIntegration": true,
    "TwitterOauth": false,
    "CustomerFit110": 9.04,
    "CustomFitExplanation": "string",
    "Testpicklist": "string",
    "Outcomes": "string",
    "OverallColor": "string",
    "CustomerObjectives": "string",
    "CurrentSalesVolume": 0.99,
    "ToGoal": 4.94,
    "NumberOfProjects": 4.13,
    "ProjectEffort": "string",
    "ProjectImpact": "string",
    "BlogsPublishedLast7": 9.75,
    "WeeklyBlogsLimit": 9.86,
    "BlogsRemaining": 1.23,
    "NotesLastUpdated": "2021-05-11",
    "CompetitorsUsed": "string",
    "Employee": 5.02,
    "LicensesPurchased": 1.64,
    "AccountPenetration": 7.37,
    "ChurnReason": "string",
    "FeatureUse2": "string",
    "FeatureUse1": "string",
    "FeatureTurnedOn": "string",
    "Covid19IndustryRisk": "string",
    "Covid19CustomerNotes": "string",
    "Covid19Tier": "string",
    "SalesProductFit": "string",
    "SalesExpectations": "string",
    "SalesHandoverNotes": "string",
    "PartnerFit": "string",
    "PartnerCommunicationCadence": "string",
    "NumberOfSupportTicketsOverdue": "string",
    "NumberOfSupportEscalationslastMonth": "string",
    "WasTheCustomerAcquired": "string",
    "WasBudgetCut": "string",
    "DoWeHaveMultipleChampions": "string",
    "DidWeLoseAChampionThatHasNotBeenReplaced": "string",
    "Last90DaysNps": "string",
    "Last90DaysCsat": "string",
    "TotalPurchasedHoursForCurrentQuarter": "string",
    "TotalHoursUsed": "string",
    "FeatureRequests": "string",
    "Csm": "string",
    "SalesforceAccountOwner": "string",
    "SalesforceRegion": "string",
    "AdvId": "string",
    "AdSpendTotalLast30Days": 7.83,
    "ContractMinimum": 1.47,
    "BillingPeriodsInContractPerYear": "string",
    "ToContractMin": 8.81
  },
  "ContactsCount": 16,
  "CrmId": "string",
  "EndDate": "2021-05-11T16:38:27.7138801Z",
  "ExternalId": "string",
  "IsActive": true,
  "LicenseCount": 26,
  "Name": "string",
  "NextRenewalDate": "2021-05-11T16:38:27.7138801Z",
  "ObjectCreatedDate": "2021-05-11T16:38:27.7138801Z",
  "ObjectLastModifiedDate": "2021-05-11T16:38:27.7138801Z",
  "ParentAccountId": 29,
  "ParentNextRenewalDate": "2021-05-11T16:38:27.7138801Z",
  "ParentTotalContractAmount": 9.8,
  "PrimaryChurnScoreId": 9,
  "PrimaryChurnScoreValue": 8.95,
  "StartDate": "2021-05-11T16:38:27.7138801Z",
  "Tags": "string",
  "TenureInDays": 28,
  "TotalContractAmount": 1.22,
  "UsageFrequency": "string",
  "UserAccountId": 9,
  "PrimaryChurnScore@odata.navigationLink": "https://app.churnzero.net/public/v1/Account(8)/PrimaryChurnScore",
  "ParentAccount@odata.navigationLink": "https://app.churnzero.net/public/v1/Account(8)/ParentAccount",
  "UserAccount@odata.navigationLink": "https://app.churnzero.net/public/v1/Account(8)/UserAccount"
}
Parameters
Name Description
Id integer(int64)

Id of the Contact

?$select array[string]

Select properties to be returned

Id, Name, UserAccountId, NextRenewalDate, ParentNextRenewalDate, TotalContractAmount, ParentTotalContractAmount, IsActive, ExternalId, BillingAddressLine1, BillingAddressLine2, BillingAddressCity, BillingAddressState, BillingAddressZip, BillingAddressCountry, StartDate, EndDate, LicenseCount, CrmId, TenureInDays, PrimaryChurnScoreId, PrimaryChurnScoreValue, UsageFrequency, ContactsCount, ParentAccountId, Tags, ObjectCreatedDate, ObjectLastModifiedDate, Cf/SupportOwnerId, Cf/ProductEdition, Cf/Emailcredits, Cf/AtRisk, Cf/UpsellAmount, Cf/CustomerSentiment, Cf/SentimentLastUpdated, Cf/ExecutiveSponsorHasLeft, Cf/Industry, Cf/KpisMet, Cf/Valuescore, Cf/Cstier, Cf/Elpmodel, Cf/EmailCreditsPurchased, Cf/GoLiveDate, Cf/Lifecyclestage, Cf/OnboardingObjective, Cf/TrainingConfigurationNotes, Cf/EngagementScore, Cf/N30DayTimeSpent, Cf/TrainingConfigurationKpisMet, Cf/SalesforceIntegration, Cf/TwitterOauth, Cf/CustomerFit110, Cf/CustomFitExplanation, Cf/Testpicklist, Cf/Outcomes, Cf/OverallColor, Cf/CustomerObjectives, Cf/CurrentSalesVolume, Cf/ToGoal, Cf/NumberOfProjects, Cf/ProjectEffort, Cf/ProjectImpact, Cf/BlogsPublishedLast7, Cf/WeeklyBlogsLimit, Cf/BlogsRemaining, Cf/NotesLastUpdated, Cf/CompetitorsUsed, Cf/Employee, Cf/LicensesPurchased, Cf/AccountPenetration, Cf/ChurnReason, Cf/FeatureUse2, Cf/FeatureUse1, Cf/FeatureTurnedOn, Cf/Covid19IndustryRisk, Cf/Covid19CustomerNotes, Cf/Covid19Tier, Cf/SalesProductFit, Cf/SalesExpectations, Cf/SalesHandoverNotes, Cf/PartnerFit, Cf/PartnerCommunicationCadence, Cf/NumberOfSupportTicketsOverdue, Cf/NumberOfSupportEscalationslastMonth, Cf/WasTheCustomerAcquired, Cf/WasBudgetCut, Cf/DoWeHaveMultipleChampions, Cf/DidWeLoseAChampionThatHasNotBeenReplaced, Cf/Last90DaysNps, Cf/Last90DaysCsat, Cf/TotalPurchasedHoursForCurrentQuarter, Cf/TotalHoursUsed, Cf/FeatureRequests, Cf/Csm, Cf/SalesforceAccountOwner, Cf/SalesforceRegion, Cf/AdvId, Cf/AdSpendTotalLast30Days, Cf/ContractMinimum, Cf/BillingPeriodsInContractPerYear, Cf/ToContractMin
↓ Show Options ↓↑ Hide Options ↑
?$expand array[string]

Expand related entities

*, PrimaryChurnScore, ParentAccount, UserAccount
↓ Show Options ↓↑ Hide Options ↑
Responses
Status Description
200 Account

Retrieved navigation property

400 Error

Bad Request

401 Error

Unauthorized

403 Error

Forbidden

404 Error

Not Found

409 Error

Conflict

429 Error

Too Many Requests

500 Error

Internal Server Error


Get a Contact by AccountExternalId and ContactExternalId

GET /Contact(AccountExternalId='{AccountExternalId}',ContactExternalId='{ContactExternalId}')

Code samples

curl -X GET "https://app.churnzero.net/public/v1/Contact(5)/Contact.ExternalId" \
-H "Authorization: Basic c29tZXVzZXI6c3VwM3JTM2NyMzch"

200 response

{
  "Id": 5,
  "AccountId": 20,
  "Cf": {
    "Role": "string",
    "AccountexternalId": 1.9,
    "Language": "string",
    "Admin": false,
    "Active": false,
    "LastLogin": "2021-05-11",
    "LicenseType": "string"
  },
  "CrmId": "string",
  "Email": "string",
  "ExternalId": "string",
  "FirstName": "string",
  "FullName": "string",
  "LastName": "string",
  "MarketingEmailUnsubscribed": false,
  "Name": "string",
  "ObjectCreatedDate": "2021-05-11T16:38:27.7261423Z",
  "ObjectLastModifiedDate": "2021-05-11T16:38:27.7261423Z",
  "Tags": "string",
  "Account@odata.navigationLink": "https://app.churnzero.net/public/v1/Contact(5)/Account"
}
Parameters
Name Description
AccountExternalId string

ExternalId of the Account.

ContactExternalId string

ExternalId of the Contact.

?$select array[string]

Select properties to be returned

Id, AccountId, FirstName, LastName, FullName, Email, Name, ExternalId, CrmId, MarketingEmailUnsubscribed, Tags, ObjectCreatedDate, ObjectLastModifiedDate, Cf/Role, Cf/AccountexternalId, Cf/Language, Cf/Admin, Cf/Active, Cf/LastLogin, Cf/LicenseType
↓ Show Options ↓↑ Hide Options ↑
?$expand array[string]

Expand related entities

*, Account
↓ Show Options ↓↑ Hide Options ↑
Responses
Status Description
200 Contact

Retrieved entity

400 Error

Bad Request

401 Error

Unauthorized

403 Error

Forbidden

404 Error

Not Found

409 Error

Conflict

429 Error

Too Many Requests

500 Error

Internal Server Error


UserAccount

User Account available in ChurnZero.

Permissions

Bulk Read - User Accounts


Get all UserAccounts

GET /UserAccount

Code samples

curl -X GET "https://app.churnzero.net/public/v1/UserAccount" \
-H "Authorization: Basic c29tZXVzZXI6c3VwM3JTM2NyMzch"

200 response

{
  "value": [
    {
      "Id": 8,
      "AvatarUrl": "string",
      "CanLogIn": false,
      "Cf": {
        "CalendarLink": "string"
      },
      "CrmId": "string",
      "Email": "string",
      "FirstName": "string",
      "HasAccounts": false,
      "IsActive": true,
      "LastName": "string",
      "MobilePhone": "string",
      "Name": "string",
      "ObjectCreatedDate": "2021-05-11T16:38:27.7373125Z",
      "ObjectLastModifiedDate": "2021-05-11T16:38:27.7373125Z",
      "OfficePhone": "string",
      "Title": "string",
      "UserName": "string"
    }
  ],
  "@odata.nextLink": "https://app.churnzero.net/public/v1/UserAccount?$skip=100"
}
Parameters
Name Description
?$filter array[string]

Filter items by property values

UserName, FirstName, LastName, Name, Email, HasAccounts, MobilePhone, OfficePhone, Title, CanLogIn, IsActive, ObjectCreatedDate, ObjectLastModifiedDate, CrmId, Cf/CalendarLink
↓ Show Options ↓↑ Hide Options ↑
?$orderby array[string]

Order items by property values

UserName, FirstName, LastName, Name, Email, HasAccounts, MobilePhone, OfficePhone, Title, CanLogIn, IsActive, ObjectCreatedDate, ObjectLastModifiedDate, Cf/CalendarLink
↓ Show Options ↓↑ Hide Options ↑
?$select array[string]

Select properties to be returned

Id, UserName, FirstName, LastName, Name, Email, HasAccounts, AvatarUrl, MobilePhone, OfficePhone, Title, CanLogIn, CrmId, IsActive, ObjectCreatedDate, ObjectLastModifiedDate, Cf/CalendarLink
↓ Show Options ↓↑ Hide Options ↑
?$expand array[string]

Expand related entities

*
↓ Show Options ↓↑ Hide Options ↑
?$top integer(int32)

Show only the first n items

?$skip integer(int32)

Skip the first n items

?$count boolean

Include count of items

Responses
Status Description
200 array[UserAccount]

Retrieved entities

400 Error

Bad Request

401 Error

Unauthorized

403 Error

Forbidden

409 Error

Conflict

429 Error

Too Many Requests

500 Error

Internal Server Error


Get an UserAccount

GET /UserAccount({Id})

Code samples

curl -X GET "https://app.churnzero.net/public/v1/UserAccount(8)" \
-H "Authorization: Basic c29tZXVzZXI6c3VwM3JTM2NyMzch"

200 response

{
  "Id": 8,
  "AvatarUrl": "string",
  "CanLogIn": false,
  "Cf": {
    "CalendarLink": "string"
  },
  "CrmId": "string",
  "Email": "string",
  "FirstName": "string",
  "HasAccounts": false,
  "IsActive": true,
  "LastName": "string",
  "MobilePhone": "string",
  "Name": "string",
  "ObjectCreatedDate": "2021-05-11T16:38:27.7373125Z",
  "ObjectLastModifiedDate": "2021-05-11T16:38:27.7373125Z",
  "OfficePhone": "string",
  "Title": "string",
  "UserName": "string"
}
Parameters
Name Description
Id integer(int64)

Id of the UserAccount

?$select array[string]

Select properties to be returned

Id, UserName, FirstName, LastName, Name, Email, HasAccounts, AvatarUrl, MobilePhone, OfficePhone, Title, CanLogIn, CrmId, IsActive, ObjectCreatedDate, ObjectLastModifiedDate, Cf/CalendarLink
↓ Show Options ↓↑ Hide Options ↑
?$expand array[string]

Expand related entities

*
↓ Show Options ↓↑ Hide Options ↑
Responses
Status Description
200 UserAccount

Retrieved entity

400 Error

Bad Request

401 Error

Unauthorized

403 Error

Forbidden

404 Error

Not Found

409 Error

Conflict

429 Error

Too Many Requests

500 Error

Internal Server Error


Event

Event available in ChurnZero.

Permissions

Bulk Read - Events


Get all Events

GET /Event

Code samples

curl -X GET "https://app.churnzero.net/public/v1/Event" \
-H "Authorization: Basic c29tZXVzZXI6c3VwM3JTM2NyMzch"

200 response

{
  "value": [
    {
      "Id": 6,
      "AccountId": 26,
      "Cf": {
        "EventId": 3
      },
      "ContactId": 7,
      "Description": "string",
      "EventDate": "2021-05-11T16:38:27.7453951Z",
      "EventTypeId": 27,
      "Quantity": "string",
      "Contact@odata.navigationLink": "https://app.churnzero.net/public/v1/Event(6)/Contact",
      "Account@odata.navigationLink": "https://app.churnzero.net/public/v1/Event(6)/Account",
      "EventType@odata.navigationLink": "https://app.churnzero.net/public/v1/Event(6)/EventType"
    }
  ],
  "@odata.nextLink": "https://app.churnzero.net/public/v1/Event?$skip=100"
}
Parameters
Name Description
?$filter array[string]

Filter items by property values

EventDate, Quantity, AccountId, ContactId, EventTypeId, Use/SegmentId, Use/SegmentColumnSetId
↓ Show Options ↓↑ Hide Options ↑
?$orderby array[string]

Order items by property values

EventDate, Quantity
↓ Show Options ↓↑ Hide Options ↑
?$select array[string]

Select properties to be returned

Id, AccountId, ContactId, EventTypeId, EventDate, Quantity, Description
↓ Show Options ↓↑ Hide Options ↑
?$expand array[string]

Expand related entities

*, Contact, Account, EventType
↓ Show Options ↓↑ Hide Options ↑
?$top integer(int32)

Show only the first n items

?$skip integer(int32)

Skip the first n items

?$count boolean

Include count of items

Responses
Status Description
200 array[Event]

Retrieved entities

400 Error

Bad Request

401 Error

Unauthorized

403 Error

Forbidden

409 Error

Conflict

429 Error

Too Many Requests

500 Error

Internal Server Error


Get an Event

GET /Event({Id})

Code samples

curl -X GET "https://app.churnzero.net/public/v1/Event(6)" \
-H "Authorization: Basic c29tZXVzZXI6c3VwM3JTM2NyMzch"

200 response

{
  "Id": 6,
  "AccountId": 26,
  "Cf": {
    "EventId": 3
  },
  "ContactId": 7,
  "Description": "string",
  "EventDate": "2021-05-11T16:38:27.7453951Z",
  "EventTypeId": 27,
  "Quantity": "string",
  "Contact@odata.navigationLink": "https://app.churnzero.net/public/v1/Event(6)/Contact",
  "Account@odata.navigationLink": "https://app.churnzero.net/public/v1/Event(6)/Account",
  "EventType@odata.navigationLink": "https://app.churnzero.net/public/v1/Event(6)/EventType"
}
Parameters
Name Description
Id integer(int64)

Id of the Event

?$select array[string]

Select properties to be returned

Id, AccountId, ContactId, EventTypeId, EventDate, Quantity, Description
↓ Show Options ↓↑ Hide Options ↑
?$expand array[string]

Expand related entities

*, Contact, Account, EventType
↓ Show Options ↓↑ Hide Options ↑
Responses
Status Description
200 Event

Retrieved entity

400 Error

Bad Request

401 Error

Unauthorized

403 Error

Forbidden

404 Error

Not Found

409 Error

Conflict

429 Error

Too Many Requests

500 Error

Internal Server Error


Get the Account

GET /Event({Id})/Account

Code samples

curl -X GET "https://app.churnzero.net/public/v1/Event(6)/Account" \
-H "Authorization: Basic c29tZXVzZXI6c3VwM3JTM2NyMzch"

200 response

{
  "Id": 8,
  "BillingAddressCity": "string",
  "BillingAddressCountry": "string",
  "BillingAddressLine1": "string",
  "BillingAddressLine2": "string",
  "BillingAddressState": "string",
  "BillingAddressZip": "string",
  "Cf": {
    "SupportOwnerId": 15,
    "ProductEdition": "string",
    "Emailcredits": 7.23,
    "AtRisk": true,
    "UpsellAmount": 5.0,
    "CustomerSentiment": "string",
    "SentimentLastUpdated": "2021-05-11",
    "ExecutiveSponsorHasLeft": true,
    "Industry": "string",
    "KpisMet": true,
    "Valuescore": 4.56,
    "Cstier": "string",
    "Elpmodel": "string",
    "EmailCreditsPurchased": 9.13,
    "GoLiveDate": "2021-05-11",
    "Lifecyclestage": "string",
    "OnboardingObjective": "string",
    "TrainingConfigurationNotes": "string",
    "EngagementScore": 9.11,
    "N30DayTimeSpent": 3.64,
    "TrainingConfigurationKpisMet": true,
    "SalesforceIntegration": true,
    "TwitterOauth": false,
    "CustomerFit110": 9.04,
    "CustomFitExplanation": "string",
    "Testpicklist": "string",
    "Outcomes": "string",
    "OverallColor": "string",
    "CustomerObjectives": "string",
    "CurrentSalesVolume": 0.99,
    "ToGoal": 4.94,
    "NumberOfProjects": 4.13,
    "ProjectEffort": "string",
    "ProjectImpact": "string",
    "BlogsPublishedLast7": 9.75,
    "WeeklyBlogsLimit": 9.86,
    "BlogsRemaining": 1.23,
    "NotesLastUpdated": "2021-05-11",
    "CompetitorsUsed": "string",
    "Employee": 5.02,
    "LicensesPurchased": 1.64,
    "AccountPenetration": 7.37,
    "ChurnReason": "string",
    "FeatureUse2": "string",
    "FeatureUse1": "string",
    "FeatureTurnedOn": "string",
    "Covid19IndustryRisk": "string",
    "Covid19CustomerNotes": "string",
    "Covid19Tier": "string",
    "SalesProductFit": "string",
    "SalesExpectations": "string",
    "SalesHandoverNotes": "string",
    "PartnerFit": "string",
    "PartnerCommunicationCadence": "string",
    "NumberOfSupportTicketsOverdue": "string",
    "NumberOfSupportEscalationslastMonth": "string",
    "WasTheCustomerAcquired": "string",
    "WasBudgetCut": "string",
    "DoWeHaveMultipleChampions": "string",
    "DidWeLoseAChampionThatHasNotBeenReplaced": "string",
    "Last90DaysNps": "string",
    "Last90DaysCsat": "string",
    "TotalPurchasedHoursForCurrentQuarter": "string",
    "TotalHoursUsed": "string",
    "FeatureRequests": "string",
    "Csm": "string",
    "SalesforceAccountOwner": "string",
    "SalesforceRegion": "string",
    "AdvId": "string",
    "AdSpendTotalLast30Days": 7.83,
    "ContractMinimum": 1.47,
    "BillingPeriodsInContractPerYear": "string",
    "ToContractMin": 8.81
  },
  "ContactsCount": 16,
  "CrmId": "string",
  "EndDate": "2021-05-11T16:38:27.7138801Z",
  "ExternalId": "string",
  "IsActive": true,
  "LicenseCount": 26,
  "Name": "string",
  "NextRenewalDate": "2021-05-11T16:38:27.7138801Z",
  "ObjectCreatedDate": "2021-05-11T16:38:27.7138801Z",
  "ObjectLastModifiedDate": "2021-05-11T16:38:27.7138801Z",
  "ParentAccountId": 29,
  "ParentNextRenewalDate": "2021-05-11T16:38:27.7138801Z",
  "ParentTotalContractAmount": 9.8,
  "PrimaryChurnScoreId": 9,
  "PrimaryChurnScoreValue": 8.95,
  "StartDate": "2021-05-11T16:38:27.7138801Z",
  "Tags": "string",
  "TenureInDays": 28,
  "TotalContractAmount": 1.22,
  "UsageFrequency": "string",
  "UserAccountId": 9,
  "PrimaryChurnScore@odata.navigationLink": "https://app.churnzero.net/public/v1/Account(8)/PrimaryChurnScore",
  "ParentAccount@odata.navigationLink": "https://app.churnzero.net/public/v1/Account(8)/ParentAccount",
  "UserAccount@odata.navigationLink": "https://app.churnzero.net/public/v1/Account(8)/UserAccount"
}
Parameters
Name Description
Id integer(int64)

Id of the Event

?$select array[string]

Select properties to be returned

Id, Name, UserAccountId, NextRenewalDate, ParentNextRenewalDate, TotalContractAmount, ParentTotalContractAmount, IsActive, ExternalId, BillingAddressLine1, BillingAddressLine2, BillingAddressCity, BillingAddressState, BillingAddressZip, BillingAddressCountry, StartDate, EndDate, LicenseCount, CrmId, TenureInDays, PrimaryChurnScoreId, PrimaryChurnScoreValue, UsageFrequency, ContactsCount, ParentAccountId, Tags, ObjectCreatedDate, ObjectLastModifiedDate, Cf/SupportOwnerId, Cf/ProductEdition, Cf/Emailcredits, Cf/AtRisk, Cf/UpsellAmount, Cf/CustomerSentiment, Cf/SentimentLastUpdated, Cf/ExecutiveSponsorHasLeft, Cf/Industry, Cf/KpisMet, Cf/Valuescore, Cf/Cstier, Cf/Elpmodel, Cf/EmailCreditsPurchased, Cf/GoLiveDate, Cf/Lifecyclestage, Cf/OnboardingObjective, Cf/TrainingConfigurationNotes, Cf/EngagementScore, Cf/N30DayTimeSpent, Cf/TrainingConfigurationKpisMet, Cf/SalesforceIntegration, Cf/TwitterOauth, Cf/CustomerFit110, Cf/CustomFitExplanation, Cf/Testpicklist, Cf/Outcomes, Cf/OverallColor, Cf/CustomerObjectives, Cf/CurrentSalesVolume, Cf/ToGoal, Cf/NumberOfProjects, Cf/ProjectEffort, Cf/ProjectImpact, Cf/BlogsPublishedLast7, Cf/WeeklyBlogsLimit, Cf/BlogsRemaining, Cf/NotesLastUpdated, Cf/CompetitorsUsed, Cf/Employee, Cf/LicensesPurchased, Cf/AccountPenetration, Cf/ChurnReason, Cf/FeatureUse2, Cf/FeatureUse1, Cf/FeatureTurnedOn, Cf/Covid19IndustryRisk, Cf/Covid19CustomerNotes, Cf/Covid19Tier, Cf/SalesProductFit, Cf/SalesExpectations, Cf/SalesHandoverNotes, Cf/PartnerFit, Cf/PartnerCommunicationCadence, Cf/NumberOfSupportTicketsOverdue, Cf/NumberOfSupportEscalationslastMonth, Cf/WasTheCustomerAcquired, Cf/WasBudgetCut, Cf/DoWeHaveMultipleChampions, Cf/DidWeLoseAChampionThatHasNotBeenReplaced, Cf/Last90DaysNps, Cf/Last90DaysCsat, Cf/TotalPurchasedHoursForCurrentQuarter, Cf/TotalHoursUsed, Cf/FeatureRequests, Cf/Csm, Cf/SalesforceAccountOwner, Cf/SalesforceRegion, Cf/AdvId, Cf/AdSpendTotalLast30Days, Cf/ContractMinimum, Cf/BillingPeriodsInContractPerYear, Cf/ToContractMin
↓ Show Options ↓↑ Hide Options ↑
?$expand array[string]

Expand related entities

*, PrimaryChurnScore, ParentAccount, UserAccount
↓ Show Options ↓↑ Hide Options ↑
Responses
Status Description
200 Account

Retrieved navigation property

400 Error

Bad Request

401 Error

Unauthorized

403 Error

Forbidden

404 Error

Not Found

409 Error

Conflict

429 Error

Too Many Requests

500 Error

Internal Server Error


Get the Contact

GET /Event({Id})/Contact

Code samples

curl -X GET "https://app.churnzero.net/public/v1/Event(6)/Contact" \
-H "Authorization: Basic c29tZXVzZXI6c3VwM3JTM2NyMzch"

200 response

{
  "Id": 5,
  "AccountId": 20,
  "Cf": {
    "Role": "string",
    "AccountexternalId": 1.9,
    "Language": "string",
    "Admin": false,
    "Active": false,
    "LastLogin": "2021-05-11",
    "LicenseType": "string"
  },
  "CrmId": "string",
  "Email": "string",
  "ExternalId": "string",
  "FirstName": "string",
  "FullName": "string",
  "LastName": "string",
  "MarketingEmailUnsubscribed": false,
  "Name": "string",
  "ObjectCreatedDate": "2021-05-11T16:38:27.7261423Z",
  "ObjectLastModifiedDate": "2021-05-11T16:38:27.7261423Z",
  "Tags": "string",
  "Account@odata.navigationLink": "https://app.churnzero.net/public/v1/Contact(5)/Account"
}
Parameters
Name Description
Id integer(int64)

Id of the Event

?$select array[string]

Select properties to be returned

Id, AccountId, FirstName, LastName, FullName, Email, Name, ExternalId, CrmId, MarketingEmailUnsubscribed, Tags, ObjectCreatedDate, ObjectLastModifiedDate, Cf/Role, Cf/AccountexternalId, Cf/Language, Cf/Admin, Cf/Active, Cf/LastLogin, Cf/LicenseType
↓ Show Options ↓↑ Hide Options ↑
?$expand array[string]

Expand related entities

*, Account
↓ Show Options ↓↑ Hide Options ↑
Responses
Status Description
200 Contact

Retrieved navigation property

400 Error

Bad Request

401 Error

Unauthorized

403 Error

Forbidden

404 Error

Not Found

409 Error

Conflict

429 Error

Too Many Requests

500 Error

Internal Server Error


Get the EventType

GET /Event({Id})/EventType

Code samples

curl -X GET "https://app.churnzero.net/public/v1/Event(6)/EventType" \
-H "Authorization: Basic c29tZXVzZXI6c3VwM3JTM2NyMzch"

200 response

{
  "Id": 4,
  "Name": "string"
}
Parameters
Name Description
Id integer(int64)

Id of the Event

?$select array[string]

Select properties to be returned

Id, Name
↓ Show Options ↓↑ Hide Options ↑
?$expand array[string]

Expand related entities

*
↓ Show Options ↓↑ Hide Options ↑
Responses
Status Description
200 EventType

Retrieved navigation property

400 Error

Bad Request

401 Error

Unauthorized

403 Error

Forbidden

404 Error

Not Found

409 Error

Conflict

429 Error

Too Many Requests

500 Error

Internal Server Error


EventType

Event Type available in ChurnZero.

Permissions

Bulk Read - Events


Get all EventTypes

GET /EventType

Code samples

curl -X GET "https://app.churnzero.net/public/v1/EventType" \
-H "Authorization: Basic c29tZXVzZXI6c3VwM3JTM2NyMzch"

200 response

{
  "value": [
    {
      "Id": 4,
      "Name": "string"
    }
  ],
  "@odata.nextLink": "https://app.churnzero.net/public/v1/EventType?$skip=100"
}
Parameters
Name Description
?$filter array[string]

Filter items by property values

Name
↓ Show Options ↓↑ Hide Options ↑
?$orderby array[string]

Order items by property values

Name
↓ Show Options ↓↑ Hide Options ↑
?$select array[string]

Select properties to be returned

Id, Name
↓ Show Options ↓↑ Hide Options ↑
?$expand array[string]

Expand related entities

*
↓ Show Options ↓↑ Hide Options ↑
?$top integer(int32)

Show only the first n items

?$skip integer(int32)

Skip the first n items

?$count boolean

Include count of items

Responses
Status Description
200 array[EventType]

Retrieved entities

400 Error

Bad Request

401 Error

Unauthorized

403 Error

Forbidden

409 Error

Conflict

429 Error

Too Many Requests

500 Error

Internal Server Error


Get an EventType

GET /EventType({Id})

Code samples

curl -X GET "https://app.churnzero.net/public/v1/EventType(4)" \
-H "Authorization: Basic c29tZXVzZXI6c3VwM3JTM2NyMzch"

200 response

{
  "Id": 4,
  "Name": "string"
}
Parameters
Name Description
Id integer(int64)

Id of the EventType

?$select array[string]

Select properties to be returned

Id, Name
↓ Show Options ↓↑ Hide Options ↑
?$expand array[string]

Expand related entities

*
↓ Show Options ↓↑ Hide Options ↑
Responses
Status Description
200 EventType

Retrieved entity

400 Error

Bad Request

401 Error

Unauthorized

403 Error

Forbidden

404 Error

Not Found

409 Error

Conflict

429 Error

Too Many Requests

500 Error

Internal Server Error


Segment

Segment available in ChurnZero.

Permissions

None (limited to the Segment owner and global Segments)


Get all Segments

GET /Segment

Code samples

curl -X GET "https://app.churnzero.net/public/v1/Segment" \
-H "Authorization: Basic c29tZXVzZXI6c3VwM3JTM2NyMzch"

200 response

{
  "value": [
    {
      "Id": 9,
      "Entity": "string",
      "IsGlobal": true,
      "Name": "string",
      "ObjectCreatedDate": "2021-05-11T16:38:27.7455152Z",
      "ObjectLastModifiedDate": "2021-05-11T16:38:27.7455152Z"
    }
  ],
  "@odata.nextLink": "https://app.churnzero.net/public/v1/Segment?$skip=100"
}
Parameters
Name Description
?$filter array[string]

Filter items by property values

Name, Entity, IsGlobal, ObjectCreatedDate, ObjectLastModifiedDate
↓ Show Options ↓↑ Hide Options ↑
?$orderby array[string]

Order items by property values

Name, ObjectCreatedDate, ObjectLastModifiedDate
↓ Show Options ↓↑ Hide Options ↑
?$select array[string]

Select properties to be returned

Id, Name, Entity, IsGlobal, ObjectCreatedDate, ObjectLastModifiedDate
↓ Show Options ↓↑ Hide Options ↑
?$expand array[string]

Expand related entities

*
↓ Show Options ↓↑ Hide Options ↑
?$top integer(int32)

Show only the first n items

?$skip integer(int32)

Skip the first n items

?$count boolean

Include count of items

Responses
Status Description
200 array[Segment]

Retrieved entities

400 Error

Bad Request

401 Error

Unauthorized

403 Error

Forbidden

409 Error

Conflict

429 Error

Too Many Requests

500 Error

Internal Server Error


Get a Segment

GET /Segment({Id})

Code samples

curl -X GET "https://app.churnzero.net/public/v1/Segment(9)" \
-H "Authorization: Basic c29tZXVzZXI6c3VwM3JTM2NyMzch"

200 response

{
  "Id": 9,
  "Entity": "string",
  "IsGlobal": true,
  "Name": "string",
  "ObjectCreatedDate": "2021-05-11T16:38:27.7455152Z",
  "ObjectLastModifiedDate": "2021-05-11T16:38:27.7455152Z"
}
Parameters
Name Description
Id integer(int64)

Id of the Segment

?$select array[string]

Select properties to be returned

Id, Name, Entity, IsGlobal, ObjectCreatedDate, ObjectLastModifiedDate
↓ Show Options ↓↑ Hide Options ↑
?$expand array[string]

Expand related entities

*
↓ Show Options ↓↑ Hide Options ↑
Responses
Status Description
200 Segment

Retrieved entity

400 Error

Bad Request

401 Error

Unauthorized

403 Error

Forbidden

404 Error

Not Found

409 Error

Conflict

429 Error

Too Many Requests

500 Error

Internal Server Error


SegmentColumnSet

SegmentColumnSet available in ChurnZero.

Permissions

None (limited to the SegmentColumnSet Owner and ShareTypes of 'All' or 'Domain')


Get all SegmentColumnSets

GET /SegmentColumnSet

Code samples

curl -X GET "https://app.churnzero.net/public/v1/SegmentColumnSet" \
-H "Authorization: Basic c29tZXVzZXI6c3VwM3JTM2NyMzch"

200 response

{
  "value": [
    {
      "Id": 4,
      "Entity": "string",
      "Name": "string",
      "ObjectCreatedDate": "2021-05-11T16:38:27.7674631Z",
      "ObjectLastModifiedDate": "2021-05-11T16:38:27.7674631Z",
      "ShareType": "string",
      "UserAccountId": 25,
      "UserAccount@odata.navigationLink": "https://app.churnzero.net/public/v1/SegmentColumnSet(4)/UserAccount"
    }
  ],
  "@odata.nextLink": "https://app.churnzero.net/public/v1/SegmentColumnSet?$skip=100"
}
Parameters
Name Description
?$filter array[string]

Filter items by property values

Name, Entity, ObjectCreatedDate, ObjectLastModifiedDate
↓ Show Options ↓↑ Hide Options ↑
?$orderby array[string]

Order items by property values

Name, ObjectCreatedDate, ObjectLastModifiedDate
↓ Show Options ↓↑ Hide Options ↑
?$select array[string]

Select properties to be returned

Id, Name, Entity, ShareType, UserAccountId, ObjectCreatedDate, ObjectLastModifiedDate
↓ Show Options ↓↑ Hide Options ↑
?$expand array[string]

Expand related entities

*, UserAccount
↓ Show Options ↓↑ Hide Options ↑
?$top integer(int32)

Show only the first n items

?$skip integer(int32)

Skip the first n items

?$count boolean

Include count of items

Responses
Status Description
200 array[SegmentColumnSet]

Retrieved entities

400 Error

Bad Request

401 Error

Unauthorized

403 Error

Forbidden

409 Error

Conflict

429 Error

Too Many Requests

500 Error

Internal Server Error


Get a SegmentColumnSet

GET /SegmentColumnSet({Id})

Code samples

curl -X GET "https://app.churnzero.net/public/v1/SegmentColumnSet(4)" \
-H "Authorization: Basic c29tZXVzZXI6c3VwM3JTM2NyMzch"

200 response

{
  "Id": 4,
  "Entity": "string",
  "Name": "string",
  "ObjectCreatedDate": "2021-05-11T16:38:27.7674631Z",
  "ObjectLastModifiedDate": "2021-05-11T16:38:27.7674631Z",
  "ShareType": "string",
  "UserAccountId": 25,
  "UserAccount@odata.navigationLink": "https://app.churnzero.net/public/v1/SegmentColumnSet(4)/UserAccount"
}
Parameters
Name Description
Id integer(int64)

Id of the SegmentColumnSet

?$select array[string]

Select properties to be returned

Id, Name, Entity, ShareType, UserAccountId, ObjectCreatedDate, ObjectLastModifiedDate
↓ Show Options ↓↑ Hide Options ↑
?$expand array[string]

Expand related entities

*, UserAccount
↓ Show Options ↓↑ Hide Options ↑
Responses
Status Description
200 SegmentColumnSet

Retrieved entity

400 Error

Bad Request

401 Error

Unauthorized

403 Error

Forbidden

404 Error

Not Found

409 Error

Conflict

429 Error

Too Many Requests

500 Error

Internal Server Error


Get the UserAccount

GET /SegmentColumnSet({Id})/UserAccount

Code samples

curl -X GET "https://app.churnzero.net/public/v1/SegmentColumnSet(4)/UserAccount" \
-H "Authorization: Basic c29tZXVzZXI6c3VwM3JTM2NyMzch"

200 response

{
  "Id": 8,
  "AvatarUrl": "string",
  "CanLogIn": false,
  "Cf": {
    "CalendarLink": "string"
  },
  "CrmId": "string",
  "Email": "string",
  "FirstName": "string",
  "HasAccounts": false,
  "IsActive": true,
  "LastName": "string",
  "MobilePhone": "string",
  "Name": "string",
  "ObjectCreatedDate": "2021-05-11T16:38:27.7373125Z",
  "ObjectLastModifiedDate": "2021-05-11T16:38:27.7373125Z",
  "OfficePhone": "string",
  "Title": "string",
  "UserName": "string"
}
Parameters
Name Description
Id integer(int64)

Id of the SegmentColumnSet

?$select array[string]

Select properties to be returned

Id, UserName, FirstName, LastName, Name, Email, HasAccounts, AvatarUrl, MobilePhone, OfficePhone, Title, CanLogIn, CrmId, IsActive, ObjectCreatedDate, ObjectLastModifiedDate, Cf/CalendarLink
↓ Show Options ↓↑ Hide Options ↑
?$expand array[string]

Expand related entities

*
↓ Show Options ↓↑ Hide Options ↑
Responses
Status Description
200 UserAccount

Retrieved navigation property

400 Error

Bad Request

401 Error

Unauthorized

403 Error

Forbidden

404 Error

Not Found

409 Error

Conflict

429 Error

Too Many Requests

500 Error

Internal Server Error


Task

Task available in ChurnZero.

Permissions

Bulk Read - Tasks


Get all Tasks

GET /Task

Code samples

curl -X GET "https://app.churnzero.net/public/v1/Task" \
-H "Authorization: Basic c29tZXVzZXI6c3VwM3JTM2NyMzch"

200 response

{
  "value": [
    {
      "Id": 1,
      "AccountId": 27,
      "Cf": {
        "Type": "string",
        "AssignedById": 27,
        "MeetingNotesAndAgenda": "string",
        "MeetingSentiment": "string",
        "TimeSpenteffortinMinutes": 6.39,
        "Collaborator1Id": 2,
        "Collaborator2Id": 12,
        "OpportunityFound": "string",
        "ZoomRecording": "string"
      },
      "CloseDate": "2021-05-11T16:38:27.7924681Z",
      "Comments": "string",
      "ContactId": 3,
      "CrmId": "string",
      "DueDate": "2021-05-11T16:38:27.7924681Z",
      "IsClosed": true,
      "IsHighPriority": true,
      "ObjectCreatedDate": "2021-05-11T16:38:27.7924681Z",
      "ObjectLastModifiedDate": "2021-05-11T16:38:27.7924681Z",
      "Subject": "string",
      "TaskPriorityId": 6,
      "TaskStatusId": 1,
      "TaskType": "string",
      "UserAccountId": 23,
      "Account@odata.navigationLink": "https://app.churnzero.net/public/v1/Task(1)/Account",
      "Contact@odata.navigationLink": "https://app.churnzero.net/public/v1/Task(1)/Contact",
      "UserAccount@odata.navigationLink": "https://app.churnzero.net/public/v1/Task(1)/UserAccount",
      "TaskPriority@odata.navigationLink": "https://app.churnzero.net/public/v1/Task(1)/TaskPriority",
      "TaskStatus@odata.navigationLink": "https://app.churnzero.net/public/v1/Task(1)/TaskStatus"
    }
  ],
  "@odata.nextLink": "https://app.churnzero.net/public/v1/Task?$skip=100"
}
Parameters
Name Description
?$filter array[string]

Filter items by property values

Id, AccountId, ContactId, UserAccountId, TaskPriorityId, TaskStatusId, Subject, DueDate, CloseDate, IsClosed, IsHighPriority, CrmId, TaskType, ObjectCreatedDate, ObjectLastModifiedDate, Cf/Type, Cf/AssignedById, Cf/MeetingSentiment, Cf/TimeSpenteffortinMinutes, Cf/Collaborator1Id, Cf/Collaborator2Id, Cf/OpportunityFound, Cf/ZoomRecording, Use/SegmentId, Use/SegmentColumnSetId
↓ Show Options ↓↑ Hide Options ↑
?$orderby array[string]

Order items by property values

Id, AccountId, ContactId, UserAccountId, TaskPriorityId, TaskStatusId, Subject, DueDate, CloseDate, IsClosed, IsHighPriority, CrmId, TaskType, ObjectCreatedDate, ObjectLastModifiedDate, Cf/Type, Cf/MeetingSentiment, Cf/TimeSpenteffortinMinutes, Cf/OpportunityFound, Cf/ZoomRecording
↓ Show Options ↓↑ Hide Options ↑
?$select array[string]

Select properties to be returned

Id, AccountId, ContactId, UserAccountId, TaskPriorityId, TaskStatusId, Subject, DueDate, CloseDate, IsClosed, IsHighPriority, Comments, CrmId, TaskType, ObjectCreatedDate, ObjectLastModifiedDate, Cf/Type, Cf/AssignedById, Cf/MeetingNotesAndAgenda, Cf/MeetingSentiment, Cf/TimeSpenteffortinMinutes, Cf/Collaborator1Id, Cf/Collaborator2Id, Cf/OpportunityFound, Cf/ZoomRecording
↓ Show Options ↓↑ Hide Options ↑
?$expand array[string]

Expand related entities

*, Account, Contact, UserAccount, TaskPriority, TaskStatus
↓ Show Options ↓↑ Hide Options ↑
?$top integer(int32)

Show only the first n items

?$skip integer(int32)

Skip the first n items

?$count boolean

Include count of items

Responses
Status Description
200 array[Task]

Retrieved entities

400 Error

Bad Request

401 Error

Unauthorized

403 Error

Forbidden

409 Error

Conflict

429 Error

Too Many Requests

500 Error

Internal Server Error


Get a Task

GET /Task({Id})

Code samples

curl -X GET "https://app.churnzero.net/public/v1/Task(1)" \
-H "Authorization: Basic c29tZXVzZXI6c3VwM3JTM2NyMzch"

200 response

{
  "Id": 1,
  "AccountId": 27,
  "Cf": {
    "Type": "string",
    "AssignedById": 27,
    "MeetingNotesAndAgenda": "string",
    "MeetingSentiment": "string",
    "TimeSpenteffortinMinutes": 6.39,
    "Collaborator1Id": 2,
    "Collaborator2Id": 12,
    "OpportunityFound": "string",
    "ZoomRecording": "string"
  },
  "CloseDate": "2021-05-11T16:38:27.7924681Z",
  "Comments": "string",
  "ContactId": 3,
  "CrmId": "string",
  "DueDate": "2021-05-11T16:38:27.7924681Z",
  "IsClosed": true,
  "IsHighPriority": true,
  "ObjectCreatedDate": "2021-05-11T16:38:27.7924681Z",
  "ObjectLastModifiedDate": "2021-05-11T16:38:27.7924681Z",
  "Subject": "string",
  "TaskPriorityId": 6,
  "TaskStatusId": 1,
  "TaskType": "string",
  "UserAccountId": 23,
  "Account@odata.navigationLink": "https://app.churnzero.net/public/v1/Task(1)/Account",
  "Contact@odata.navigationLink": "https://app.churnzero.net/public/v1/Task(1)/Contact",
  "UserAccount@odata.navigationLink": "https://app.churnzero.net/public/v1/Task(1)/UserAccount",
  "TaskPriority@odata.navigationLink": "https://app.churnzero.net/public/v1/Task(1)/TaskPriority",
  "TaskStatus@odata.navigationLink": "https://app.churnzero.net/public/v1/Task(1)/TaskStatus"
}
Parameters
Name Description
Id integer(int64)

Id of the Task

?$select array[string]

Select properties to be returned

Id, AccountId, ContactId, UserAccountId, TaskPriorityId, TaskStatusId, Subject, DueDate, CloseDate, IsClosed, IsHighPriority, Comments, CrmId, TaskType, ObjectCreatedDate, ObjectLastModifiedDate, Cf/Type, Cf/AssignedById, Cf/MeetingNotesAndAgenda, Cf/MeetingSentiment, Cf/TimeSpenteffortinMinutes, Cf/Collaborator1Id, Cf/Collaborator2Id, Cf/OpportunityFound, Cf/ZoomRecording
↓ Show Options ↓↑ Hide Options ↑
?$expand array[string]

Expand related entities

*, Account, Contact, UserAccount, TaskPriority, TaskStatus
↓ Show Options ↓↑ Hide Options ↑
Responses
Status Description
200 Task

Retrieved entity

400 Error

Bad Request

401 Error

Unauthorized

403 Error

Forbidden

404 Error

Not Found

409 Error

Conflict

429 Error

Too Many Requests

500 Error

Internal Server Error


Get the Account

GET /Task({Id})/Account

Code samples

curl -X GET "https://app.churnzero.net/public/v1/Task(1)/Account" \
-H "Authorization: Basic c29tZXVzZXI6c3VwM3JTM2NyMzch"

200 response

{
  "Id": 8,
  "BillingAddressCity": "string",
  "BillingAddressCountry": "string",
  "BillingAddressLine1": "string",
  "BillingAddressLine2": "string",
  "BillingAddressState": "string",
  "BillingAddressZip": "string",
  "Cf": {
    "SupportOwnerId": 15,
    "ProductEdition": "string",
    "Emailcredits": 7.23,
    "AtRisk": true,
    "UpsellAmount": 5.0,
    "CustomerSentiment": "string",
    "SentimentLastUpdated": "2021-05-11",
    "ExecutiveSponsorHasLeft": true,
    "Industry": "string",
    "KpisMet": true,
    "Valuescore": 4.56,
    "Cstier": "string",
    "Elpmodel": "string",
    "EmailCreditsPurchased": 9.13,
    "GoLiveDate": "2021-05-11",
    "Lifecyclestage": "string",
    "OnboardingObjective": "string",
    "TrainingConfigurationNotes": "string",
    "EngagementScore": 9.11,
    "N30DayTimeSpent": 3.64,
    "TrainingConfigurationKpisMet": true,
    "SalesforceIntegration": true,
    "TwitterOauth": false,
    "CustomerFit110": 9.04,
    "CustomFitExplanation": "string",
    "Testpicklist": "string",
    "Outcomes": "string",
    "OverallColor": "string",
    "CustomerObjectives": "string",
    "CurrentSalesVolume": 0.99,
    "ToGoal": 4.94,
    "NumberOfProjects": 4.13,
    "ProjectEffort": "string",
    "ProjectImpact": "string",
    "BlogsPublishedLast7": 9.75,
    "WeeklyBlogsLimit": 9.86,
    "BlogsRemaining": 1.23,
    "NotesLastUpdated": "2021-05-11",
    "CompetitorsUsed": "string",
    "Employee": 5.02,
    "LicensesPurchased": 1.64,
    "AccountPenetration": 7.37,
    "ChurnReason": "string",
    "FeatureUse2": "string",
    "FeatureUse1": "string",
    "FeatureTurnedOn": "string",
    "Covid19IndustryRisk": "string",
    "Covid19CustomerNotes": "string",
    "Covid19Tier": "string",
    "SalesProductFit": "string",
    "SalesExpectations": "string",
    "SalesHandoverNotes": "string",
    "PartnerFit": "string",
    "PartnerCommunicationCadence": "string",
    "NumberOfSupportTicketsOverdue": "string",
    "NumberOfSupportEscalationslastMonth": "string",
    "WasTheCustomerAcquired": "string",
    "WasBudgetCut": "string",
    "DoWeHaveMultipleChampions": "string",
    "DidWeLoseAChampionThatHasNotBeenReplaced": "string",
    "Last90DaysNps": "string",
    "Last90DaysCsat": "string",
    "TotalPurchasedHoursForCurrentQuarter": "string",
    "TotalHoursUsed": "string",
    "FeatureRequests": "string",
    "Csm": "string",
    "SalesforceAccountOwner": "string",
    "SalesforceRegion": "string",
    "AdvId": "string",
    "AdSpendTotalLast30Days": 7.83,
    "ContractMinimum": 1.47,
    "BillingPeriodsInContractPerYear": "string",
    "ToContractMin": 8.81
  },
  "ContactsCount": 16,
  "CrmId": "string",
  "EndDate": "2021-05-11T16:38:27.7138801Z",
  "ExternalId": "string",
  "IsActive": true,
  "LicenseCount": 26,
  "Name": "string",
  "NextRenewalDate": "2021-05-11T16:38:27.7138801Z",
  "ObjectCreatedDate": "2021-05-11T16:38:27.7138801Z",
  "ObjectLastModifiedDate": "2021-05-11T16:38:27.7138801Z",
  "ParentAccountId": 29,
  "ParentNextRenewalDate": "2021-05-11T16:38:27.7138801Z",
  "ParentTotalContractAmount": 9.8,
  "PrimaryChurnScoreId": 9,
  "PrimaryChurnScoreValue": 8.95,
  "StartDate": "2021-05-11T16:38:27.7138801Z",
  "Tags": "string",
  "TenureInDays": 28,
  "TotalContractAmount": 1.22,
  "UsageFrequency": "string",
  "UserAccountId": 9,
  "PrimaryChurnScore@odata.navigationLink": "https://app.churnzero.net/public/v1/Account(8)/PrimaryChurnScore",
  "ParentAccount@odata.navigationLink": "https://app.churnzero.net/public/v1/Account(8)/ParentAccount",
  "UserAccount@odata.navigationLink": "https://app.churnzero.net/public/v1/Account(8)/UserAccount"
}
Parameters
Name Description
Id integer(int64)

Id of the Task

?$select array[string]

Select properties to be returned

Id, Name, UserAccountId, NextRenewalDate, ParentNextRenewalDate, TotalContractAmount, ParentTotalContractAmount, IsActive, ExternalId, BillingAddressLine1, BillingAddressLine2, BillingAddressCity, BillingAddressState, BillingAddressZip, BillingAddressCountry, StartDate, EndDate, LicenseCount, CrmId, TenureInDays, PrimaryChurnScoreId, PrimaryChurnScoreValue, UsageFrequency, ContactsCount, ParentAccountId, Tags, ObjectCreatedDate, ObjectLastModifiedDate, Cf/SupportOwnerId, Cf/ProductEdition, Cf/Emailcredits, Cf/AtRisk, Cf/UpsellAmount, Cf/CustomerSentiment, Cf/SentimentLastUpdated, Cf/ExecutiveSponsorHasLeft, Cf/Industry, Cf/KpisMet, Cf/Valuescore, Cf/Cstier, Cf/Elpmodel, Cf/EmailCreditsPurchased, Cf/GoLiveDate, Cf/Lifecyclestage, Cf/OnboardingObjective, Cf/TrainingConfigurationNotes, Cf/EngagementScore, Cf/N30DayTimeSpent, Cf/TrainingConfigurationKpisMet, Cf/SalesforceIntegration, Cf/TwitterOauth, Cf/CustomerFit110, Cf/CustomFitExplanation, Cf/Testpicklist, Cf/Outcomes, Cf/OverallColor, Cf/CustomerObjectives, Cf/CurrentSalesVolume, Cf/ToGoal, Cf/NumberOfProjects, Cf/ProjectEffort, Cf/ProjectImpact, Cf/BlogsPublishedLast7, Cf/WeeklyBlogsLimit, Cf/BlogsRemaining, Cf/NotesLastUpdated, Cf/CompetitorsUsed, Cf/Employee, Cf/LicensesPurchased, Cf/AccountPenetration, Cf/ChurnReason, Cf/FeatureUse2, Cf/FeatureUse1, Cf/FeatureTurnedOn, Cf/Covid19IndustryRisk, Cf/Covid19CustomerNotes, Cf/Covid19Tier, Cf/SalesProductFit, Cf/SalesExpectations, Cf/SalesHandoverNotes, Cf/PartnerFit, Cf/PartnerCommunicationCadence, Cf/NumberOfSupportTicketsOverdue, Cf/NumberOfSupportEscalationslastMonth, Cf/WasTheCustomerAcquired, Cf/WasBudgetCut, Cf/DoWeHaveMultipleChampions, Cf/DidWeLoseAChampionThatHasNotBeenReplaced, Cf/Last90DaysNps, Cf/Last90DaysCsat, Cf/TotalPurchasedHoursForCurrentQuarter, Cf/TotalHoursUsed, Cf/FeatureRequests, Cf/Csm, Cf/SalesforceAccountOwner, Cf/SalesforceRegion, Cf/AdvId, Cf/AdSpendTotalLast30Days, Cf/ContractMinimum, Cf/BillingPeriodsInContractPerYear, Cf/ToContractMin
↓ Show Options ↓↑ Hide Options ↑
?$expand array[string]

Expand related entities

*, PrimaryChurnScore, ParentAccount, UserAccount
↓ Show Options ↓↑ Hide Options ↑
Responses
Status Description
200 Account

Retrieved navigation property

400 Error

Bad Request

401 Error

Unauthorized

403 Error

Forbidden

404 Error

Not Found

409 Error

Conflict

429 Error

Too Many Requests

500 Error

Internal Server Error


Get the Contact

GET /Task({Id})/Contact

Code samples

curl -X GET "https://app.churnzero.net/public/v1/Task(1)/Contact" \
-H "Authorization: Basic c29tZXVzZXI6c3VwM3JTM2NyMzch"

200 response

{
  "Id": 5,
  "AccountId": 20,
  "Cf": {
    "Role": "string",
    "AccountexternalId": 1.9,
    "Language": "string",
    "Admin": false,
    "Active": false,
    "LastLogin": "2021-05-11",
    "LicenseType": "string"
  },
  "CrmId": "string",
  "Email": "string",
  "ExternalId": "string",
  "FirstName": "string",
  "FullName": "string",
  "LastName": "string",
  "MarketingEmailUnsubscribed": false,
  "Name": "string",
  "ObjectCreatedDate": "2021-05-11T16:38:27.7261423Z",
  "ObjectLastModifiedDate": "2021-05-11T16:38:27.7261423Z",
  "Tags": "string",
  "Account@odata.navigationLink": "https://app.churnzero.net/public/v1/Contact(5)/Account"
}
Parameters
Name Description
Id integer(int64)

Id of the Task

?$select array[string]

Select properties to be returned

Id, AccountId, FirstName, LastName, FullName, Email, Name, ExternalId, CrmId, MarketingEmailUnsubscribed, Tags, ObjectCreatedDate, ObjectLastModifiedDate, Cf/Role, Cf/AccountexternalId, Cf/Language, Cf/Admin, Cf/Active, Cf/LastLogin, Cf/LicenseType
↓ Show Options ↓↑ Hide Options ↑
?$expand array[string]

Expand related entities

*, Account
↓ Show Options ↓↑ Hide Options ↑
Responses
Status Description
200 Contact

Retrieved navigation property

400 Error

Bad Request

401 Error

Unauthorized

403 Error

Forbidden

404 Error

Not Found

409 Error

Conflict

429 Error

Too Many Requests

500 Error

Internal Server Error


Get the TaskPriority

GET /Task({Id})/TaskPriority

Code samples

curl -X GET "https://app.churnzero.net/public/v1/Task(1)/TaskPriority" \
-H "Authorization: Basic c29tZXVzZXI6c3VwM3JTM2NyMzch"

200 response

{
  "Id": 1,
  "IsDefault": false,
  "IsHighPriority": true,
  "Name": "string"
}
Parameters
Name Description
Id integer(int64)

Id of the Task

?$select array[string]

Select properties to be returned

Id, Name, IsDefault, IsHighPriority
↓ Show Options ↓↑ Hide Options ↑
?$expand array[string]

Expand related entities

*
↓ Show Options ↓↑ Hide Options ↑
Responses
Status Description
200 TaskPriority

Retrieved navigation property

400 Error

Bad Request

401 Error

Unauthorized

403 Error

Forbidden

404 Error

Not Found

409 Error

Conflict

429 Error

Too Many Requests

500 Error

Internal Server Error


Get the TaskStatus

GET /Task({Id})/TaskStatus

Code samples

curl -X GET "https://app.churnzero.net/public/v1/Task(1)/TaskStatus" \
-H "Authorization: Basic c29tZXVzZXI6c3VwM3JTM2NyMzch"

200 response

{
  "Id": 5,
  "IsClosed": true,
  "IsDefault": true,
  "Name": "string"
}
Parameters
Name Description
Id integer(int64)

Id of the Task

?$select array[string]

Select properties to be returned

Id, Name, IsDefault, IsClosed
↓ Show Options ↓↑ Hide Options ↑
?$expand array[string]

Expand related entities

*
↓ Show Options ↓↑ Hide Options ↑
Responses
Status Description
200 TaskStatus

Retrieved navigation property

400 Error

Bad Request

401 Error

Unauthorized

403 Error

Forbidden

404 Error

Not Found

409 Error

Conflict

429 Error

Too Many Requests

500 Error

Internal Server Error


Get the UserAccount

GET /Task({Id})/UserAccount

Code samples

curl -X GET "https://app.churnzero.net/public/v1/Task(1)/UserAccount" \
-H "Authorization: Basic c29tZXVzZXI6c3VwM3JTM2NyMzch"

200 response

{
  "Id": 8,
  "AvatarUrl": "string",
  "CanLogIn": false,
  "Cf": {
    "CalendarLink": "string"
  },
  "CrmId": "string",
  "Email": "string",
  "FirstName": "string",
  "HasAccounts": false,
  "IsActive": true,
  "LastName": "string",
  "MobilePhone": "string",
  "Name": "string",
  "ObjectCreatedDate": "2021-05-11T16:38:27.7373125Z",
  "ObjectLastModifiedDate": "2021-05-11T16:38:27.7373125Z",
  "OfficePhone": "string",
  "Title": "string",
  "UserName": "string"
}
Parameters
Name Description
Id integer(int64)

Id of the Task

?$select array[string]

Select properties to be returned

Id, UserName, FirstName, LastName, Name, Email, HasAccounts, AvatarUrl, MobilePhone, OfficePhone, Title, CanLogIn, CrmId, IsActive, ObjectCreatedDate, ObjectLastModifiedDate, Cf/CalendarLink
↓ Show Options ↓↑ Hide Options ↑
?$expand array[string]

Expand related entities

*
↓ Show Options ↓↑ Hide Options ↑
Responses
Status Description
200 UserAccount

Retrieved navigation property

400 Error

Bad Request

401 Error

Unauthorized

403 Error

Forbidden

404 Error

Not Found

409 Error

Conflict

429 Error

Too Many Requests

500 Error

Internal Server Error


TaskPriority

Task Priority available in ChurnZero.

Permissions

Bulk Read - Tasks


Get all TaskPriorities

GET /TaskPriority

Code samples

curl -X GET "https://app.churnzero.net/public/v1/TaskPriority" \
-H "Authorization: Basic c29tZXVzZXI6c3VwM3JTM2NyMzch"

200 response

{
  "value": [
    {
      "Id": 1,
      "IsDefault": false,
      "IsHighPriority": true,
      "Name": "string"
    }
  ],
  "@odata.nextLink": "https://app.churnzero.net/public/v1/TaskPriority?$skip=100"
}
Parameters
Name Description
?$filter array[string]

Filter items by property values

Id, Name
↓ Show Options ↓↑ Hide Options ↑
?$orderby array[string]

Order items by property values

Id, Name
↓ Show Options ↓↑ Hide Options ↑
?$select array[string]

Select properties to be returned

Id, Name, IsDefault, IsHighPriority
↓ Show Options ↓↑ Hide Options ↑
?$expand array[string]

Expand related entities

*
↓ Show Options ↓↑ Hide Options ↑
?$top integer(int32)

Show only the first n items

?$skip integer(int32)

Skip the first n items

?$count boolean

Include count of items

Responses
Status Description
200 array[TaskPriority]

Retrieved entities

400 Error

Bad Request

401 Error

Unauthorized

403 Error

Forbidden

409 Error

Conflict

429 Error

Too Many Requests

500 Error

Internal Server Error


Get a TaskPriority

GET /TaskPriority({Id})

Code samples

curl -X GET "https://app.churnzero.net/public/v1/TaskPriority(1)" \
-H "Authorization: Basic c29tZXVzZXI6c3VwM3JTM2NyMzch"

200 response

{
  "Id": 1,
  "IsDefault": false,
  "IsHighPriority": true,
  "Name": "string"
}
Parameters
Name Description
Id integer(int64)

Id of the TaskPriority

?$select array[string]

Select properties to be returned

Id, Name, IsDefault, IsHighPriority
↓ Show Options ↓↑ Hide Options ↑
?$expand array[string]

Expand related entities

*
↓ Show Options ↓↑ Hide Options ↑
Responses
Status Description
200 TaskPriority

Retrieved entity

400 Error

Bad Request

401 Error

Unauthorized

403 Error

Forbidden

404 Error

Not Found

409 Error

Conflict

429 Error

Too Many Requests

500 Error

Internal Server Error


TaskStatus

Task Status available in ChurnZero.

Permissions

Bulk Read - Tasks


Get all TaskStatuses

GET /TaskStatus

Code samples

curl -X GET "https://app.churnzero.net/public/v1/TaskStatus" \
-H "Authorization: Basic c29tZXVzZXI6c3VwM3JTM2NyMzch"

200 response

{
  "value": [
    {
      "Id": 5,
      "IsClosed": true,
      "IsDefault": true,
      "Name": "string"
    }
  ],
  "@odata.nextLink": "https://app.churnzero.net/public/v1/TaskStatus?$skip=100"
}
Parameters
Name Description
?$filter array[string]

Filter items by property values

Id, Name
↓ Show Options ↓↑ Hide Options ↑
?$orderby array[string]

Order items by property values

Id, Name
↓ Show Options ↓↑ Hide Options ↑
?$select array[string]

Select properties to be returned

Id, Name, IsDefault, IsClosed
↓ Show Options ↓↑ Hide Options ↑
?$expand array[string]

Expand related entities

*
↓ Show Options ↓↑ Hide Options ↑
?$top integer(int32)

Show only the first n items

?$skip integer(int32)

Skip the first n items

?$count boolean

Include count of items

Responses
Status Description
200 array[TaskStatus]

Retrieved entities

400 Error

Bad Request

401 Error

Unauthorized

403 Error

Forbidden

409 Error

Conflict

429 Error

Too Many Requests

500 Error

Internal Server Error


Get a TaskStatus

GET /TaskStatus({Id})

Code samples

curl -X GET "https://app.churnzero.net/public/v1/TaskStatus(5)" \
-H "Authorization: Basic c29tZXVzZXI6c3VwM3JTM2NyMzch"

200 response

{
  "Id": 5,
  "IsClosed": true,
  "IsDefault": true,
  "Name": "string"
}
Parameters
Name Description
Id integer(int64)

Id of the TaskStatus

?$select array[string]

Select properties to be returned

Id, Name, IsDefault, IsClosed
↓ Show Options ↓↑ Hide Options ↑
?$expand array[string]

Expand related entities

*
↓ Show Options ↓↑ Hide Options ↑
Responses
Status Description
200 TaskStatus

Retrieved entity

400 Error

Bad Request

401 Error

Unauthorized

403 Error

Forbidden

404 Error

Not Found

409 Error

Conflict

429 Error

Too Many Requests

500 Error

Internal Server Error


Survey

Survey definition available in ChurnZero.

Permissions

Bulk Read - Surveys


Get all Surveys

GET /Survey

Code samples

curl -X GET "https://app.churnzero.net/public/v1/Survey" \
-H "Authorization: Basic c29tZXVzZXI6c3VwM3JTM2NyMzch"

200 response

{
  "value": [
    {
      "Id": 4,
      "CampaignStatus": "string",
      "CampaignType": "string",
      "DripOverMonths": 20,
      "FollowUpQuestions": "string",
      "IsActive": true,
      "Name": "string",
      "RecurringEveryMonths": 20,
      "SegmentIds": "string",
      "Settings@odata.navigationLink": "https://app.churnzero.net/public/v1/Survey(4)/Settings",
      "SurveyQuestion": "string",
      "SurveyType": "string"
    }
  ],
  "@odata.nextLink": "https://app.churnzero.net/public/v1/Survey?$skip=100"
}
Parameters
Name Description
?$filter array[string]

Filter items by property values

Id, Name, IsActive, DripOverMonths, RecurringEveryMonths, SurveyType
↓ Show Options ↓↑ Hide Options ↑
?$orderby array[string]

Order items by property values

Id, Name, DripOverMonths, RecurringEveryMonths
↓ Show Options ↓↑ Hide Options ↑
?$select array[string]

Select properties to be returned

Id, Name, IsActive, DripOverMonths, RecurringEveryMonths, SurveyType, CampaignStatus, CampaignType, Settings, SegmentIds, SurveyQuestion, FollowUpQuestions
↓ Show Options ↓↑ Hide Options ↑
?$expand array[string]

Expand related entities

*
↓ Show Options ↓↑ Hide Options ↑
?$top integer(int32)

Show only the first n items

?$skip integer(int32)

Skip the first n items

?$count boolean

Include count of items

Responses
Status Description
200 array[Survey]

Retrieved entities

400 Error

Bad Request

401 Error

Unauthorized

403 Error

Forbidden

409 Error

Conflict

429 Error

Too Many Requests

500 Error

Internal Server Error


Get a Survey

GET /Survey({Id})

Code samples

curl -X GET "https://app.churnzero.net/public/v1/Survey(4)" \
-H "Authorization: Basic c29tZXVzZXI6c3VwM3JTM2NyMzch"

200 response

{
  "Id": 4,
  "CampaignStatus": "string",
  "CampaignType": "string",
  "DripOverMonths": 20,
  "FollowUpQuestions": "string",
  "IsActive": true,
  "Name": "string",
  "RecurringEveryMonths": 20,
  "SegmentIds": "string",
  "Settings@odata.navigationLink": "https://app.churnzero.net/public/v1/Survey(4)/Settings",
  "SurveyQuestion": "string",
  "SurveyType": "string"
}
Parameters
Name Description
Id integer(int64)

Id of the Survey

?$select array[string]

Select properties to be returned

Id, Name, IsActive, DripOverMonths, RecurringEveryMonths, SurveyType, CampaignStatus, CampaignType, Settings, SegmentIds, SurveyQuestion, FollowUpQuestions
↓ Show Options ↓↑ Hide Options ↑
?$expand array[string]

Expand related entities

*
↓ Show Options ↓↑ Hide Options ↑
Responses
Status Description
200 Survey

Retrieved entity

400 Error

Bad Request

401 Error

Unauthorized

403 Error

Forbidden

404 Error

Not Found

409 Error

Conflict

429 Error

Too Many Requests

500 Error

Internal Server Error


SurveyResponse

Survey response collected in ChurnZero for a Survey.

Permissions

Bulk Read - Surveys


Get all SurveyResponses

GET /SurveyResponse

Code samples

curl -X GET "https://app.churnzero.net/public/v1/SurveyResponse" \
-H "Authorization: Basic c29tZXVzZXI6c3VwM3JTM2NyMzch"

200 response

{
  "value": [
    {
      "Id": 6,
      "AccountId": 23,
      "Comment": "string",
      "ContactId": 10,
      "FollowUpAnswerType": "string",
      "FollowUpQuestion": "string",
      "FollowUpResponse": "string",
      "NextReminderDate": "2021-05-11T16:38:27.7927078Z",
      "ResponseDate": "2021-05-11T16:38:27.7927078Z",
      "ResponseSource": "string",
      "Score": 3,
      "SurveyId": 2,
      "Account@odata.navigationLink": "https://app.churnzero.net/public/v1/SurveyResponse(6)/Account",
      "Contact@odata.navigationLink": "https://app.churnzero.net/public/v1/SurveyResponse(6)/Contact",
      "Survey@odata.navigationLink": "https://app.churnzero.net/public/v1/SurveyResponse(6)/Survey"
    }
  ],
  "@odata.nextLink": "https://app.churnzero.net/public/v1/SurveyResponse?$skip=100"
}
Parameters
Name Description
?$filter array[string]

Filter items by property values

Id, AccountId, ContactId, NextReminderDate, SurveyId, ResponseDate
↓ Show Options ↓↑ Hide Options ↑
?$orderby array[string]

Order items by property values

Id, AccountId, ContactId, NextReminderDate, SurveyId, ResponseDate
↓ Show Options ↓↑ Hide Options ↑
?$select array[string]

Select properties to be returned

Id, ContactId, AccountId, NextReminderDate, SurveyId, Score, Comment, ResponseDate, ResponseSource, NextReminderDate, FollowUpResponse, FollowUpQuestion, FollowUpAnswerType
↓ Show Options ↓↑ Hide Options ↑
?$expand array[string]

Expand related entities

*, Account, Contact, Survey
↓ Show Options ↓↑ Hide Options ↑
?$top integer(int32)

Show only the first n items

?$skip integer(int32)

Skip the first n items

?$count boolean

Include count of items

Responses
Status Description
200 array[SurveyResponse]

Retrieved entities

400 Error

Bad Request

401 Error

Unauthorized

403 Error

Forbidden

409 Error

Conflict

429 Error

Too Many Requests

500 Error

Internal Server Error


Get a SurveyResponse

GET /SurveyResponse({Id})

Code samples

curl -X GET "https://app.churnzero.net/public/v1/SurveyResponse(6)" \
-H "Authorization: Basic c29tZXVzZXI6c3VwM3JTM2NyMzch"

200 response

{
  "Id": 6,
  "AccountId": 23,
  "Comment": "string",
  "ContactId": 10,
  "FollowUpAnswerType": "string",
  "FollowUpQuestion": "string",
  "FollowUpResponse": "string",
  "NextReminderDate": "2021-05-11T16:38:27.7927078Z",
  "ResponseDate": "2021-05-11T16:38:27.7927078Z",
  "ResponseSource": "string",
  "Score": 3,
  "SurveyId": 2,
  "Account@odata.navigationLink": "https://app.churnzero.net/public/v1/SurveyResponse(6)/Account",
  "Contact@odata.navigationLink": "https://app.churnzero.net/public/v1/SurveyResponse(6)/Contact",
  "Survey@odata.navigationLink": "https://app.churnzero.net/public/v1/SurveyResponse(6)/Survey"
}
Parameters
Name Description
Id integer(int64)

Id of the SurveyResponse

?$select array[string]

Select properties to be returned

Id, ContactId, AccountId, NextReminderDate, SurveyId, Score, Comment, ResponseDate, ResponseSource, NextReminderDate, FollowUpResponse, FollowUpQuestion, FollowUpAnswerType
↓ Show Options ↓↑ Hide Options ↑
?$expand array[string]

Expand related entities

*, Account, Contact, Survey
↓ Show Options ↓↑ Hide Options ↑
Responses
Status Description
200 SurveyResponse

Retrieved entity

400 Error

Bad Request

401 Error

Unauthorized

403 Error

Forbidden

404 Error

Not Found

409 Error

Conflict

429 Error

Too Many Requests

500 Error

Internal Server Error


Get the Account

GET /SurveyResponse({Id})/Account

Code samples

curl -X GET "https://app.churnzero.net/public/v1/SurveyResponse(6)/Account" \
-H "Authorization: Basic c29tZXVzZXI6c3VwM3JTM2NyMzch"

200 response

{
  "Id": 8,
  "BillingAddressCity": "string",
  "BillingAddressCountry": "string",
  "BillingAddressLine1": "string",
  "BillingAddressLine2": "string",
  "BillingAddressState": "string",
  "BillingAddressZip": "string",
  "Cf": {
    "SupportOwnerId": 15,
    "ProductEdition": "string",
    "Emailcredits": 7.23,
    "AtRisk": true,
    "UpsellAmount": 5.0,
    "CustomerSentiment": "string",
    "SentimentLastUpdated": "2021-05-11",
    "ExecutiveSponsorHasLeft": true,
    "Industry": "string",
    "KpisMet": true,
    "Valuescore": 4.56,
    "Cstier": "string",
    "Elpmodel": "string",
    "EmailCreditsPurchased": 9.13,
    "GoLiveDate": "2021-05-11",
    "Lifecyclestage": "string",
    "OnboardingObjective": "string",
    "TrainingConfigurationNotes": "string",
    "EngagementScore": 9.11,
    "N30DayTimeSpent": 3.64,
    "TrainingConfigurationKpisMet": true,
    "SalesforceIntegration": true,
    "TwitterOauth": false,
    "CustomerFit110": 9.04,
    "CustomFitExplanation": "string",
    "Testpicklist": "string",
    "Outcomes": "string",
    "OverallColor": "string",
    "CustomerObjectives": "string",
    "CurrentSalesVolume": 0.99,
    "ToGoal": 4.94,
    "NumberOfProjects": 4.13,
    "ProjectEffort": "string",
    "ProjectImpact": "string",
    "BlogsPublishedLast7": 9.75,
    "WeeklyBlogsLimit": 9.86,
    "BlogsRemaining": 1.23,
    "NotesLastUpdated": "2021-05-11",
    "CompetitorsUsed": "string",
    "Employee": 5.02,
    "LicensesPurchased": 1.64,
    "AccountPenetration": 7.37,
    "ChurnReason": "string",
    "FeatureUse2": "string",
    "FeatureUse1": "string",
    "FeatureTurnedOn": "string",
    "Covid19IndustryRisk": "string",
    "Covid19CustomerNotes": "string",
    "Covid19Tier": "string",
    "SalesProductFit": "string",
    "SalesExpectations": "string",
    "SalesHandoverNotes": "string",
    "PartnerFit": "string",
    "PartnerCommunicationCadence": "string",
    "NumberOfSupportTicketsOverdue": "string",
    "NumberOfSupportEscalationslastMonth": "string",
    "WasTheCustomerAcquired": "string",
    "WasBudgetCut": "string",
    "DoWeHaveMultipleChampions": "string",
    "DidWeLoseAChampionThatHasNotBeenReplaced": "string",
    "Last90DaysNps": "string",
    "Last90DaysCsat": "string",
    "TotalPurchasedHoursForCurrentQuarter": "string",
    "TotalHoursUsed": "string",
    "FeatureRequests": "string",
    "Csm": "string",
    "SalesforceAccountOwner": "string",
    "SalesforceRegion": "string",
    "AdvId": "string",
    "AdSpendTotalLast30Days": 7.83,
    "ContractMinimum": 1.47,
    "BillingPeriodsInContractPerYear": "string",
    "ToContractMin": 8.81
  },
  "ContactsCount": 16,
  "CrmId": "string",
  "EndDate": "2021-05-11T16:38:27.7138801Z",
  "ExternalId": "string",
  "IsActive": true,
  "LicenseCount": 26,
  "Name": "string",
  "NextRenewalDate": "2021-05-11T16:38:27.7138801Z",
  "ObjectCreatedDate": "2021-05-11T16:38:27.7138801Z",
  "ObjectLastModifiedDate": "2021-05-11T16:38:27.7138801Z",
  "ParentAccountId": 29,
  "ParentNextRenewalDate": "2021-05-11T16:38:27.7138801Z",
  "ParentTotalContractAmount": 9.8,
  "PrimaryChurnScoreId": 9,
  "PrimaryChurnScoreValue": 8.95,
  "StartDate": "2021-05-11T16:38:27.7138801Z",
  "Tags": "string",
  "TenureInDays": 28,
  "TotalContractAmount": 1.22,
  "UsageFrequency": "string",
  "UserAccountId": 9,
  "PrimaryChurnScore@odata.navigationLink": "https://app.churnzero.net/public/v1/Account(8)/PrimaryChurnScore",
  "ParentAccount@odata.navigationLink": "https://app.churnzero.net/public/v1/Account(8)/ParentAccount",
  "UserAccount@odata.navigationLink": "https://app.churnzero.net/public/v1/Account(8)/UserAccount"
}
Parameters
Name Description
Id integer(int64)

Id of the SurveyResponse

?$select array[string]

Select properties to be returned

Id, Name, UserAccountId, NextRenewalDate, ParentNextRenewalDate, TotalContractAmount, ParentTotalContractAmount, IsActive, ExternalId, BillingAddressLine1, BillingAddressLine2, BillingAddressCity, BillingAddressState, BillingAddressZip, BillingAddressCountry, StartDate, EndDate, LicenseCount, CrmId, TenureInDays, PrimaryChurnScoreId, PrimaryChurnScoreValue, UsageFrequency, ContactsCount, ParentAccountId, Tags, ObjectCreatedDate, ObjectLastModifiedDate, Cf/SupportOwnerId, Cf/ProductEdition, Cf/Emailcredits, Cf/AtRisk, Cf/UpsellAmount, Cf/CustomerSentiment, Cf/SentimentLastUpdated, Cf/ExecutiveSponsorHasLeft, Cf/Industry, Cf/KpisMet, Cf/Valuescore, Cf/Cstier, Cf/Elpmodel, Cf/EmailCreditsPurchased, Cf/GoLiveDate, Cf/Lifecyclestage, Cf/OnboardingObjective, Cf/TrainingConfigurationNotes, Cf/EngagementScore, Cf/N30DayTimeSpent, Cf/TrainingConfigurationKpisMet, Cf/SalesforceIntegration, Cf/TwitterOauth, Cf/CustomerFit110, Cf/CustomFitExplanation, Cf/Testpicklist, Cf/Outcomes, Cf/OverallColor, Cf/CustomerObjectives, Cf/CurrentSalesVolume, Cf/ToGoal, Cf/NumberOfProjects, Cf/ProjectEffort, Cf/ProjectImpact, Cf/BlogsPublishedLast7, Cf/WeeklyBlogsLimit, Cf/BlogsRemaining, Cf/NotesLastUpdated, Cf/CompetitorsUsed, Cf/Employee, Cf/LicensesPurchased, Cf/AccountPenetration, Cf/ChurnReason, Cf/FeatureUse2, Cf/FeatureUse1, Cf/FeatureTurnedOn, Cf/Covid19IndustryRisk, Cf/Covid19CustomerNotes, Cf/Covid19Tier, Cf/SalesProductFit, Cf/SalesExpectations, Cf/SalesHandoverNotes, Cf/PartnerFit, Cf/PartnerCommunicationCadence, Cf/NumberOfSupportTicketsOverdue, Cf/NumberOfSupportEscalationslastMonth, Cf/WasTheCustomerAcquired, Cf/WasBudgetCut, Cf/DoWeHaveMultipleChampions, Cf/DidWeLoseAChampionThatHasNotBeenReplaced, Cf/Last90DaysNps, Cf/Last90DaysCsat, Cf/TotalPurchasedHoursForCurrentQuarter, Cf/TotalHoursUsed, Cf/FeatureRequests, Cf/Csm, Cf/SalesforceAccountOwner, Cf/SalesforceRegion, Cf/AdvId, Cf/AdSpendTotalLast30Days, Cf/ContractMinimum, Cf/BillingPeriodsInContractPerYear, Cf/ToContractMin
↓ Show Options ↓↑ Hide Options ↑
?$expand array[string]

Expand related entities

*, PrimaryChurnScore, ParentAccount, UserAccount
↓ Show Options ↓↑ Hide Options ↑
Responses
Status Description
200 Account

Retrieved navigation property

400 Error

Bad Request

401 Error

Unauthorized

403 Error

Forbidden

404 Error

Not Found

409 Error

Conflict

429 Error

Too Many Requests

500 Error

Internal Server Error


Get the Contact

GET /SurveyResponse({Id})/Contact

Code samples

curl -X GET "https://app.churnzero.net/public/v1/SurveyResponse(6)/Contact" \
-H "Authorization: Basic c29tZXVzZXI6c3VwM3JTM2NyMzch"

200 response

{
  "Id": 5,
  "AccountId": 20,
  "Cf": {
    "Role": "string",
    "AccountexternalId": 1.9,
    "Language": "string",
    "Admin": false,
    "Active": false,
    "LastLogin": "2021-05-11",
    "LicenseType": "string"
  },
  "CrmId": "string",
  "Email": "string",
  "ExternalId": "string",
  "FirstName": "string",
  "FullName": "string",
  "LastName": "string",
  "MarketingEmailUnsubscribed": false,
  "Name": "string",
  "ObjectCreatedDate": "2021-05-11T16:38:27.7261423Z",
  "ObjectLastModifiedDate": "2021-05-11T16:38:27.7261423Z",
  "Tags": "string",
  "Account@odata.navigationLink": "https://app.churnzero.net/public/v1/Contact(5)/Account"
}
Parameters
Name Description
Id integer(int64)

Id of the SurveyResponse

?$select array[string]

Select properties to be returned

Id, AccountId, FirstName, LastName, FullName, Email, Name, ExternalId, CrmId, MarketingEmailUnsubscribed, Tags, ObjectCreatedDate, ObjectLastModifiedDate, Cf/Role, Cf/AccountexternalId, Cf/Language, Cf/Admin, Cf/Active, Cf/LastLogin, Cf/LicenseType
↓ Show Options ↓↑ Hide Options ↑
?$expand array[string]

Expand related entities

*, Account
↓ Show Options ↓↑ Hide Options ↑
Responses
Status Description
200 Contact

Retrieved navigation property

400 Error

Bad Request

401 Error

Unauthorized

403 Error

Forbidden

404 Error

Not Found

409 Error

Conflict

429 Error

Too Many Requests

500 Error

Internal Server Error


Get the Survey

GET /SurveyResponse({Id})/Survey

Code samples

curl -X GET "https://app.churnzero.net/public/v1/SurveyResponse(6)/Survey" \
-H "Authorization: Basic c29tZXVzZXI6c3VwM3JTM2NyMzch"

200 response

{
  "Id": 4,
  "CampaignStatus": "string",
  "CampaignType": "string",
  "DripOverMonths": 20,
  "FollowUpQuestions": "string",
  "IsActive": true,
  "Name": "string",
  "RecurringEveryMonths": 20,
  "SegmentIds": "string",
  "Settings@odata.navigationLink": "https://app.churnzero.net/public/v1/Survey(4)/Settings",
  "SurveyQuestion": "string",
  "SurveyType": "string"
}
Parameters
Name Description
Id integer(int64)

Id of the SurveyResponse

?$select array[string]

Select properties to be returned

Id, Name, IsActive, DripOverMonths, RecurringEveryMonths, SurveyType, CampaignStatus, CampaignType, Settings, SegmentIds, SurveyQuestion, FollowUpQuestions
↓ Show Options ↓↑ Hide Options ↑
?$expand array[string]

Expand related entities

*
↓ Show Options ↓↑ Hide Options ↑
Responses
Status Description
200 Survey

Retrieved navigation property

400 Error

Bad Request

401 Error

Unauthorized

403 Error

Forbidden

404 Error

Not Found

409 Error

Conflict

429 Error

Too Many Requests

500 Error

Internal Server Error


ChurnScore

Churn Score available in ChurnZero.

Permissions

Bulk Read - Churn Scores


Get all ChurnScores

GET /ChurnScore

Code samples

curl -X GET "https://app.churnzero.net/public/v1/ChurnScore" \
-H "Authorization: Basic c29tZXVzZXI6c3VwM3JTM2NyMzch"

200 response

{
  "value": [
    {
      "Id": 9,
      "GradingBottom": 6.1,
      "GradingTop": 1.36,
      "Name": "string"
    }
  ],
  "@odata.nextLink": "https://app.churnzero.net/public/v1/ChurnScore?$skip=100"
}
Parameters
Name Description
?$filter array[string]

Filter items by property values

Name, GradingBottom, GradingTop
↓ Show Options ↓↑ Hide Options ↑
?$orderby array[string]

Order items by property values

Name, GradingBottom, GradingTop
↓ Show Options ↓↑ Hide Options ↑
?$select array[string]

Select properties to be returned

Id, Name, GradingBottom, GradingTop
↓ Show Options ↓↑ Hide Options ↑
?$expand array[string]

Expand related entities

*
↓ Show Options ↓↑ Hide Options ↑
?$top integer(int32)

Show only the first n items

?$skip integer(int32)

Skip the first n items

?$count boolean

Include count of items

Responses
Status Description
200 array[ChurnScore]

Retrieved entities

400 Error

Bad Request

401 Error

Unauthorized

403 Error

Forbidden

409 Error

Conflict

429 Error

Too Many Requests

500 Error

Internal Server Error


Get a ChurnScore

GET /ChurnScore({Id})

Code samples

curl -X GET "https://app.churnzero.net/public/v1/ChurnScore(9)" \
-H "Authorization: Basic c29tZXVzZXI6c3VwM3JTM2NyMzch"

200 response

{
  "Id": 9,
  "GradingBottom": 6.1,
  "GradingTop": 1.36,
  "Name": "string"
}
Parameters
Name Description
Id integer(int64)

Id of the ChurnScore

?$select array[string]

Select properties to be returned

Id, Name, GradingBottom, GradingTop
↓ Show Options ↓↑ Hide Options ↑
?$expand array[string]

Expand related entities

*
↓ Show Options ↓↑ Hide Options ↑
Responses
Status Description
200 ChurnScore

Retrieved entity

400 Error

Bad Request

401 Error

Unauthorized

403 Error

Forbidden

404 Error

Not Found

409 Error

Conflict

429 Error

Too Many Requests

500 Error

Internal Server Error


ChurnScoreFactor

Churn Score Factor available in ChurnZero.

Permissions

Bulk Read - Churn Scores


Get all ChurnScoreFactors

GET /ChurnScoreFactor

Code samples

curl -X GET "https://app.churnzero.net/public/v1/ChurnScoreFactor" \
-H "Authorization: Basic c29tZXVzZXI6c3VwM3JTM2NyMzch"

200 response

{
  "value": [
    {
      "Id": 4,
      "ChurnScoreFactorType": "string",
      "ChurnScoreId": 1,
      "Name": "string",
      "ChurnScore@odata.navigationLink": "https://app.churnzero.net/public/v1/ChurnScoreFactor(4)/ChurnScore"
    }
  ],
  "@odata.nextLink": "https://app.churnzero.net/public/v1/ChurnScoreFactor?$skip=100"
}
Parameters
Name Description
?$filter array[string]

Filter items by property values

Name, ChurnScoreId
↓ Show Options ↓↑ Hide Options ↑
?$orderby array[string]

Order items by property values

Name
↓ Show Options ↓↑ Hide Options ↑
?$select array[string]

Select properties to be returned

Id, ChurnScoreId, ChurnScoreFactorType, Name
↓ Show Options ↓↑ Hide Options ↑
?$expand array[string]

Expand related entities

*, ChurnScore
↓ Show Options ↓↑ Hide Options ↑
?$top integer(int32)

Show only the first n items

?$skip integer(int32)

Skip the first n items

?$count boolean

Include count of items

Responses
Status Description
200 array[ChurnScoreFactor]

Retrieved entities

400 Error

Bad Request

401 Error

Unauthorized

403 Error

Forbidden

409 Error

Conflict

429 Error

Too Many Requests

500 Error

Internal Server Error


Get a ChurnScoreFactor

GET /ChurnScoreFactor({Id})

Code samples

curl -X GET "https://app.churnzero.net/public/v1/ChurnScoreFactor(4)" \
-H "Authorization: Basic c29tZXVzZXI6c3VwM3JTM2NyMzch"

200 response

{
  "Id": 4,
  "ChurnScoreFactorType": "string",
  "ChurnScoreId": 1,
  "Name": "string",
  "ChurnScore@odata.navigationLink": "https://app.churnzero.net/public/v1/ChurnScoreFactor(4)/ChurnScore"
}
Parameters
Name Description
Id integer(int64)

Id of the ChurnScoreFactor

?$select array[string]

Select properties to be returned

Id, ChurnScoreId, ChurnScoreFactorType, Name
↓ Show Options ↓↑ Hide Options ↑
?$expand array[string]

Expand related entities

*, ChurnScore
↓ Show Options ↓↑ Hide Options ↑
Responses
Status Description
200 ChurnScoreFactor

Retrieved entity

400 Error

Bad Request

401 Error

Unauthorized

403 Error

Forbidden

404 Error

Not Found

409 Error

Conflict

429 Error

Too Many Requests

500 Error

Internal Server Error


Get the ChurnScore

GET /ChurnScoreFactor({Id})/ChurnScore

Code samples

curl -X GET "https://app.churnzero.net/public/v1/ChurnScoreFactor(4)/ChurnScore" \
-H "Authorization: Basic c29tZXVzZXI6c3VwM3JTM2NyMzch"

200 response

{
  "Id": 9,
  "GradingBottom": 6.1,
  "GradingTop": 1.36,
  "Name": "string"
}
Parameters
Name Description
Id integer(int64)

Id of the ChurnScoreFactor

?$select array[string]

Select properties to be returned

Id, Name, GradingBottom, GradingTop
↓ Show Options ↓↑ Hide Options ↑
?$expand array[string]

Expand related entities

*
↓ Show Options ↓↑ Hide Options ↑
Responses
Status Description
200 ChurnScore

Retrieved navigation property

400 Error

Bad Request

401 Error

Unauthorized

403 Error

Forbidden

404 Error

Not Found

409 Error

Conflict

429 Error

Too Many Requests

500 Error

Internal Server Error


ChurnScoreCalculation

Churn Score Calculation available in ChurnZero.

Permissions

Bulk Read - Churn Scores


Get all ChurnScoreCalculations

GET /ChurnScoreCalculation

Code samples

curl -X GET "https://app.churnzero.net/public/v1/ChurnScoreCalculation" \
-H "Authorization: Basic c29tZXVzZXI6c3VwM3JTM2NyMzch"

200 response

{
  "value": [
    {
      "Id": 3,
      "AccountId": 1,
      "CalculationDay": "2021-05-11",
      "ChurnScoreId": 28,
      "IsActive": false,
      "IsPrimary": false,
      "Score": 6.13,
      "Account@odata.navigationLink": "https://app.churnzero.net/public/v1/ChurnScoreCalculation(3)/Account",
      "ChurnScore@odata.navigationLink": "https://app.churnzero.net/public/v1/ChurnScoreCalculation(3)/ChurnScore"
    }
  ],
  "@odata.nextLink": "https://app.churnzero.net/public/v1/ChurnScoreCalculation?$skip=100"
}
Parameters
Name Description
?$filter array[string]

Filter items by property values

CalculationDay, Score, IsActive, IsPrimary, AccountId, ChurnScoreId
↓ Show Options ↓↑ Hide Options ↑
?$orderby array[string]

Order items by property values

CalculationDay, Score, IsActive, IsPrimary
↓ Show Options ↓↑ Hide Options ↑
?$select array[string]

Select properties to be returned

Id, AccountId, ChurnScoreId, CalculationDay, Score, IsActive, IsPrimary
↓ Show Options ↓↑ Hide Options ↑
?$expand array[string]

Expand related entities

*, Account, ChurnScore
↓ Show Options ↓↑ Hide Options ↑
?$top integer(int32)

Show only the first n items

?$skip integer(int32)

Skip the first n items

?$count boolean

Include count of items

Responses
Status Description
200 array[ChurnScoreCalculation]

Retrieved entities

400 Error

Bad Request

401 Error

Unauthorized

403 Error

Forbidden

409 Error

Conflict

429 Error

Too Many Requests

500 Error

Internal Server Error


Get a ChurnScoreCalculation

GET /ChurnScoreCalculation({Id})

Code samples

curl -X GET "https://app.churnzero.net/public/v1/ChurnScoreCalculation(3)" \
-H "Authorization: Basic c29tZXVzZXI6c3VwM3JTM2NyMzch"

200 response

{
  "Id": 3,
  "AccountId": 1,
  "CalculationDay": "2021-05-11",
  "ChurnScoreId": 28,
  "IsActive": false,
  "IsPrimary": false,
  "Score": 6.13,
  "Account@odata.navigationLink": "https://app.churnzero.net/public/v1/ChurnScoreCalculation(3)/Account",
  "ChurnScore@odata.navigationLink": "https://app.churnzero.net/public/v1/ChurnScoreCalculation(3)/ChurnScore"
}
Parameters
Name Description
Id integer(int64)

Id of the ChurnScoreCalculation

?$select array[string]

Select properties to be returned

Id, AccountId, ChurnScoreId, CalculationDay, Score, IsActive, IsPrimary
↓ Show Options ↓↑ Hide Options ↑
?$expand array[string]

Expand related entities

*, Account, ChurnScore
↓ Show Options ↓↑ Hide Options ↑
Responses
Status Description
200 ChurnScoreCalculation

Retrieved entity

400 Error

Bad Request

401 Error

Unauthorized

403 Error

Forbidden

404 Error

Not Found

409 Error

Conflict

429 Error

Too Many Requests

500 Error

Internal Server Error


Get the Account

GET /ChurnScoreCalculation({Id})/Account

Code samples

curl -X GET "https://app.churnzero.net/public/v1/ChurnScoreCalculation(3)/Account" \
-H "Authorization: Basic c29tZXVzZXI6c3VwM3JTM2NyMzch"

200 response

{
  "Id": 8,
  "BillingAddressCity": "string",
  "BillingAddressCountry": "string",
  "BillingAddressLine1": "string",
  "BillingAddressLine2": "string",
  "BillingAddressState": "string",
  "BillingAddressZip": "string",
  "Cf": {
    "SupportOwnerId": 15,
    "ProductEdition": "string",
    "Emailcredits": 7.23,
    "AtRisk": true,
    "UpsellAmount": 5.0,
    "CustomerSentiment": "string",
    "SentimentLastUpdated": "2021-05-11",
    "ExecutiveSponsorHasLeft": true,
    "Industry": "string",
    "KpisMet": true,
    "Valuescore": 4.56,
    "Cstier": "string",
    "Elpmodel": "string",
    "EmailCreditsPurchased": 9.13,
    "GoLiveDate": "2021-05-11",
    "Lifecyclestage": "string",
    "OnboardingObjective": "string",
    "TrainingConfigurationNotes": "string",
    "EngagementScore": 9.11,
    "N30DayTimeSpent": 3.64,
    "TrainingConfigurationKpisMet": true,
    "SalesforceIntegration": true,
    "TwitterOauth": false,
    "CustomerFit110": 9.04,
    "CustomFitExplanation": "string",
    "Testpicklist": "string",
    "Outcomes": "string",
    "OverallColor": "string",
    "CustomerObjectives": "string",
    "CurrentSalesVolume": 0.99,
    "ToGoal": 4.94,
    "NumberOfProjects": 4.13,
    "ProjectEffort": "string",
    "ProjectImpact": "string",
    "BlogsPublishedLast7": 9.75,
    "WeeklyBlogsLimit": 9.86,
    "BlogsRemaining": 1.23,
    "NotesLastUpdated": "2021-05-11",
    "CompetitorsUsed": "string",
    "Employee": 5.02,
    "LicensesPurchased": 1.64,
    "AccountPenetration": 7.37,
    "ChurnReason": "string",
    "FeatureUse2": "string",
    "FeatureUse1": "string",
    "FeatureTurnedOn": "string",
    "Covid19IndustryRisk": "string",
    "Covid19CustomerNotes": "string",
    "Covid19Tier": "string",
    "SalesProductFit": "string",
    "SalesExpectations": "string",
    "SalesHandoverNotes": "string",
    "PartnerFit": "string",
    "PartnerCommunicationCadence": "string",
    "NumberOfSupportTicketsOverdue": "string",
    "NumberOfSupportEscalationslastMonth": "string",
    "WasTheCustomerAcquired": "string",
    "WasBudgetCut": "string",
    "DoWeHaveMultipleChampions": "string",
    "DidWeLoseAChampionThatHasNotBeenReplaced": "string",
    "Last90DaysNps": "string",
    "Last90DaysCsat": "string",
    "TotalPurchasedHoursForCurrentQuarter": "string",
    "TotalHoursUsed": "string",
    "FeatureRequests": "string",
    "Csm": "string",
    "SalesforceAccountOwner": "string",
    "SalesforceRegion": "string",
    "AdvId": "string",
    "AdSpendTotalLast30Days": 7.83,
    "ContractMinimum": 1.47,
    "BillingPeriodsInContractPerYear": "string",
    "ToContractMin": 8.81
  },
  "ContactsCount": 16,
  "CrmId": "string",
  "EndDate": "2021-05-11T16:38:27.7138801Z",
  "ExternalId": "string",
  "IsActive": true,
  "LicenseCount": 26,
  "Name": "string",
  "NextRenewalDate": "2021-05-11T16:38:27.7138801Z",
  "ObjectCreatedDate": "2021-05-11T16:38:27.7138801Z",
  "ObjectLastModifiedDate": "2021-05-11T16:38:27.7138801Z",
  "ParentAccountId": 29,
  "ParentNextRenewalDate": "2021-05-11T16:38:27.7138801Z",
  "ParentTotalContractAmount": 9.8,
  "PrimaryChurnScoreId": 9,
  "PrimaryChurnScoreValue": 8.95,
  "StartDate": "2021-05-11T16:38:27.7138801Z",
  "Tags": "string",
  "TenureInDays": 28,
  "TotalContractAmount": 1.22,
  "UsageFrequency": "string",
  "UserAccountId": 9,
  "PrimaryChurnScore@odata.navigationLink": "https://app.churnzero.net/public/v1/Account(8)/PrimaryChurnScore",
  "ParentAccount@odata.navigationLink": "https://app.churnzero.net/public/v1/Account(8)/ParentAccount",
  "UserAccount@odata.navigationLink": "https://app.churnzero.net/public/v1/Account(8)/UserAccount"
}
Parameters
Name Description
Id integer(int64)

Id of the ChurnScoreCalculation

?$select array[string]

Select properties to be returned

Id, Name, UserAccountId, NextRenewalDate, ParentNextRenewalDate, TotalContractAmount, ParentTotalContractAmount, IsActive, ExternalId, BillingAddressLine1, BillingAddressLine2, BillingAddressCity, BillingAddressState, BillingAddressZip, BillingAddressCountry, StartDate, EndDate, LicenseCount, CrmId, TenureInDays, PrimaryChurnScoreId, PrimaryChurnScoreValue, UsageFrequency, ContactsCount, ParentAccountId, Tags, ObjectCreatedDate, ObjectLastModifiedDate, Cf/SupportOwnerId, Cf/ProductEdition, Cf/Emailcredits, Cf/AtRisk, Cf/UpsellAmount, Cf/CustomerSentiment, Cf/SentimentLastUpdated, Cf/ExecutiveSponsorHasLeft, Cf/Industry, Cf/KpisMet, Cf/Valuescore, Cf/Cstier, Cf/Elpmodel, Cf/EmailCreditsPurchased, Cf/GoLiveDate, Cf/Lifecyclestage, Cf/OnboardingObjective, Cf/TrainingConfigurationNotes, Cf/EngagementScore, Cf/N30DayTimeSpent, Cf/TrainingConfigurationKpisMet, Cf/SalesforceIntegration, Cf/TwitterOauth, Cf/CustomerFit110, Cf/CustomFitExplanation, Cf/Testpicklist, Cf/Outcomes, Cf/OverallColor, Cf/CustomerObjectives, Cf/CurrentSalesVolume, Cf/ToGoal, Cf/NumberOfProjects, Cf/ProjectEffort, Cf/ProjectImpact, Cf/BlogsPublishedLast7, Cf/WeeklyBlogsLimit, Cf/BlogsRemaining, Cf/NotesLastUpdated, Cf/CompetitorsUsed, Cf/Employee, Cf/LicensesPurchased, Cf/AccountPenetration, Cf/ChurnReason, Cf/FeatureUse2, Cf/FeatureUse1, Cf/FeatureTurnedOn, Cf/Covid19IndustryRisk, Cf/Covid19CustomerNotes, Cf/Covid19Tier, Cf/SalesProductFit, Cf/SalesExpectations, Cf/SalesHandoverNotes, Cf/PartnerFit, Cf/PartnerCommunicationCadence, Cf/NumberOfSupportTicketsOverdue, Cf/NumberOfSupportEscalationslastMonth, Cf/WasTheCustomerAcquired, Cf/WasBudgetCut, Cf/DoWeHaveMultipleChampions, Cf/DidWeLoseAChampionThatHasNotBeenReplaced, Cf/Last90DaysNps, Cf/Last90DaysCsat, Cf/TotalPurchasedHoursForCurrentQuarter, Cf/TotalHoursUsed, Cf/FeatureRequests, Cf/Csm, Cf/SalesforceAccountOwner, Cf/SalesforceRegion, Cf/AdvId, Cf/AdSpendTotalLast30Days, Cf/ContractMinimum, Cf/BillingPeriodsInContractPerYear, Cf/ToContractMin
↓ Show Options ↓↑ Hide Options ↑
?$expand array[string]

Expand related entities

*, PrimaryChurnScore, ParentAccount, UserAccount
↓ Show Options ↓↑ Hide Options ↑
Responses
Status Description
200 Account

Retrieved navigation property

400 Error

Bad Request

401 Error

Unauthorized

403 Error

Forbidden

404 Error

Not Found

409 Error

Conflict

429 Error

Too Many Requests

500 Error

Internal Server Error


Get the ChurnScore

GET /ChurnScoreCalculation({Id})/ChurnScore

Code samples

curl -X GET "https://app.churnzero.net/public/v1/ChurnScoreCalculation(3)/ChurnScore" \
-H "Authorization: Basic c29tZXVzZXI6c3VwM3JTM2NyMzch"

200 response

{
  "Id": 9,
  "GradingBottom": 6.1,
  "GradingTop": 1.36,
  "Name": "string"
}
Parameters
Name Description
Id integer(int64)

Id of the ChurnScoreCalculation

?$select array[string]

Select properties to be returned

Id, Name, GradingBottom, GradingTop
↓ Show Options ↓↑ Hide Options ↑
?$expand array[string]

Expand related entities

*
↓ Show Options ↓↑ Hide Options ↑
Responses
Status Description
200 ChurnScore

Retrieved navigation property

400 Error

Bad Request

401 Error

Unauthorized

403 Error

Forbidden

404 Error

Not Found

409 Error

Conflict

429 Error

Too Many Requests

500 Error

Internal Server Error


ChurnScoreFactorCalculation

Churn Score Factor Calculation available in ChurnZero.

Permissions

Bulk Read - Churn Scores


Get all ChurnScoreFactorCalculations

GET /ChurnScoreFactorCalculation

Code samples

curl -X GET "https://app.churnzero.net/public/v1/ChurnScoreFactorCalculation" \
-H "Authorization: Basic c29tZXVzZXI6c3VwM3JTM2NyMzch"

200 response

{
  "value": [
    {
      "Id": 8,
      "AccountId": 26,
      "CalculationDay": "2021-05-11",
      "ChurnScoreFactorId": 4,
      "ChurnScoreId": 29,
      "Score": 8.78,
      "Account@odata.navigationLink": "https://app.churnzero.net/public/v1/ChurnScoreFactorCalculation(8)/Account",
      "ChurnScore@odata.navigationLink": "https://app.churnzero.net/public/v1/ChurnScoreFactorCalculation(8)/ChurnScore",
      "ChurnScoreFactor@odata.navigationLink": "https://app.churnzero.net/public/v1/ChurnScoreFactorCalculation(8)/ChurnScoreFactor"
    }
  ],
  "@odata.nextLink": "https://app.churnzero.net/public/v1/ChurnScoreFactorCalculation?$skip=100"
}
Parameters
Name Description
?$filter array[string]

Filter items by property values

CalculationDay, Score, AccountId, ChurnScoreId, ChurnScoreFactorId
↓ Show Options ↓↑ Hide Options ↑
?$orderby array[string]

Order items by property values

CalculationDay, Score
↓ Show Options ↓↑ Hide Options ↑
?$select array[string]

Select properties to be returned

Id, AccountId, ChurnScoreId, CalculationDay, ChurnScoreFactorId, Score, ChurnScoreFactor
↓ Show Options ↓↑ Hide Options ↑
?$expand array[string]

Expand related entities

*, Account, ChurnScore, ChurnScoreFactor
↓ Show Options ↓↑ Hide Options ↑
?$top integer(int32)

Show only the first n items

?$skip integer(int32)

Skip the first n items

?$count boolean

Include count of items

Responses
Status Description
200 array[ChurnScoreFactorCalculation]

Retrieved entities

400 Error

Bad Request

401 Error

Unauthorized

403 Error

Forbidden

409 Error

Conflict

429 Error

Too Many Requests

500 Error

Internal Server Error


Get a ChurnScoreFactorCalculation

GET /ChurnScoreFactorCalculation({Id})

Code samples

curl -X GET "https://app.churnzero.net/public/v1/ChurnScoreFactorCalculation(8)" \
-H "Authorization: Basic c29tZXVzZXI6c3VwM3JTM2NyMzch"

200 response

{
  "Id": 8,
  "AccountId": 26,
  "CalculationDay": "2021-05-11",
  "ChurnScoreFactorId": 4,
  "ChurnScoreId": 29,
  "Score": 8.78,
  "Account@odata.navigationLink": "https://app.churnzero.net/public/v1/ChurnScoreFactorCalculation(8)/Account",
  "ChurnScore@odata.navigationLink": "https://app.churnzero.net/public/v1/ChurnScoreFactorCalculation(8)/ChurnScore",
  "ChurnScoreFactor@odata.navigationLink": "https://app.churnzero.net/public/v1/ChurnScoreFactorCalculation(8)/ChurnScoreFactor"
}
Parameters
Name Description
Id integer(int64)

Id of the ChurnScoreFactorCalculation

?$select array[string]

Select properties to be returned

Id, AccountId, ChurnScoreId, CalculationDay, ChurnScoreFactorId, Score, ChurnScoreFactor
↓ Show Options ↓↑ Hide Options ↑
?$expand array[string]

Expand related entities

*, Account, ChurnScore, ChurnScoreFactor
↓ Show Options ↓↑ Hide Options ↑
Responses
Status Description
200 ChurnScoreFactorCalculation

Retrieved entity

400 Error

Bad Request

401 Error

Unauthorized

403 Error

Forbidden

404 Error

Not Found

409 Error

Conflict

429 Error

Too Many Requests

500 Error

Internal Server Error


Get the Account

GET /ChurnScoreFactorCalculation({Id})/Account

Code samples

curl -X GET "https://app.churnzero.net/public/v1/ChurnScoreFactorCalculation(8)/Account" \
-H "Authorization: Basic c29tZXVzZXI6c3VwM3JTM2NyMzch"

200 response

{
  "Id": 8,
  "BillingAddressCity": "string",
  "BillingAddressCountry": "string",
  "BillingAddressLine1": "string",
  "BillingAddressLine2": "string",
  "BillingAddressState": "string",
  "BillingAddressZip": "string",
  "Cf": {
    "SupportOwnerId": 15,
    "ProductEdition": "string",
    "Emailcredits": 7.23,
    "AtRisk": true,
    "UpsellAmount": 5.0,
    "CustomerSentiment": "string",
    "SentimentLastUpdated": "2021-05-11",
    "ExecutiveSponsorHasLeft": true,
    "Industry": "string",
    "KpisMet": true,
    "Valuescore": 4.56,
    "Cstier": "string",
    "Elpmodel": "string",
    "EmailCreditsPurchased": 9.13,
    "GoLiveDate": "2021-05-11",
    "Lifecyclestage": "string",
    "OnboardingObjective": "string",
    "TrainingConfigurationNotes": "string",
    "EngagementScore": 9.11,
    "N30DayTimeSpent": 3.64,
    "TrainingConfigurationKpisMet": true,
    "SalesforceIntegration": true,
    "TwitterOauth": false,
    "CustomerFit110": 9.04,
    "CustomFitExplanation": "string",
    "Testpicklist": "string",
    "Outcomes": "string",
    "OverallColor": "string",
    "CustomerObjectives": "string",
    "CurrentSalesVolume": 0.99,
    "ToGoal": 4.94,
    "NumberOfProjects": 4.13,
    "ProjectEffort": "string",
    "ProjectImpact": "string",
    "BlogsPublishedLast7": 9.75,
    "WeeklyBlogsLimit": 9.86,
    "BlogsRemaining": 1.23,
    "NotesLastUpdated": "2021-05-11",
    "CompetitorsUsed": "string",
    "Employee": 5.02,
    "LicensesPurchased": 1.64,
    "AccountPenetration": 7.37,
    "ChurnReason": "string",
    "FeatureUse2": "string",
    "FeatureUse1": "string",
    "FeatureTurnedOn": "string",
    "Covid19IndustryRisk": "string",
    "Covid19CustomerNotes": "string",
    "Covid19Tier": "string",
    "SalesProductFit": "string",
    "SalesExpectations": "string",
    "SalesHandoverNotes": "string",
    "PartnerFit": "string",
    "PartnerCommunicationCadence": "string",
    "NumberOfSupportTicketsOverdue": "string",
    "NumberOfSupportEscalationslastMonth": "string",
    "WasTheCustomerAcquired": "string",
    "WasBudgetCut": "string",
    "DoWeHaveMultipleChampions": "string",
    "DidWeLoseAChampionThatHasNotBeenReplaced": "string",
    "Last90DaysNps": "string",
    "Last90DaysCsat": "string",
    "TotalPurchasedHoursForCurrentQuarter": "string",
    "TotalHoursUsed": "string",
    "FeatureRequests": "string",
    "Csm": "string",
    "SalesforceAccountOwner": "string",
    "SalesforceRegion": "string",
    "AdvId": "string",
    "AdSpendTotalLast30Days": 7.83,
    "ContractMinimum": 1.47,
    "BillingPeriodsInContractPerYear": "string",
    "ToContractMin": 8.81
  },
  "ContactsCount": 16,
  "CrmId": "string",
  "EndDate": "2021-05-11T16:38:27.7138801Z",
  "ExternalId": "string",
  "IsActive": true,
  "LicenseCount": 26,
  "Name": "string",
  "NextRenewalDate": "2021-05-11T16:38:27.7138801Z",
  "ObjectCreatedDate": "2021-05-11T16:38:27.7138801Z",
  "ObjectLastModifiedDate": "2021-05-11T16:38:27.7138801Z",
  "ParentAccountId": 29,
  "ParentNextRenewalDate": "2021-05-11T16:38:27.7138801Z",
  "ParentTotalContractAmount": 9.8,
  "PrimaryChurnScoreId": 9,
  "PrimaryChurnScoreValue": 8.95,
  "StartDate": "2021-05-11T16:38:27.7138801Z",
  "Tags": "string",
  "TenureInDays": 28,
  "TotalContractAmount": 1.22,
  "UsageFrequency": "string",
  "UserAccountId": 9,
  "PrimaryChurnScore@odata.navigationLink": "https://app.churnzero.net/public/v1/Account(8)/PrimaryChurnScore",
  "ParentAccount@odata.navigationLink": "https://app.churnzero.net/public/v1/Account(8)/ParentAccount",
  "UserAccount@odata.navigationLink": "https://app.churnzero.net/public/v1/Account(8)/UserAccount"
}
Parameters
Name Description
Id integer(int64)

Id of the ChurnScoreFactorCalculation

?$select array[string]

Select properties to be returned

Id, Name, UserAccountId, NextRenewalDate, ParentNextRenewalDate, TotalContractAmount, ParentTotalContractAmount, IsActive, ExternalId, BillingAddressLine1, BillingAddressLine2, BillingAddressCity, BillingAddressState, BillingAddressZip, BillingAddressCountry, StartDate, EndDate, LicenseCount, CrmId, TenureInDays, PrimaryChurnScoreId, PrimaryChurnScoreValue, UsageFrequency, ContactsCount, ParentAccountId, Tags, ObjectCreatedDate, ObjectLastModifiedDate, Cf/SupportOwnerId, Cf/ProductEdition, Cf/Emailcredits, Cf/AtRisk, Cf/UpsellAmount, Cf/CustomerSentiment, Cf/SentimentLastUpdated, Cf/ExecutiveSponsorHasLeft, Cf/Industry, Cf/KpisMet, Cf/Valuescore, Cf/Cstier, Cf/Elpmodel, Cf/EmailCreditsPurchased, Cf/GoLiveDate, Cf/Lifecyclestage, Cf/OnboardingObjective, Cf/TrainingConfigurationNotes, Cf/EngagementScore, Cf/N30DayTimeSpent, Cf/TrainingConfigurationKpisMet, Cf/SalesforceIntegration, Cf/TwitterOauth, Cf/CustomerFit110, Cf/CustomFitExplanation, Cf/Testpicklist, Cf/Outcomes, Cf/OverallColor, Cf/CustomerObjectives, Cf/CurrentSalesVolume, Cf/ToGoal, Cf/NumberOfProjects, Cf/ProjectEffort, Cf/ProjectImpact, Cf/BlogsPublishedLast7, Cf/WeeklyBlogsLimit, Cf/BlogsRemaining, Cf/NotesLastUpdated, Cf/CompetitorsUsed, Cf/Employee, Cf/LicensesPurchased, Cf/AccountPenetration, Cf/ChurnReason, Cf/FeatureUse2, Cf/FeatureUse1, Cf/FeatureTurnedOn, Cf/Covid19IndustryRisk, Cf/Covid19CustomerNotes, Cf/Covid19Tier, Cf/SalesProductFit, Cf/SalesExpectations, Cf/SalesHandoverNotes, Cf/PartnerFit, Cf/PartnerCommunicationCadence, Cf/NumberOfSupportTicketsOverdue, Cf/NumberOfSupportEscalationslastMonth, Cf/WasTheCustomerAcquired, Cf/WasBudgetCut, Cf/DoWeHaveMultipleChampions, Cf/DidWeLoseAChampionThatHasNotBeenReplaced, Cf/Last90DaysNps, Cf/Last90DaysCsat, Cf/TotalPurchasedHoursForCurrentQuarter, Cf/TotalHoursUsed, Cf/FeatureRequests, Cf/Csm, Cf/SalesforceAccountOwner, Cf/SalesforceRegion, Cf/AdvId, Cf/AdSpendTotalLast30Days, Cf/ContractMinimum, Cf/BillingPeriodsInContractPerYear, Cf/ToContractMin
↓ Show Options ↓↑ Hide Options ↑
?$expand array[string]

Expand related entities

*, PrimaryChurnScore, ParentAccount, UserAccount
↓ Show Options ↓↑ Hide Options ↑
Responses
Status Description
200 Account

Retrieved navigation property

400 Error

Bad Request

401 Error

Unauthorized

403 Error

Forbidden

404 Error

Not Found

409 Error

Conflict

429 Error

Too Many Requests

500 Error

Internal Server Error


Get the ChurnScore

GET /ChurnScoreFactorCalculation({Id})/ChurnScore

Code samples

curl -X GET "https://app.churnzero.net/public/v1/ChurnScoreFactorCalculation(8)/ChurnScore" \
-H "Authorization: Basic c29tZXVzZXI6c3VwM3JTM2NyMzch"

200 response

{
  "Id": 9,
  "GradingBottom": 6.1,
  "GradingTop": 1.36,
  "Name": "string"
}
Parameters
Name Description
Id integer(int64)

Id of the ChurnScoreFactorCalculation

?$select array[string]

Select properties to be returned

Id, Name, GradingBottom, GradingTop
↓ Show Options ↓↑ Hide Options ↑
?$expand array[string]

Expand related entities

*
↓ Show Options ↓↑ Hide Options ↑
Responses
Status Description
200 ChurnScore

Retrieved navigation property

400 Error

Bad Request

401 Error

Unauthorized

403 Error

Forbidden

404 Error

Not Found

409 Error

Conflict

429 Error

Too Many Requests

500 Error

Internal Server Error


Get the ChurnScoreFactor

GET /ChurnScoreFactorCalculation({Id})/ChurnScoreFactor

Code samples

curl -X GET "https://app.churnzero.net/public/v1/ChurnScoreFactorCalculation(8)/ChurnScoreFactor" \
-H "Authorization: Basic c29tZXVzZXI6c3VwM3JTM2NyMzch"

200 response

{
  "Id": 4,
  "ChurnScoreFactorType": "string",
  "ChurnScoreId": 1,
  "Name": "string",
  "ChurnScore@odata.navigationLink": "https://app.churnzero.net/public/v1/ChurnScoreFactor(4)/ChurnScore"
}
Parameters
Name Description
Id integer(int64)

Id of the ChurnScoreFactorCalculation

?$select array[string]

Select properties to be returned

Id, ChurnScoreId, ChurnScoreFactorType, Name
↓ Show Options ↓↑ Hide Options ↑
?$expand array[string]

Expand related entities

*, ChurnScore
↓ Show Options ↓↑ Hide Options ↑
Responses
Status Description
200 ChurnScoreFactor

Retrieved navigation property

400 Error

Bad Request

401 Error

Unauthorized

403 Error

Forbidden

404 Error

Not Found

409 Error

Conflict

429 Error

Too Many Requests

500 Error

Internal Server Error


CustomListTicket

Link to Zendesk Ticket Connected to Zendesk Support entity Ticket.

Permissions

Bulk Read - Custom Tables


Get all CustomTickets

GET /CustomListTicket

Code samples

curl -X GET "https://app.churnzero.net/public/v1/CustomListTicket" \
-H "Authorization: Basic c29tZXVzZXI6c3VwM3JTM2NyMzch"

200 response

{
  "value": [
    {
      "Id": 4,
      "AccountId": 2,
      "Assignee": "string",
      "Commentcount": 8.65,
      "ContactId": 24,
      "Createdat": "2021-05-11T16:38:27.8311758Z",
      "CzAlertMarker": true,
      "Description": "string",
      "Dueat": "2021-05-11T16:38:27.8311758Z",
      "ObjectCreatedDate": "2021-05-11T16:38:27.8311758Z",
      "ObjectLastModifiedDate": "2021-05-11T16:38:27.8311758Z",
      "Priority": "string",
      "Recipient": "string",
      "Requester": "string",
      "Status": "string",
      "Subject": "string",
      "Submitter": "string",
      "Type": "string",
      "Updatedat": "2021-05-11T16:38:27.8311758Z",
      "UseraccountId": 28,
      "Account@odata.navigationLink": "https://app.churnzero.net/public/v1/CustomListTicket(4)/Account",
      "Contact@odata.navigationLink": "https://app.churnzero.net/public/v1/CustomListTicket(4)/Contact",
      "Useraccount@odata.navigationLink": "https://app.churnzero.net/public/v1/CustomListTicket(4)/Useraccount"
    }
  ],
  "@odata.nextLink": "https://app.churnzero.net/public/v1/CustomListTicket?$skip=100"
}
Parameters
Name Description
?$filter array[string]

Filter items by property values

Type, Subject, Priority, Status, Recipient, Dueat, Createdat, Updatedat, Commentcount, Requester, Submitter, Assignee, AccountId, ContactId, UseraccountId, Use/SegmentId, Use/SegmentColumnSetId
↓ Show Options ↓↑ Hide Options ↑
?$orderby array[string]

Order items by property values

ObjectCreatedDate, ObjectLastModifiedDate, Type, Subject, Priority, Status, Recipient, Dueat, Createdat, Updatedat, Commentcount, Requester, Submitter, Assignee
↓ Show Options ↓↑ Hide Options ↑
?$select array[string]

Select properties to be returned

CrmId, Type, Subject, Description, Priority, Status, Recipient, Dueat, Createdat, Updatedat, Commentcount, Requester, Submitter, Assignee, AccountId, ContactId, UseraccountId, CzAlertMarker
↓ Show Options ↓↑ Hide Options ↑
?$expand array[string]

Expand related entities

*, Account, Contact, Useraccount
↓ Show Options ↓↑ Hide Options ↑
?$top integer(int32)

Show only the first n items

?$skip integer(int32)

Skip the first n items

?$count boolean

Include count of items

Responses
Status Description
200 array[CustomListTicket]

Retrieved entities

400 Error

Bad Request

401 Error

Unauthorized

403 Error

Forbidden

409 Error

Conflict

429 Error

Too Many Requests

500 Error

Internal Server Error


Get a CustomListTicket

GET /CustomListTicket({Id})

Code samples

curl -X GET "https://app.churnzero.net/public/v1/CustomListTicket(4)" \
-H "Authorization: Basic c29tZXVzZXI6c3VwM3JTM2NyMzch"

200 response

{
  "Id": 4,
  "AccountId": 2,
  "Assignee": "string",
  "Commentcount": 8.65,
  "ContactId": 24,
  "Createdat": "2021-05-11T16:38:27.8311758Z",
  "CzAlertMarker": true,
  "Description": "string",
  "Dueat": "2021-05-11T16:38:27.8311758Z",
  "ObjectCreatedDate": "2021-05-11T16:38:27.8311758Z",
  "ObjectLastModifiedDate": "2021-05-11T16:38:27.8311758Z",
  "Priority": "string",
  "Recipient": "string",
  "Requester": "string",
  "Status": "string",
  "Subject": "string",
  "Submitter": "string",
  "Type": "string",
  "Updatedat": "2021-05-11T16:38:27.8311758Z",
  "UseraccountId": 28,
  "Account@odata.navigationLink": "https://app.churnzero.net/public/v1/CustomListTicket(4)/Account",
  "Contact@odata.navigationLink": "https://app.churnzero.net/public/v1/CustomListTicket(4)/Contact",
  "Useraccount@odata.navigationLink": "https://app.churnzero.net/public/v1/CustomListTicket(4)/Useraccount"
}
Parameters
Name Description
Id integer(int64)

Id of CustomListTicket

?$select array[string]

Select properties to be returned

CrmId, Type, Subject, Description, Priority, Status, Recipient, Dueat, Createdat, Updatedat, Commentcount, Requester, Submitter, Assignee, AccountId, ContactId, UseraccountId, CzAlertMarker
↓ Show Options ↓↑ Hide Options ↑
?$expand array[string]

Expand related entities

*, Account, Contact, Useraccount
↓ Show Options ↓↑ Hide Options ↑
Responses
Status Description
200 CustomListTicket

Retrieved entity

400 Error

Bad Request

401 Error

Unauthorized

403 Error

Forbidden

404 Error

Not Found

409 Error

Conflict

429 Error

Too Many Requests

500 Error

Internal Server Error


Get the Account

GET /CustomListTicket({Id})/Account

Code samples

curl -X GET "https://app.churnzero.net/public/v1/CustomListTicket(4)/Account" \
-H "Authorization: Basic c29tZXVzZXI6c3VwM3JTM2NyMzch"

200 response

{
  "Id": 8,
  "BillingAddressCity": "string",
  "BillingAddressCountry": "string",
  "BillingAddressLine1": "string",
  "BillingAddressLine2": "string",
  "BillingAddressState": "string",
  "BillingAddressZip": "string",
  "Cf": {
    "SupportOwnerId": 15,
    "ProductEdition": "string",
    "Emailcredits": 7.23,
    "AtRisk": true,
    "UpsellAmount": 5.0,
    "CustomerSentiment": "string",
    "SentimentLastUpdated": "2021-05-11",
    "ExecutiveSponsorHasLeft": true,
    "Industry": "string",
    "KpisMet": true,
    "Valuescore": 4.56,
    "Cstier": "string",
    "Elpmodel": "string",
    "EmailCreditsPurchased": 9.13,
    "GoLiveDate": "2021-05-11",
    "Lifecyclestage": "string",
    "OnboardingObjective": "string",
    "TrainingConfigurationNotes": "string",
    "EngagementScore": 9.11,
    "N30DayTimeSpent": 3.64,
    "TrainingConfigurationKpisMet": true,
    "SalesforceIntegration": true,
    "TwitterOauth": false,
    "CustomerFit110": 9.04,
    "CustomFitExplanation": "string",
    "Testpicklist": "string",
    "Outcomes": "string",
    "OverallColor": "string",
    "CustomerObjectives": "string",
    "CurrentSalesVolume": 0.99,
    "ToGoal": 4.94,
    "NumberOfProjects": 4.13,
    "ProjectEffort": "string",
    "ProjectImpact": "string",
    "BlogsPublishedLast7": 9.75,
    "WeeklyBlogsLimit": 9.86,
    "BlogsRemaining": 1.23,
    "NotesLastUpdated": "2021-05-11",
    "CompetitorsUsed": "string",
    "Employee": 5.02,
    "LicensesPurchased": 1.64,
    "AccountPenetration": 7.37,
    "ChurnReason": "string",
    "FeatureUse2": "string",
    "FeatureUse1": "string",
    "FeatureTurnedOn": "string",
    "Covid19IndustryRisk": "string",
    "Covid19CustomerNotes": "string",
    "Covid19Tier": "string",
    "SalesProductFit": "string",
    "SalesExpectations": "string",
    "SalesHandoverNotes": "string",
    "PartnerFit": "string",
    "PartnerCommunicationCadence": "string",
    "NumberOfSupportTicketsOverdue": "string",
    "NumberOfSupportEscalationslastMonth": "string",
    "WasTheCustomerAcquired": "string",
    "WasBudgetCut": "string",
    "DoWeHaveMultipleChampions": "string",
    "DidWeLoseAChampionThatHasNotBeenReplaced": "string",
    "Last90DaysNps": "string",
    "Last90DaysCsat": "string",
    "TotalPurchasedHoursForCurrentQuarter": "string",
    "TotalHoursUsed": "string",
    "FeatureRequests": "string",
    "Csm": "string",
    "SalesforceAccountOwner": "string",
    "SalesforceRegion": "string",
    "AdvId": "string",
    "AdSpendTotalLast30Days": 7.83,
    "ContractMinimum": 1.47,
    "BillingPeriodsInContractPerYear": "string",
    "ToContractMin": 8.81
  },
  "ContactsCount": 16,
  "CrmId": "string",
  "EndDate": "2021-05-11T16:38:27.7138801Z",
  "ExternalId": "string",
  "IsActive": true,
  "LicenseCount": 26,
  "Name": "string",
  "NextRenewalDate": "2021-05-11T16:38:27.7138801Z",
  "ObjectCreatedDate": "2021-05-11T16:38:27.7138801Z",
  "ObjectLastModifiedDate": "2021-05-11T16:38:27.7138801Z",
  "ParentAccountId": 29,
  "ParentNextRenewalDate": "2021-05-11T16:38:27.7138801Z",
  "ParentTotalContractAmount": 9.8,
  "PrimaryChurnScoreId": 9,
  "PrimaryChurnScoreValue": 8.95,
  "StartDate": "2021-05-11T16:38:27.7138801Z",
  "Tags": "string",
  "TenureInDays": 28,
  "TotalContractAmount": 1.22,
  "UsageFrequency": "string",
  "UserAccountId": 9,
  "PrimaryChurnScore@odata.navigationLink": "https://app.churnzero.net/public/v1/Account(8)/PrimaryChurnScore",
  "ParentAccount@odata.navigationLink": "https://app.churnzero.net/public/v1/Account(8)/ParentAccount",
  "UserAccount@odata.navigationLink": "https://app.churnzero.net/public/v1/Account(8)/UserAccount"
}
Parameters
Name Description
Id integer(int64)

Id of CustomListTicket

?$select array[string]

Select properties to be returned

Id, Name, UserAccountId, NextRenewalDate, ParentNextRenewalDate, TotalContractAmount, ParentTotalContractAmount, IsActive, ExternalId, BillingAddressLine1, BillingAddressLine2, BillingAddressCity, BillingAddressState, BillingAddressZip, BillingAddressCountry, StartDate, EndDate, LicenseCount, CrmId, TenureInDays, PrimaryChurnScoreId, PrimaryChurnScoreValue, UsageFrequency, ContactsCount, ParentAccountId, Tags, ObjectCreatedDate, ObjectLastModifiedDate, Cf/SupportOwnerId, Cf/ProductEdition, Cf/Emailcredits, Cf/AtRisk, Cf/UpsellAmount, Cf/CustomerSentiment, Cf/SentimentLastUpdated, Cf/ExecutiveSponsorHasLeft, Cf/Industry, Cf/KpisMet, Cf/Valuescore, Cf/Cstier, Cf/Elpmodel, Cf/EmailCreditsPurchased, Cf/GoLiveDate, Cf/Lifecyclestage, Cf/OnboardingObjective, Cf/TrainingConfigurationNotes, Cf/EngagementScore, Cf/N30DayTimeSpent, Cf/TrainingConfigurationKpisMet, Cf/SalesforceIntegration, Cf/TwitterOauth, Cf/CustomerFit110, Cf/CustomFitExplanation, Cf/Testpicklist, Cf/Outcomes, Cf/OverallColor, Cf/CustomerObjectives, Cf/CurrentSalesVolume, Cf/ToGoal, Cf/NumberOfProjects, Cf/ProjectEffort, Cf/ProjectImpact, Cf/BlogsPublishedLast7, Cf/WeeklyBlogsLimit, Cf/BlogsRemaining, Cf/NotesLastUpdated, Cf/CompetitorsUsed, Cf/Employee, Cf/LicensesPurchased, Cf/AccountPenetration, Cf/ChurnReason, Cf/FeatureUse2, Cf/FeatureUse1, Cf/FeatureTurnedOn, Cf/Covid19IndustryRisk, Cf/Covid19CustomerNotes, Cf/Covid19Tier, Cf/SalesProductFit, Cf/SalesExpectations, Cf/SalesHandoverNotes, Cf/PartnerFit, Cf/PartnerCommunicationCadence, Cf/NumberOfSupportTicketsOverdue, Cf/NumberOfSupportEscalationslastMonth, Cf/WasTheCustomerAcquired, Cf/WasBudgetCut, Cf/DoWeHaveMultipleChampions, Cf/DidWeLoseAChampionThatHasNotBeenReplaced, Cf/Last90DaysNps, Cf/Last90DaysCsat, Cf/TotalPurchasedHoursForCurrentQuarter, Cf/TotalHoursUsed, Cf/FeatureRequests, Cf/Csm, Cf/SalesforceAccountOwner, Cf/SalesforceRegion, Cf/AdvId, Cf/AdSpendTotalLast30Days, Cf/ContractMinimum, Cf/BillingPeriodsInContractPerYear, Cf/ToContractMin
↓ Show Options ↓↑ Hide Options ↑
?$expand array[string]

Expand related entities

*, PrimaryChurnScore, ParentAccount, UserAccount
↓ Show Options ↓↑ Hide Options ↑
Responses
Status Description
200 Account

Retrieved navigation property

400 Error

Bad Request

401 Error

Unauthorized

403 Error

Forbidden

404 Error

Not Found

409 Error

Conflict

429 Error

Too Many Requests

500 Error

Internal Server Error


Get the Contact

GET /CustomListTicket({Id})/Contact

Code samples

curl -X GET "https://app.churnzero.net/public/v1/CustomListTicket(4)/Contact" \
-H "Authorization: Basic c29tZXVzZXI6c3VwM3JTM2NyMzch"

200 response

{
  "Id": 5,
  "AccountId": 20,
  "Cf": {
    "Role": "string",
    "AccountexternalId": 1.9,
    "Language": "string",
    "Admin": false,
    "Active": false,
    "LastLogin": "2021-05-11",
    "LicenseType": "string"
  },
  "CrmId": "string",
  "Email": "string",
  "ExternalId": "string",
  "FirstName": "string",
  "FullName": "string",
  "LastName": "string",
  "MarketingEmailUnsubscribed": false,
  "Name": "string",
  "ObjectCreatedDate": "2021-05-11T16:38:27.7261423Z",
  "ObjectLastModifiedDate": "2021-05-11T16:38:27.7261423Z",
  "Tags": "string",
  "Account@odata.navigationLink": "https://app.churnzero.net/public/v1/Contact(5)/Account"
}
Parameters
Name Description
Id integer(int64)

Id of CustomListTicket

?$select array[string]

Select properties to be returned

Id, AccountId, FirstName, LastName, FullName, Email, Name, ExternalId, CrmId, MarketingEmailUnsubscribed, Tags, ObjectCreatedDate, ObjectLastModifiedDate, Cf/Role, Cf/AccountexternalId, Cf/Language, Cf/Admin, Cf/Active, Cf/LastLogin, Cf/LicenseType
↓ Show Options ↓↑ Hide Options ↑
?$expand array[string]

Expand related entities

*, Account
↓ Show Options ↓↑ Hide Options ↑
Responses
Status Description
200 Contact

Retrieved navigation property

400 Error

Bad Request

401 Error

Unauthorized

403 Error

Forbidden

404 Error

Not Found

409 Error

Conflict

429 Error

Too Many Requests

500 Error

Internal Server Error


Get the Useraccount

GET /CustomListTicket({Id})/Useraccount

Code samples

curl -X GET "https://app.churnzero.net/public/v1/CustomListTicket(4)/Useraccount" \
-H "Authorization: Basic c29tZXVzZXI6c3VwM3JTM2NyMzch"

200 response

{
  "Id": 8,
  "AvatarUrl": "string",
  "CanLogIn": false,
  "Cf": {
    "CalendarLink": "string"
  },
  "CrmId": "string",
  "Email": "string",
  "FirstName": "string",
  "HasAccounts": false,
  "IsActive": true,
  "LastName": "string",
  "MobilePhone": "string",
  "Name": "string",
  "ObjectCreatedDate": "2021-05-11T16:38:27.7373125Z",
  "ObjectLastModifiedDate": "2021-05-11T16:38:27.7373125Z",
  "OfficePhone": "string",
  "Title": "string",
  "UserName": "string"
}
Parameters
Name Description
Id integer(int64)

Id of CustomListTicket

?$select array[string]

Select properties to be returned

Id, UserName, FirstName, LastName, Name, Email, HasAccounts, AvatarUrl, MobilePhone, OfficePhone, Title, CanLogIn, CrmId, IsActive, ObjectCreatedDate, ObjectLastModifiedDate, Cf/CalendarLink
↓ Show Options ↓↑ Hide Options ↑
?$expand array[string]

Expand related entities

*
↓ Show Options ↓↑ Hide Options ↑
Responses
Status Description
200 UserAccount

Retrieved navigation property

400 Error

Bad Request

401 Error

Unauthorized

403 Error

Forbidden

404 Error

Not Found

409 Error

Conflict

429 Error

Too Many Requests

500 Error

Internal Server Error


CustomListFinancialData

This is all the financial data

Permissions

Bulk Read - Custom Tables


Get all CustomFinancialData

GET /CustomListFinancialData

Code samples

curl -X GET "https://app.churnzero.net/public/v1/CustomListFinancialData" \
-H "Authorization: Basic c29tZXVzZXI6c3VwM3JTM2NyMzch"

200 response

{
  "value": [
    {
      "Id": 8,
      "AccountId": 8,
      "DaysOverdue": 9.87,
      "DueDate": "2021-05-11",
      "InvoiceNumber": "string",
      "InvoicePaId": false,
      "ObjectCreatedDate": "2021-05-11T16:38:28.1310656Z",
      "ObjectLastModifiedDate": "2021-05-11T16:38:28.1310656Z",
      "State": "string",
      "Account@odata.navigationLink": "https://app.churnzero.net/public/v1/CustomListFinancialData(8)/Account"
    }
  ],
  "@odata.nextLink": "https://app.churnzero.net/public/v1/CustomListFinancialData?$skip=100"
}
Parameters
Name Description
?$filter array[string]

Filter items by property values

AccountId, InvoicePaId, InvoiceNumber, DueDate, DaysOverdue, State, Use/SegmentId, Use/SegmentColumnSetId
↓ Show Options ↓↑ Hide Options ↑
?$orderby array[string]

Order items by property values

ObjectCreatedDate, ObjectLastModifiedDate, InvoicePaId, InvoiceNumber, DueDate, DaysOverdue, State
↓ Show Options ↓↑ Hide Options ↑
?$select array[string]

Select properties to be returned

AccountId, InvoicePaId, InvoiceNumber, DueDate, DaysOverdue, State
↓ Show Options ↓↑ Hide Options ↑
?$expand array[string]

Expand related entities

*, Account
↓ Show Options ↓↑ Hide Options ↑
?$top integer(int32)

Show only the first n items

?$skip integer(int32)

Skip the first n items

?$count boolean

Include count of items

Responses
Status Description
200 array[CustomListFinancialData]

Retrieved entities

400 Error

Bad Request

401 Error

Unauthorized

403 Error

Forbidden

409 Error

Conflict

429 Error

Too Many Requests

500 Error

Internal Server Error


Get a CustomListFinancialData

GET /CustomListFinancialData({Id})

Code samples

curl -X GET "https://app.churnzero.net/public/v1/CustomListFinancialData(8)" \
-H "Authorization: Basic c29tZXVzZXI6c3VwM3JTM2NyMzch"

200 response

{
  "Id": 8,
  "AccountId": 8,
  "DaysOverdue": 9.87,
  "DueDate": "2021-05-11",
  "InvoiceNumber": "string",
  "InvoicePaId": false,
  "ObjectCreatedDate": "2021-05-11T16:38:28.1310656Z",
  "ObjectLastModifiedDate": "2021-05-11T16:38:28.1310656Z",
  "State": "string",
  "Account@odata.navigationLink": "https://app.churnzero.net/public/v1/CustomListFinancialData(8)/Account"
}
Parameters
Name Description
Id integer(int64)

Id of CustomListFinancialData

?$select array[string]

Select properties to be returned

AccountId, InvoicePaId, InvoiceNumber, DueDate, DaysOverdue, State
↓ Show Options ↓↑ Hide Options ↑
?$expand array[string]

Expand related entities

*, Account
↓ Show Options ↓↑ Hide Options ↑
Responses
Status Description
200 CustomListFinancialData

Retrieved entity

400 Error

Bad Request

401 Error

Unauthorized

403 Error

Forbidden

404 Error

Not Found

409 Error

Conflict

429 Error

Too Many Requests

500 Error

Internal Server Error


Get the Account

GET /CustomListFinancialData({Id})/Account

Code samples

curl -X GET "https://app.churnzero.net/public/v1/CustomListFinancialData(8)/Account" \
-H "Authorization: Basic c29tZXVzZXI6c3VwM3JTM2NyMzch"

200 response

{
  "Id": 8,
  "BillingAddressCity": "string",
  "BillingAddressCountry": "string",
  "BillingAddressLine1": "string",
  "BillingAddressLine2": "string",
  "BillingAddressState": "string",
  "BillingAddressZip": "string",
  "Cf": {
    "SupportOwnerId": 15,
    "ProductEdition": "string",
    "Emailcredits": 7.23,
    "AtRisk": true,
    "UpsellAmount": 5.0,
    "CustomerSentiment": "string",
    "SentimentLastUpdated": "2021-05-11",
    "ExecutiveSponsorHasLeft": true,
    "Industry": "string",
    "KpisMet": true,
    "Valuescore": 4.56,
    "Cstier": "string",
    "Elpmodel": "string",
    "EmailCreditsPurchased": 9.13,
    "GoLiveDate": "2021-05-11",
    "Lifecyclestage": "string",
    "OnboardingObjective": "string",
    "TrainingConfigurationNotes": "string",
    "EngagementScore": 9.11,
    "N30DayTimeSpent": 3.64,
    "TrainingConfigurationKpisMet": true,
    "SalesforceIntegration": true,
    "TwitterOauth": false,
    "CustomerFit110": 9.04,
    "CustomFitExplanation": "string",
    "Testpicklist": "string",
    "Outcomes": "string",
    "OverallColor": "string",
    "CustomerObjectives": "string",
    "CurrentSalesVolume": 0.99,
    "ToGoal": 4.94,
    "NumberOfProjects": 4.13,
    "ProjectEffort": "string",
    "ProjectImpact": "string",
    "BlogsPublishedLast7": 9.75,
    "WeeklyBlogsLimit": 9.86,
    "BlogsRemaining": 1.23,
    "NotesLastUpdated": "2021-05-11",
    "CompetitorsUsed": "string",
    "Employee": 5.02,
    "LicensesPurchased": 1.64,
    "AccountPenetration": 7.37,
    "ChurnReason": "string",
    "FeatureUse2": "string",
    "FeatureUse1": "string",
    "FeatureTurnedOn": "string",
    "Covid19IndustryRisk": "string",
    "Covid19CustomerNotes": "string",
    "Covid19Tier": "string",
    "SalesProductFit": "string",
    "SalesExpectations": "string",
    "SalesHandoverNotes": "string",
    "PartnerFit": "string",
    "PartnerCommunicationCadence": "string",
    "NumberOfSupportTicketsOverdue": "string",
    "NumberOfSupportEscalationslastMonth": "string",
    "WasTheCustomerAcquired": "string",
    "WasBudgetCut": "string",
    "DoWeHaveMultipleChampions": "string",
    "DidWeLoseAChampionThatHasNotBeenReplaced": "string",
    "Last90DaysNps": "string",
    "Last90DaysCsat": "string",
    "TotalPurchasedHoursForCurrentQuarter": "string",
    "TotalHoursUsed": "string",
    "FeatureRequests": "string",
    "Csm": "string",
    "SalesforceAccountOwner": "string",
    "SalesforceRegion": "string",
    "AdvId": "string",
    "AdSpendTotalLast30Days": 7.83,
    "ContractMinimum": 1.47,
    "BillingPeriodsInContractPerYear": "string",
    "ToContractMin": 8.81
  },
  "ContactsCount": 16,
  "CrmId": "string",
  "EndDate": "2021-05-11T16:38:27.7138801Z",
  "ExternalId": "string",
  "IsActive": true,
  "LicenseCount": 26,
  "Name": "string",
  "NextRenewalDate": "2021-05-11T16:38:27.7138801Z",
  "ObjectCreatedDate": "2021-05-11T16:38:27.7138801Z",
  "ObjectLastModifiedDate": "2021-05-11T16:38:27.7138801Z",
  "ParentAccountId": 29,
  "ParentNextRenewalDate": "2021-05-11T16:38:27.7138801Z",
  "ParentTotalContractAmount": 9.8,
  "PrimaryChurnScoreId": 9,
  "PrimaryChurnScoreValue": 8.95,
  "StartDate": "2021-05-11T16:38:27.7138801Z",
  "Tags": "string",
  "TenureInDays": 28,
  "TotalContractAmount": 1.22,
  "UsageFrequency": "string",
  "UserAccountId": 9,
  "PrimaryChurnScore@odata.navigationLink": "https://app.churnzero.net/public/v1/Account(8)/PrimaryChurnScore",
  "ParentAccount@odata.navigationLink": "https://app.churnzero.net/public/v1/Account(8)/ParentAccount",
  "UserAccount@odata.navigationLink": "https://app.churnzero.net/public/v1/Account(8)/UserAccount"
}
Parameters
Name Description
Id integer(int64)

Id of CustomListFinancialData

?$select array[string]

Select properties to be returned

Id, Name, UserAccountId, NextRenewalDate, ParentNextRenewalDate, TotalContractAmount, ParentTotalContractAmount, IsActive, ExternalId, BillingAddressLine1, BillingAddressLine2, BillingAddressCity, BillingAddressState, BillingAddressZip, BillingAddressCountry, StartDate, EndDate, LicenseCount, CrmId, TenureInDays, PrimaryChurnScoreId, PrimaryChurnScoreValue, UsageFrequency, ContactsCount, ParentAccountId, Tags, ObjectCreatedDate, ObjectLastModifiedDate, Cf/SupportOwnerId, Cf/ProductEdition, Cf/Emailcredits, Cf/AtRisk, Cf/UpsellAmount, Cf/CustomerSentiment, Cf/SentimentLastUpdated, Cf/ExecutiveSponsorHasLeft, Cf/Industry, Cf/KpisMet, Cf/Valuescore, Cf/Cstier, Cf/Elpmodel, Cf/EmailCreditsPurchased, Cf/GoLiveDate, Cf/Lifecyclestage, Cf/OnboardingObjective, Cf/TrainingConfigurationNotes, Cf/EngagementScore, Cf/N30DayTimeSpent, Cf/TrainingConfigurationKpisMet, Cf/SalesforceIntegration, Cf/TwitterOauth, Cf/CustomerFit110, Cf/CustomFitExplanation, Cf/Testpicklist, Cf/Outcomes, Cf/OverallColor, Cf/CustomerObjectives, Cf/CurrentSalesVolume, Cf/ToGoal, Cf/NumberOfProjects, Cf/ProjectEffort, Cf/ProjectImpact, Cf/BlogsPublishedLast7, Cf/WeeklyBlogsLimit, Cf/BlogsRemaining, Cf/NotesLastUpdated, Cf/CompetitorsUsed, Cf/Employee, Cf/LicensesPurchased, Cf/AccountPenetration, Cf/ChurnReason, Cf/FeatureUse2, Cf/FeatureUse1, Cf/FeatureTurnedOn, Cf/Covid19IndustryRisk, Cf/Covid19CustomerNotes, Cf/Covid19Tier, Cf/SalesProductFit, Cf/SalesExpectations, Cf/SalesHandoverNotes, Cf/PartnerFit, Cf/PartnerCommunicationCadence, Cf/NumberOfSupportTicketsOverdue, Cf/NumberOfSupportEscalationslastMonth, Cf/WasTheCustomerAcquired, Cf/WasBudgetCut, Cf/DoWeHaveMultipleChampions, Cf/DidWeLoseAChampionThatHasNotBeenReplaced, Cf/Last90DaysNps, Cf/Last90DaysCsat, Cf/TotalPurchasedHoursForCurrentQuarter, Cf/TotalHoursUsed, Cf/FeatureRequests, Cf/Csm, Cf/SalesforceAccountOwner, Cf/SalesforceRegion, Cf/AdvId, Cf/AdSpendTotalLast30Days, Cf/ContractMinimum, Cf/BillingPeriodsInContractPerYear, Cf/ToContractMin
↓ Show Options ↓↑ Hide Options ↑
?$expand array[string]

Expand related entities

*, PrimaryChurnScore, ParentAccount, UserAccount
↓ Show Options ↓↑ Hide Options ↑
Responses
Status Description
200 Account

Retrieved navigation property

400 Error

Bad Request

401 Error

Unauthorized

403 Error

Forbidden

404 Error

Not Found

409 Error

Conflict

429 Error

Too Many Requests

500 Error

Internal Server Error


CustomListCourseCompletions

Understanding the courses completed by each customer

Permissions

Bulk Read - Custom Tables


Get all CustomCourseCompletions

GET /CustomListCourseCompletions

Code samples

curl -X GET "https://app.churnzero.net/public/v1/CustomListCourseCompletions" \
-H "Authorization: Basic c29tZXVzZXI6c3VwM3JTM2NyMzch"

200 response

{
  "value": [
    {
      "Id": 2,
      "AccountId": 1,
      "Completed": true,
      "CourseEndDate": "string",
      "CourseNumber": "string",
      "CourseStartDate": "2021-05-11",
      "CourseTitle": "string",
      "ObjectCreatedDate": "2021-05-11T16:38:28.2589236Z",
      "ObjectLastModifiedDate": "2021-05-11T16:38:28.2589236Z",
      "Account@odata.navigationLink": "https://app.churnzero.net/public/v1/CustomListCourseCompletions(2)/Account"
    }
  ],
  "@odata.nextLink": "https://app.churnzero.net/public/v1/CustomListCourseCompletions?$skip=100"
}
Parameters
Name Description
?$filter array[string]

Filter items by property values

AccountId, CourseTitle, Completed, CourseStartDate, CourseEndDate, CourseNumber, Use/SegmentId, Use/SegmentColumnSetId
↓ Show Options ↓↑ Hide Options ↑
?$orderby array[string]

Order items by property values

ObjectCreatedDate, ObjectLastModifiedDate, CourseTitle, Completed, CourseStartDate, CourseEndDate, CourseNumber
↓ Show Options ↓↑ Hide Options ↑
?$select array[string]

Select properties to be returned

AccountId, CourseTitle, Completed, CourseStartDate, CourseEndDate, CourseNumber
↓ Show Options ↓↑ Hide Options ↑
?$expand array[string]

Expand related entities

*, Account
↓ Show Options ↓↑ Hide Options ↑
?$top integer(int32)

Show only the first n items

?$skip integer(int32)

Skip the first n items

?$count boolean

Include count of items

Responses
Status Description
200 array[CustomListCourseCompletions]

Retrieved entities

400 Error

Bad Request

401 Error

Unauthorized

403 Error

Forbidden

409 Error

Conflict

429 Error

Too Many Requests

500 Error

Internal Server Error


Get a CustomListCourseCompletions

GET /CustomListCourseCompletions({Id})

Code samples

curl -X GET "https://app.churnzero.net/public/v1/CustomListCourseCompletions(2)" \
-H "Authorization: Basic c29tZXVzZXI6c3VwM3JTM2NyMzch"

200 response

{
  "Id": 2,
  "AccountId": 1,
  "Completed": true,
  "CourseEndDate": "string",
  "CourseNumber": "string",
  "CourseStartDate": "2021-05-11",
  "CourseTitle": "string",
  "ObjectCreatedDate": "2021-05-11T16:38:28.2589236Z",
  "ObjectLastModifiedDate": "2021-05-11T16:38:28.2589236Z",
  "Account@odata.navigationLink": "https://app.churnzero.net/public/v1/CustomListCourseCompletions(2)/Account"
}
Parameters
Name Description
Id integer(int64)

Id of CustomListCourseCompletions

?$select array[string]

Select properties to be returned

AccountId, CourseTitle, Completed, CourseStartDate, CourseEndDate, CourseNumber
↓ Show Options ↓↑ Hide Options ↑
?$expand array[string]

Expand related entities

*, Account
↓ Show Options ↓↑ Hide Options ↑
Responses
Status Description
200 CustomListCourseCompletions

Retrieved entity

400 Error

Bad Request

401 Error

Unauthorized

403 Error

Forbidden

404 Error

Not Found

409 Error

Conflict

429 Error

Too Many Requests

500 Error

Internal Server Error


Get the Account

GET /CustomListCourseCompletions({Id})/Account

Code samples

curl -X GET "https://app.churnzero.net/public/v1/CustomListCourseCompletions(2)/Account" \
-H "Authorization: Basic c29tZXVzZXI6c3VwM3JTM2NyMzch"

200 response

{
  "Id": 8,
  "BillingAddressCity": "string",
  "BillingAddressCountry": "string",
  "BillingAddressLine1": "string",
  "BillingAddressLine2": "string",
  "BillingAddressState": "string",
  "BillingAddressZip": "string",
  "Cf": {
    "SupportOwnerId": 15,
    "ProductEdition": "string",
    "Emailcredits": 7.23,
    "AtRisk": true,
    "UpsellAmount": 5.0,
    "CustomerSentiment": "string",
    "SentimentLastUpdated": "2021-05-11",
    "ExecutiveSponsorHasLeft": true,
    "Industry": "string",
    "KpisMet": true,
    "Valuescore": 4.56,
    "Cstier": "string",
    "Elpmodel": "string",
    "EmailCreditsPurchased": 9.13,
    "GoLiveDate": "2021-05-11",
    "Lifecyclestage": "string",
    "OnboardingObjective": "string",
    "TrainingConfigurationNotes": "string",
    "EngagementScore": 9.11,
    "N30DayTimeSpent": 3.64,
    "TrainingConfigurationKpisMet": true,
    "SalesforceIntegration": true,
    "TwitterOauth": false,
    "CustomerFit110": 9.04,
    "CustomFitExplanation": "string",
    "Testpicklist": "string",
    "Outcomes": "string",
    "OverallColor": "string",
    "CustomerObjectives": "string",
    "CurrentSalesVolume": 0.99,
    "ToGoal": 4.94,
    "NumberOfProjects": 4.13,
    "ProjectEffort": "string",
    "ProjectImpact": "string",
    "BlogsPublishedLast7": 9.75,
    "WeeklyBlogsLimit": 9.86,
    "BlogsRemaining": 1.23,
    "NotesLastUpdated": "2021-05-11",
    "CompetitorsUsed": "string",
    "Employee": 5.02,
    "LicensesPurchased": 1.64,
    "AccountPenetration": 7.37,
    "ChurnReason": "string",
    "FeatureUse2": "string",
    "FeatureUse1": "string",
    "FeatureTurnedOn": "string",
    "Covid19IndustryRisk": "string",
    "Covid19CustomerNotes": "string",
    "Covid19Tier": "string",
    "SalesProductFit": "string",
    "SalesExpectations": "string",
    "SalesHandoverNotes": "string",
    "PartnerFit": "string",
    "PartnerCommunicationCadence": "string",
    "NumberOfSupportTicketsOverdue": "string",
    "NumberOfSupportEscalationslastMonth": "string",
    "WasTheCustomerAcquired": "string",
    "WasBudgetCut": "string",
    "DoWeHaveMultipleChampions": "string",
    "DidWeLoseAChampionThatHasNotBeenReplaced": "string",
    "Last90DaysNps": "string",
    "Last90DaysCsat": "string",
    "TotalPurchasedHoursForCurrentQuarter": "string",
    "TotalHoursUsed": "string",
    "FeatureRequests": "string",
    "Csm": "string",
    "SalesforceAccountOwner": "string",
    "SalesforceRegion": "string",
    "AdvId": "string",
    "AdSpendTotalLast30Days": 7.83,
    "ContractMinimum": 1.47,
    "BillingPeriodsInContractPerYear": "string",
    "ToContractMin": 8.81
  },
  "ContactsCount": 16,
  "CrmId": "string",
  "EndDate": "2021-05-11T16:38:27.7138801Z",
  "ExternalId": "string",
  "IsActive": true,
  "LicenseCount": 26,
  "Name": "string",
  "NextRenewalDate": "2021-05-11T16:38:27.7138801Z",
  "ObjectCreatedDate": "2021-05-11T16:38:27.7138801Z",
  "ObjectLastModifiedDate": "2021-05-11T16:38:27.7138801Z",
  "ParentAccountId": 29,
  "ParentNextRenewalDate": "2021-05-11T16:38:27.7138801Z",
  "ParentTotalContractAmount": 9.8,
  "PrimaryChurnScoreId": 9,
  "PrimaryChurnScoreValue": 8.95,
  "StartDate": "2021-05-11T16:38:27.7138801Z",
  "Tags": "string",
  "TenureInDays": 28,
  "TotalContractAmount": 1.22,
  "UsageFrequency": "string",
  "UserAccountId": 9,
  "PrimaryChurnScore@odata.navigationLink": "https://app.churnzero.net/public/v1/Account(8)/PrimaryChurnScore",
  "ParentAccount@odata.navigationLink": "https://app.churnzero.net/public/v1/Account(8)/ParentAccount",
  "UserAccount@odata.navigationLink": "https://app.churnzero.net/public/v1/Account(8)/UserAccount"
}
Parameters
Name Description
Id integer(int64)

Id of CustomListCourseCompletions

?$select array[string]

Select properties to be returned

Id, Name, UserAccountId, NextRenewalDate, ParentNextRenewalDate, TotalContractAmount, ParentTotalContractAmount, IsActive, ExternalId, BillingAddressLine1, BillingAddressLine2, BillingAddressCity, BillingAddressState, BillingAddressZip, BillingAddressCountry, StartDate, EndDate, LicenseCount, CrmId, TenureInDays, PrimaryChurnScoreId, PrimaryChurnScoreValue, UsageFrequency, ContactsCount, ParentAccountId, Tags, ObjectCreatedDate, ObjectLastModifiedDate, Cf/SupportOwnerId, Cf/ProductEdition, Cf/Emailcredits, Cf/AtRisk, Cf/UpsellAmount, Cf/CustomerSentiment, Cf/SentimentLastUpdated, Cf/ExecutiveSponsorHasLeft, Cf/Industry, Cf/KpisMet, Cf/Valuescore, Cf/Cstier, Cf/Elpmodel, Cf/EmailCreditsPurchased, Cf/GoLiveDate, Cf/Lifecyclestage, Cf/OnboardingObjective, Cf/TrainingConfigurationNotes, Cf/EngagementScore, Cf/N30DayTimeSpent, Cf/TrainingConfigurationKpisMet, Cf/SalesforceIntegration, Cf/TwitterOauth, Cf/CustomerFit110, Cf/CustomFitExplanation, Cf/Testpicklist, Cf/Outcomes, Cf/OverallColor, Cf/CustomerObjectives, Cf/CurrentSalesVolume, Cf/ToGoal, Cf/NumberOfProjects, Cf/ProjectEffort, Cf/ProjectImpact, Cf/BlogsPublishedLast7, Cf/WeeklyBlogsLimit, Cf/BlogsRemaining, Cf/NotesLastUpdated, Cf/CompetitorsUsed, Cf/Employee, Cf/LicensesPurchased, Cf/AccountPenetration, Cf/ChurnReason, Cf/FeatureUse2, Cf/FeatureUse1, Cf/FeatureTurnedOn, Cf/Covid19IndustryRisk, Cf/Covid19CustomerNotes, Cf/Covid19Tier, Cf/SalesProductFit, Cf/SalesExpectations, Cf/SalesHandoverNotes, Cf/PartnerFit, Cf/PartnerCommunicationCadence, Cf/NumberOfSupportTicketsOverdue, Cf/NumberOfSupportEscalationslastMonth, Cf/WasTheCustomerAcquired, Cf/WasBudgetCut, Cf/DoWeHaveMultipleChampions, Cf/DidWeLoseAChampionThatHasNotBeenReplaced, Cf/Last90DaysNps, Cf/Last90DaysCsat, Cf/TotalPurchasedHoursForCurrentQuarter, Cf/TotalHoursUsed, Cf/FeatureRequests, Cf/Csm, Cf/SalesforceAccountOwner, Cf/SalesforceRegion, Cf/AdvId, Cf/AdSpendTotalLast30Days, Cf/ContractMinimum, Cf/BillingPeriodsInContractPerYear, Cf/ToContractMin
↓ Show Options ↓↑ Hide Options ↑
?$expand array[string]

Expand related entities

*, PrimaryChurnScore, ParentAccount, UserAccount
↓ Show Options ↓↑ Hide Options ↑
Responses
Status Description
200 Account

Retrieved navigation property

400 Error

Bad Request

401 Error

Unauthorized

403 Error

Forbidden

404 Error

Not Found

409 Error

Conflict

429 Error

Too Many Requests

500 Error

Internal Server Error


CustomListOpportunities

Permissions

Bulk Read - Custom Tables


Get all CustomOpportunities

GET /CustomListOpportunities

Code samples

curl -X GET "https://app.churnzero.net/public/v1/CustomListOpportunities" \
-H "Authorization: Basic c29tZXVzZXI6c3VwM3JTM2NyMzch"

200 response

{
  "value": [
    {
      "Id": 9,
      "AccountDirectorId": 8,
      "AccountId": 2,
      "AnnualManagedServicesFee": 9.26,
      "AnnualSubscriptionFee": 8.47,
      "ChannelType": "string",
      "CloseDate": "2021-05-11",
      "ClosedLostNotes": "string",
      "ClosedLostReason": "string",
      "Competitors": "string",
      "CreatedById": 4,
      "CreatedDate": "2021-05-11",
      "DaysAtCurrentStage": 3.5,
      "Description": "string",
      "ExecutiveCoachId": 25,
      "FinancialReportingRegion": "string",
      "FutureScope": "string",
      "ImplementationStartDate": "2021-05-11",
      "IndustryVertical": "string",
      "Modules": "string",
      "NextStep": "string",
      "NumberOfContracts": 7.84,
      "NumberOfSuppliersclients": 0.06,
      "ObjectCreatedDate": "2021-05-11T16:38:28.4246913Z",
      "ObjectLastModifiedDate": "2021-05-11T16:38:28.4246913Z",
      "OnetimeImplementationFee": 4.53,
      "OpportunityCountry": "string",
      "OpportunityName": "string",
      "OpportunityOwnerId": 2,
      "OpportunityState": "string",
      "PocEndDate": "2021-05-11",
      "PocOutcome": "string",
      "PocScope": "string",
      "PocStartDate": "2021-05-11",
      "PocValue": 2.74,
      "Probability": 0.96,
      "ProductType": "string",
      "SalesTerritory": "string",
      "SirionForecast": "string",
      "SloppId": "string",
      "Stage": "string",
      "StartDateOfCurrentStage": "2021-05-11",
      "TotalArrwithProbability": 8.91,
      "TotalArrwoProbability": 1.26,
      "Account@odata.navigationLink": "https://app.churnzero.net/public/v1/CustomListOpportunities(9)/Account",
      "OpportunityOwner@odata.navigationLink": "https://app.churnzero.net/public/v1/CustomListOpportunities(9)/OpportunityOwner",
      "ExecutiveCoach@odata.navigationLink": "https://app.churnzero.net/public/v1/CustomListOpportunities(9)/ExecutiveCoach",
      "AccountDirector@odata.navigationLink": "https://app.churnzero.net/public/v1/CustomListOpportunities(9)/AccountDirector",
      "CreatedBy@odata.navigationLink": "https://app.churnzero.net/public/v1/CustomListOpportunities(9)/CreatedBy"
    }
  ],
  "@odata.nextLink": "https://app.churnzero.net/public/v1/CustomListOpportunities?$skip=100"
}
Parameters
Name Description
?$filter array[string]

Filter items by property values

AccountId, OpportunityName, IndustryVertical, ProductType, OpportunityCountry, OpportunityState, FinancialReportingRegion, SalesTerritory, Probability, Competitors, OpportunityOwnerId, ExecutiveCoachId, AccountDirectorId, CloseDate, Stage, SirionForecast, DaysAtCurrentStage, TotalArrwoProbability, TotalArrwithProbability, AnnualSubscriptionFee, AnnualManagedServicesFee, OnetimeImplementationFee, StartDateOfCurrentStage, ClosedLostReason, ChannelType, CreatedById, CreatedDate, PocStartDate, PocEndDate, PocValue, PocOutcome, ImplementationStartDate, NumberOfSuppliersclients, NumberOfContracts, Use/SegmentId, Use/SegmentColumnSetId
↓ Show Options ↓↑ Hide Options ↑
?$orderby array[string]

Order items by property values

ObjectCreatedDate, ObjectLastModifiedDate, OpportunityName, IndustryVertical, ProductType, OpportunityCountry, OpportunityState, FinancialReportingRegion, SalesTerritory, Probability, Competitors, CloseDate, Stage, SirionForecast, DaysAtCurrentStage, TotalArrwoProbability, TotalArrwithProbability, AnnualSubscriptionFee, AnnualManagedServicesFee, OnetimeImplementationFee, StartDateOfCurrentStage, ClosedLostReason, ChannelType, CreatedDate, PocStartDate, PocEndDate, PocValue, PocOutcome, ImplementationStartDate, NumberOfSuppliersclients, NumberOfContracts
↓ Show Options ↓↑ Hide Options ↑
?$select array[string]

Select properties to be returned

SloppId, AccountId, OpportunityName, IndustryVertical, ProductType, OpportunityCountry, OpportunityState, FinancialReportingRegion, SalesTerritory, Probability, Competitors, OpportunityOwnerId, ExecutiveCoachId, AccountDirectorId, CloseDate, Stage, SirionForecast, DaysAtCurrentStage, TotalArrwoProbability, TotalArrwithProbability, AnnualSubscriptionFee, AnnualManagedServicesFee, OnetimeImplementationFee, StartDateOfCurrentStage, ClosedLostReason, ClosedLostNotes, ChannelType, CreatedById, CreatedDate, NextStep, Description, Modules, PocStartDate, PocEndDate, PocValue, PocOutcome, PocScope, ImplementationStartDate, NumberOfSuppliersclients, NumberOfContracts, FutureScope
↓ Show Options ↓↑ Hide Options ↑
?$expand array[string]

Expand related entities

*, Account, OpportunityOwner, ExecutiveCoach, AccountDirector, CreatedBy
↓ Show Options ↓↑ Hide Options ↑
?$top integer(int32)

Show only the first n items

?$skip integer(int32)

Skip the first n items

?$count boolean

Include count of items

Responses
Status Description
200 array[CustomListOpportunities]

Retrieved entities

400 Error

Bad Request

401 Error

Unauthorized

403 Error

Forbidden

409 Error

Conflict

429 Error

Too Many Requests

500 Error

Internal Server Error


Get a CustomListOpportunities

GET /CustomListOpportunities({Id})

Code samples

curl -X GET "https://app.churnzero.net/public/v1/CustomListOpportunities(9)" \
-H "Authorization: Basic c29tZXVzZXI6c3VwM3JTM2NyMzch"

200 response

{
  "Id": 9,
  "AccountDirectorId": 8,
  "AccountId": 2,
  "AnnualManagedServicesFee": 9.26,
  "AnnualSubscriptionFee": 8.47,
  "ChannelType": "string",
  "CloseDate": "2021-05-11",
  "ClosedLostNotes": "string",
  "ClosedLostReason": "string",
  "Competitors": "string",
  "CreatedById": 4,
  "CreatedDate": "2021-05-11",
  "DaysAtCurrentStage": 3.5,
  "Description": "string",
  "ExecutiveCoachId": 25,
  "FinancialReportingRegion": "string",
  "FutureScope": "string",
  "ImplementationStartDate": "2021-05-11",
  "IndustryVertical": "string",
  "Modules": "string",
  "NextStep": "string",
  "NumberOfContracts": 7.84,
  "NumberOfSuppliersclients": 0.06,
  "ObjectCreatedDate": "2021-05-11T16:38:28.4246913Z",
  "ObjectLastModifiedDate": "2021-05-11T16:38:28.4246913Z",
  "OnetimeImplementationFee": 4.53,
  "OpportunityCountry": "string",
  "OpportunityName": "string",
  "OpportunityOwnerId": 2,
  "OpportunityState": "string",
  "PocEndDate": "2021-05-11",
  "PocOutcome": "string",
  "PocScope": "string",
  "PocStartDate": "2021-05-11",
  "PocValue": 2.74,
  "Probability": 0.96,
  "ProductType": "string",
  "SalesTerritory": "string",
  "SirionForecast": "string",
  "SloppId": "string",
  "Stage": "string",
  "StartDateOfCurrentStage": "2021-05-11",
  "TotalArrwithProbability": 8.91,
  "TotalArrwoProbability": 1.26,
  "Account@odata.navigationLink": "https://app.churnzero.net/public/v1/CustomListOpportunities(9)/Account",
  "OpportunityOwner@odata.navigationLink": "https://app.churnzero.net/public/v1/CustomListOpportunities(9)/OpportunityOwner",
  "ExecutiveCoach@odata.navigationLink": "https://app.churnzero.net/public/v1/CustomListOpportunities(9)/ExecutiveCoach",
  "AccountDirector@odata.navigationLink": "https://app.churnzero.net/public/v1/CustomListOpportunities(9)/AccountDirector",
  "CreatedBy@odata.navigationLink": "https://app.churnzero.net/public/v1/CustomListOpportunities(9)/CreatedBy"
}
Parameters
Name Description
Id integer(int64)

Id of CustomListOpportunities

?$select array[string]

Select properties to be returned

SloppId, AccountId, OpportunityName, IndustryVertical, ProductType, OpportunityCountry, OpportunityState, FinancialReportingRegion, SalesTerritory, Probability, Competitors, OpportunityOwnerId, ExecutiveCoachId, AccountDirectorId, CloseDate, Stage, SirionForecast, DaysAtCurrentStage, TotalArrwoProbability, TotalArrwithProbability, AnnualSubscriptionFee, AnnualManagedServicesFee, OnetimeImplementationFee, StartDateOfCurrentStage, ClosedLostReason, ClosedLostNotes, ChannelType, CreatedById, CreatedDate, NextStep, Description, Modules, PocStartDate, PocEndDate, PocValue, PocOutcome, PocScope, ImplementationStartDate, NumberOfSuppliersclients, NumberOfContracts, FutureScope
↓ Show Options ↓↑ Hide Options ↑
?$expand array[string]

Expand related entities

*, Account, OpportunityOwner, ExecutiveCoach, AccountDirector, CreatedBy
↓ Show Options ↓↑ Hide Options ↑
Responses
Status Description
200 CustomListOpportunities

Retrieved entity

400 Error

Bad Request

401 Error

Unauthorized

403 Error

Forbidden

404 Error

Not Found

409 Error

Conflict

429 Error

Too Many Requests

500 Error

Internal Server Error


Get the Account

GET /CustomListOpportunities({Id})/Account

Code samples

curl -X GET "https://app.churnzero.net/public/v1/CustomListOpportunities(9)/Account" \
-H "Authorization: Basic c29tZXVzZXI6c3VwM3JTM2NyMzch"

200 response

{
  "Id": 8,
  "BillingAddressCity": "string",
  "BillingAddressCountry": "string",
  "BillingAddressLine1": "string",
  "BillingAddressLine2": "string",
  "BillingAddressState": "string",
  "BillingAddressZip": "string",
  "Cf": {
    "SupportOwnerId": 15,
    "ProductEdition": "string",
    "Emailcredits": 7.23,
    "AtRisk": true,
    "UpsellAmount": 5.0,
    "CustomerSentiment": "string",
    "SentimentLastUpdated": "2021-05-11",
    "ExecutiveSponsorHasLeft": true,
    "Industry": "string",
    "KpisMet": true,
    "Valuescore": 4.56,
    "Cstier": "string",
    "Elpmodel": "string",
    "EmailCreditsPurchased": 9.13,
    "GoLiveDate": "2021-05-11",
    "Lifecyclestage": "string",
    "OnboardingObjective": "string",
    "TrainingConfigurationNotes": "string",
    "EngagementScore": 9.11,
    "N30DayTimeSpent": 3.64,
    "TrainingConfigurationKpisMet": true,
    "SalesforceIntegration": true,
    "TwitterOauth": false,
    "CustomerFit110": 9.04,
    "CustomFitExplanation": "string",
    "Testpicklist": "string",
    "Outcomes": "string",
    "OverallColor": "string",
    "CustomerObjectives": "string",
    "CurrentSalesVolume": 0.99,
    "ToGoal": 4.94,
    "NumberOfProjects": 4.13,
    "ProjectEffort": "string",
    "ProjectImpact": "string",
    "BlogsPublishedLast7": 9.75,
    "WeeklyBlogsLimit": 9.86,
    "BlogsRemaining": 1.23,
    "NotesLastUpdated": "2021-05-11",
    "CompetitorsUsed": "string",
    "Employee": 5.02,
    "LicensesPurchased": 1.64,
    "AccountPenetration": 7.37,
    "ChurnReason": "string",
    "FeatureUse2": "string",
    "FeatureUse1": "string",
    "FeatureTurnedOn": "string",
    "Covid19IndustryRisk": "string",
    "Covid19CustomerNotes": "string",
    "Covid19Tier": "string",
    "SalesProductFit": "string",
    "SalesExpectations": "string",
    "SalesHandoverNotes": "string",
    "PartnerFit": "string",
    "PartnerCommunicationCadence": "string",
    "NumberOfSupportTicketsOverdue": "string",
    "NumberOfSupportEscalationslastMonth": "string",
    "WasTheCustomerAcquired": "string",
    "WasBudgetCut": "string",
    "DoWeHaveMultipleChampions": "string",
    "DidWeLoseAChampionThatHasNotBeenReplaced": "string",
    "Last90DaysNps": "string",
    "Last90DaysCsat": "string",
    "TotalPurchasedHoursForCurrentQuarter": "string",
    "TotalHoursUsed": "string",
    "FeatureRequests": "string",
    "Csm": "string",
    "SalesforceAccountOwner": "string",
    "SalesforceRegion": "string",
    "AdvId": "string",
    "AdSpendTotalLast30Days": 7.83,
    "ContractMinimum": 1.47,
    "BillingPeriodsInContractPerYear": "string",
    "ToContractMin": 8.81
  },
  "ContactsCount": 16,
  "CrmId": "string",
  "EndDate": "2021-05-11T16:38:27.7138801Z",
  "ExternalId": "string",
  "IsActive": true,
  "LicenseCount": 26,
  "Name": "string",
  "NextRenewalDate": "2021-05-11T16:38:27.7138801Z",
  "ObjectCreatedDate": "2021-05-11T16:38:27.7138801Z",
  "ObjectLastModifiedDate": "2021-05-11T16:38:27.7138801Z",
  "ParentAccountId": 29,
  "ParentNextRenewalDate": "2021-05-11T16:38:27.7138801Z",
  "ParentTotalContractAmount": 9.8,
  "PrimaryChurnScoreId": 9,
  "PrimaryChurnScoreValue": 8.95,
  "StartDate": "2021-05-11T16:38:27.7138801Z",
  "Tags": "string",
  "TenureInDays": 28,
  "TotalContractAmount": 1.22,
  "UsageFrequency": "string",
  "UserAccountId": 9,
  "PrimaryChurnScore@odata.navigationLink": "https://app.churnzero.net/public/v1/Account(8)/PrimaryChurnScore",
  "ParentAccount@odata.navigationLink": "https://app.churnzero.net/public/v1/Account(8)/ParentAccount",
  "UserAccount@odata.navigationLink": "https://app.churnzero.net/public/v1/Account(8)/UserAccount"
}
Parameters
Name Description
Id integer(int64)

Id of CustomListOpportunities

?$select array[string]

Select properties to be returned

Id, Name, UserAccountId, NextRenewalDate, ParentNextRenewalDate, TotalContractAmount, ParentTotalContractAmount, IsActive, ExternalId, BillingAddressLine1, BillingAddressLine2, BillingAddressCity, BillingAddressState, BillingAddressZip, BillingAddressCountry, StartDate, EndDate, LicenseCount, CrmId, TenureInDays, PrimaryChurnScoreId, PrimaryChurnScoreValue, UsageFrequency, ContactsCount, ParentAccountId, Tags, ObjectCreatedDate, ObjectLastModifiedDate, Cf/SupportOwnerId, Cf/ProductEdition, Cf/Emailcredits, Cf/AtRisk, Cf/UpsellAmount, Cf/CustomerSentiment, Cf/SentimentLastUpdated, Cf/ExecutiveSponsorHasLeft, Cf/Industry, Cf/KpisMet, Cf/Valuescore, Cf/Cstier, Cf/Elpmodel, Cf/EmailCreditsPurchased, Cf/GoLiveDate, Cf/Lifecyclestage, Cf/OnboardingObjective, Cf/TrainingConfigurationNotes, Cf/EngagementScore, Cf/N30DayTimeSpent, Cf/TrainingConfigurationKpisMet, Cf/SalesforceIntegration, Cf/TwitterOauth, Cf/CustomerFit110, Cf/CustomFitExplanation, Cf/Testpicklist, Cf/Outcomes, Cf/OverallColor, Cf/CustomerObjectives, Cf/CurrentSalesVolume, Cf/ToGoal, Cf/NumberOfProjects, Cf/ProjectEffort, Cf/ProjectImpact, Cf/BlogsPublishedLast7, Cf/WeeklyBlogsLimit, Cf/BlogsRemaining, Cf/NotesLastUpdated, Cf/CompetitorsUsed, Cf/Employee, Cf/LicensesPurchased, Cf/AccountPenetration, Cf/ChurnReason, Cf/FeatureUse2, Cf/FeatureUse1, Cf/FeatureTurnedOn, Cf/Covid19IndustryRisk, Cf/Covid19CustomerNotes, Cf/Covid19Tier, Cf/SalesProductFit, Cf/SalesExpectations, Cf/SalesHandoverNotes, Cf/PartnerFit, Cf/PartnerCommunicationCadence, Cf/NumberOfSupportTicketsOverdue, Cf/NumberOfSupportEscalationslastMonth, Cf/WasTheCustomerAcquired, Cf/WasBudgetCut, Cf/DoWeHaveMultipleChampions, Cf/DidWeLoseAChampionThatHasNotBeenReplaced, Cf/Last90DaysNps, Cf/Last90DaysCsat, Cf/TotalPurchasedHoursForCurrentQuarter, Cf/TotalHoursUsed, Cf/FeatureRequests, Cf/Csm, Cf/SalesforceAccountOwner, Cf/SalesforceRegion, Cf/AdvId, Cf/AdSpendTotalLast30Days, Cf/ContractMinimum, Cf/BillingPeriodsInContractPerYear, Cf/ToContractMin
↓ Show Options ↓↑ Hide Options ↑
?$expand array[string]

Expand related entities

*, PrimaryChurnScore, ParentAccount, UserAccount
↓ Show Options ↓↑ Hide Options ↑
Responses
Status Description
200 Account

Retrieved navigation property

400 Error

Bad Request

401 Error

Unauthorized

403 Error

Forbidden

404 Error

Not Found

409 Error

Conflict

429 Error

Too Many Requests

500 Error

Internal Server Error


Get the AccountDirector

GET /CustomListOpportunities({Id})/AccountDirector

Code samples

curl -X GET "https://app.churnzero.net/public/v1/CustomListOpportunities(9)/AccountDirector" \
-H "Authorization: Basic c29tZXVzZXI6c3VwM3JTM2NyMzch"

200 response

{
  "Id": 8,
  "AvatarUrl": "string",
  "CanLogIn": false,
  "Cf": {
    "CalendarLink": "string"
  },
  "CrmId": "string",
  "Email": "string",
  "FirstName": "string",
  "HasAccounts": false,
  "IsActive": true,
  "LastName": "string",
  "MobilePhone": "string",
  "Name": "string",
  "ObjectCreatedDate": "2021-05-11T16:38:27.7373125Z",
  "ObjectLastModifiedDate": "2021-05-11T16:38:27.7373125Z",
  "OfficePhone": "string",
  "Title": "string",
  "UserName": "string"
}
Parameters
Name Description
Id integer(int64)

Id of CustomListOpportunities

?$select array[string]

Select properties to be returned

Id, UserName, FirstName, LastName, Name, Email, HasAccounts, AvatarUrl, MobilePhone, OfficePhone, Title, CanLogIn, CrmId, IsActive, ObjectCreatedDate, ObjectLastModifiedDate, Cf/CalendarLink
↓ Show Options ↓↑ Hide Options ↑
?$expand array[string]

Expand related entities

*
↓ Show Options ↓↑ Hide Options ↑
Responses
Status Description
200 UserAccount

Retrieved navigation property

400 Error

Bad Request

401 Error

Unauthorized

403 Error

Forbidden

404 Error

Not Found

409 Error

Conflict

429 Error

Too Many Requests

500 Error

Internal Server Error


Get the CreatedBy

GET /CustomListOpportunities({Id})/CreatedBy

Code samples

curl -X GET "https://app.churnzero.net/public/v1/CustomListOpportunities(9)/CreatedBy" \
-H "Authorization: Basic c29tZXVzZXI6c3VwM3JTM2NyMzch"

200 response

{
  "Id": 8,
  "AvatarUrl": "string",
  "CanLogIn": false,
  "Cf": {
    "CalendarLink": "string"
  },
  "CrmId": "string",
  "Email": "string",
  "FirstName": "string",
  "HasAccounts": false,
  "IsActive": true,
  "LastName": "string",
  "MobilePhone": "string",
  "Name": "string",
  "ObjectCreatedDate": "2021-05-11T16:38:27.7373125Z",
  "ObjectLastModifiedDate": "2021-05-11T16:38:27.7373125Z",
  "OfficePhone": "string",
  "Title": "string",
  "UserName": "string"
}
Parameters
Name Description
Id integer(int64)

Id of CustomListOpportunities

?$select array[string]

Select properties to be returned

Id, UserName, FirstName, LastName, Name, Email, HasAccounts, AvatarUrl, MobilePhone, OfficePhone, Title, CanLogIn, CrmId, IsActive, ObjectCreatedDate, ObjectLastModifiedDate, Cf/CalendarLink
↓ Show Options ↓↑ Hide Options ↑
?$expand array[string]

Expand related entities

*
↓ Show Options ↓↑ Hide Options ↑
Responses
Status Description
200 UserAccount

Retrieved navigation property

400 Error

Bad Request

401 Error

Unauthorized

403 Error

Forbidden

404 Error

Not Found

409 Error

Conflict

429 Error

Too Many Requests

500 Error

Internal Server Error


Get the ExecutiveCoach

GET /CustomListOpportunities({Id})/ExecutiveCoach

Code samples

curl -X GET "https://app.churnzero.net/public/v1/CustomListOpportunities(9)/ExecutiveCoach" \
-H "Authorization: Basic c29tZXVzZXI6c3VwM3JTM2NyMzch"

200 response

{
  "Id": 8,
  "AvatarUrl": "string",
  "CanLogIn": false,
  "Cf": {
    "CalendarLink": "string"
  },
  "CrmId": "string",
  "Email": "string",
  "FirstName": "string",
  "HasAccounts": false,
  "IsActive": true,
  "LastName": "string",
  "MobilePhone": "string",
  "Name": "string",
  "ObjectCreatedDate": "2021-05-11T16:38:27.7373125Z",
  "ObjectLastModifiedDate": "2021-05-11T16:38:27.7373125Z",
  "OfficePhone": "string",
  "Title": "string",
  "UserName": "string"
}
Parameters
Name Description
Id integer(int64)

Id of CustomListOpportunities

?$select array[string]

Select properties to be returned

Id, UserName, FirstName, LastName, Name, Email, HasAccounts, AvatarUrl, MobilePhone, OfficePhone, Title, CanLogIn, CrmId, IsActive, ObjectCreatedDate, ObjectLastModifiedDate, Cf/CalendarLink
↓ Show Options ↓↑ Hide Options ↑
?$expand array[string]

Expand related entities

*
↓ Show Options ↓↑ Hide Options ↑
Responses
Status Description
200 UserAccount

Retrieved navigation property

400 Error

Bad Request

401 Error

Unauthorized

403 Error

Forbidden

404 Error

Not Found

409 Error

Conflict

429 Error

Too Many Requests

500 Error

Internal Server Error


Get the OpportunityOwner

GET /CustomListOpportunities({Id})/OpportunityOwner

Code samples

curl -X GET "https://app.churnzero.net/public/v1/CustomListOpportunities(9)/OpportunityOwner" \
-H "Authorization: Basic c29tZXVzZXI6c3VwM3JTM2NyMzch"

200 response

{
  "Id": 8,
  "AvatarUrl": "string",
  "CanLogIn": false,
  "Cf": {
    "CalendarLink": "string"
  },
  "CrmId": "string",
  "Email": "string",
  "FirstName": "string",
  "HasAccounts": false,
  "IsActive": true,
  "LastName": "string",
  "MobilePhone": "string",
  "Name": "string",
  "ObjectCreatedDate": "2021-05-11T16:38:27.7373125Z",
  "ObjectLastModifiedDate": "2021-05-11T16:38:27.7373125Z",
  "OfficePhone": "string",
  "Title": "string",
  "UserName": "string"
}
Parameters
Name Description
Id integer(int64)

Id of CustomListOpportunities

?$select array[string]

Select properties to be returned

Id, UserName, FirstName, LastName, Name, Email, HasAccounts, AvatarUrl, MobilePhone, OfficePhone, Title, CanLogIn, CrmId, IsActive, ObjectCreatedDate, ObjectLastModifiedDate, Cf/CalendarLink
↓ Show Options ↓↑ Hide Options ↑
?$expand array[string]

Expand related entities

*
↓ Show Options ↓↑ Hide Options ↑
Responses
Status Description
200 UserAccount

Retrieved navigation property

400 Error

Bad Request

401 Error

Unauthorized

403 Error

Forbidden

404 Error

Not Found

409 Error

Conflict

429 Error

Too Many Requests

500 Error

Internal Server Error


CustomListStrategicInitiatives

Permissions

Bulk Read - Custom Tables


Get all CustomStrategicInitiatives

GET /CustomListStrategicInitiatives

Code samples

curl -X GET "https://app.churnzero.net/public/v1/CustomListStrategicInitiatives" \
-H "Authorization: Basic c29tZXVzZXI6c3VwM3JTM2NyMzch"

200 response

{
  "value": [
    {
      "Id": 1,
      "Accomplished": "string",
      "AccountId": 15,
      "ApplicableModules": "string",
      "Budget": 5.63,
      "BusinessImpact": "string",
      "BusinessObjective": "string",
      "CallOutline": "string",
      "CurrentInitiative": false,
      "CustomerAsks": "string",
      "DocExample2": "string",
      "DocExample3": "string",
      "EbrDate": "2021-05-11",
      "IllumioAsks": "string",
      "KeyStakeholderId": 24,
      "NextStepsoutcomes": "string",
      "ObjectCreatedDate": "2021-05-11T16:38:29.5059158Z",
      "ObjectLastModifiedDate": "2021-05-11T16:38:29.5059158Z",
      "OwnerId": 8,
      "Reason": "string",
      "Scope": "string",
      "SuccessCriteria": "string",
      "Timeline": "2021-05-11",
      "Account@odata.navigationLink": "https://app.churnzero.net/public/v1/CustomListStrategicInitiatives(1)/Account",
      "Owner@odata.navigationLink": "https://app.churnzero.net/public/v1/CustomListStrategicInitiatives(1)/Owner",
      "KeyStakeholder@odata.navigationLink": "https://app.churnzero.net/public/v1/CustomListStrategicInitiatives(1)/KeyStakeholder"
    }
  ],
  "@odata.nextLink": "https://app.churnzero.net/public/v1/CustomListStrategicInitiatives?$skip=100"
}
Parameters
Name Description
?$filter array[string]

Filter items by property values

AccountId, OwnerId, KeyStakeholderId, Budget, CurrentInitiative, BusinessObjective, SuccessCriteria, BusinessImpact, Timeline, CallOutline, DocExample2, DocExample3, EbrDate, Use/SegmentId, Use/SegmentColumnSetId
↓ Show Options ↓↑ Hide Options ↑
?$orderby array[string]

Order items by property values

ObjectCreatedDate, ObjectLastModifiedDate, Budget, CurrentInitiative, BusinessObjective, SuccessCriteria, BusinessImpact, Timeline, CallOutline, DocExample2, DocExample3, EbrDate
↓ Show Options ↓↑ Hide Options ↑
?$select array[string]

Select properties to be returned

AccountId, OwnerId, KeyStakeholderId, Budget, CurrentInitiative, BusinessObjective, Reason, SuccessCriteria, BusinessImpact, Scope, Timeline, CallOutline, DocExample2, DocExample3, ApplicableModules, Accomplished, NextStepsoutcomes, CustomerAsks, IllumioAsks, EbrDate
↓ Show Options ↓↑ Hide Options ↑
?$expand array[string]

Expand related entities

*, Account, Owner, KeyStakeholder
↓ Show Options ↓↑ Hide Options ↑
?$top integer(int32)

Show only the first n items

?$skip integer(int32)

Skip the first n items

?$count boolean

Include count of items

Responses
Status Description
200 array[CustomListStrategicInitiatives]

Retrieved entities

400 Error

Bad Request

401 Error

Unauthorized

403 Error

Forbidden

409 Error

Conflict

429 Error

Too Many Requests

500 Error

Internal Server Error


Get a CustomListStrategicInitiatives

GET /CustomListStrategicInitiatives({Id})

Code samples

curl -X GET "https://app.churnzero.net/public/v1/CustomListStrategicInitiatives(1)" \
-H "Authorization: Basic c29tZXVzZXI6c3VwM3JTM2NyMzch"

200 response

{
  "Id": 1,
  "Accomplished": "string",
  "AccountId": 15,
  "ApplicableModules": "string",
  "Budget": 5.63,
  "BusinessImpact": "string",
  "BusinessObjective": "string",
  "CallOutline": "string",
  "CurrentInitiative": false,
  "CustomerAsks": "string",
  "DocExample2": "string",
  "DocExample3": "string",
  "EbrDate": "2021-05-11",
  "IllumioAsks": "string",
  "KeyStakeholderId": 24,
  "NextStepsoutcomes": "string",
  "ObjectCreatedDate": "2021-05-11T16:38:29.5059158Z",
  "ObjectLastModifiedDate": "2021-05-11T16:38:29.5059158Z",
  "OwnerId": 8,
  "Reason": "string",
  "Scope": "string",
  "SuccessCriteria": "string",
  "Timeline": "2021-05-11",
  "Account@odata.navigationLink": "https://app.churnzero.net/public/v1/CustomListStrategicInitiatives(1)/Account",
  "Owner@odata.navigationLink": "https://app.churnzero.net/public/v1/CustomListStrategicInitiatives(1)/Owner",
  "KeyStakeholder@odata.navigationLink": "https://app.churnzero.net/public/v1/CustomListStrategicInitiatives(1)/KeyStakeholder"
}
Parameters
Name Description
Id integer(int64)

Id of CustomListStrategicInitiatives

?$select array[string]

Select properties to be returned

AccountId, OwnerId, KeyStakeholderId, Budget, CurrentInitiative, BusinessObjective, Reason, SuccessCriteria, BusinessImpact, Scope, Timeline, CallOutline, DocExample2, DocExample3, ApplicableModules, Accomplished, NextStepsoutcomes, CustomerAsks, IllumioAsks, EbrDate
↓ Show Options ↓↑ Hide Options ↑
?$expand array[string]

Expand related entities

*, Account, Owner, KeyStakeholder
↓ Show Options ↓↑ Hide Options ↑
Responses
Status Description
200 CustomListStrategicInitiatives

Retrieved entity

400 Error

Bad Request

401 Error

Unauthorized

403 Error

Forbidden

404 Error

Not Found

409 Error

Conflict

429 Error

Too Many Requests

500 Error

Internal Server Error


Get the Account

GET /CustomListStrategicInitiatives({Id})/Account

Code samples

curl -X GET "https://app.churnzero.net/public/v1/CustomListStrategicInitiatives(1)/Account" \
-H "Authorization: Basic c29tZXVzZXI6c3VwM3JTM2NyMzch"

200 response

{
  "Id": 8,
  "BillingAddressCity": "string",
  "BillingAddressCountry": "string",
  "BillingAddressLine1": "string",
  "BillingAddressLine2": "string",
  "BillingAddressState": "string",
  "BillingAddressZip": "string",
  "Cf": {
    "SupportOwnerId": 15,
    "ProductEdition": "string",
    "Emailcredits": 7.23,
    "AtRisk": true,
    "UpsellAmount": 5.0,
    "CustomerSentiment": "string",
    "SentimentLastUpdated": "2021-05-11",
    "ExecutiveSponsorHasLeft": true,
    "Industry": "string",
    "KpisMet": true,
    "Valuescore": 4.56,
    "Cstier": "string",
    "Elpmodel": "string",
    "EmailCreditsPurchased": 9.13,
    "GoLiveDate": "2021-05-11",
    "Lifecyclestage": "string",
    "OnboardingObjective": "string",
    "TrainingConfigurationNotes": "string",
    "EngagementScore": 9.11,
    "N30DayTimeSpent": 3.64,
    "TrainingConfigurationKpisMet": true,
    "SalesforceIntegration": true,
    "TwitterOauth": false,
    "CustomerFit110": 9.04,
    "CustomFitExplanation": "string",
    "Testpicklist": "string",
    "Outcomes": "string",
    "OverallColor": "string",
    "CustomerObjectives": "string",
    "CurrentSalesVolume": 0.99,
    "ToGoal": 4.94,
    "NumberOfProjects": 4.13,
    "ProjectEffort": "string",
    "ProjectImpact": "string",
    "BlogsPublishedLast7": 9.75,
    "WeeklyBlogsLimit": 9.86,
    "BlogsRemaining": 1.23,
    "NotesLastUpdated": "2021-05-11",
    "CompetitorsUsed": "string",
    "Employee": 5.02,
    "LicensesPurchased": 1.64,
    "AccountPenetration": 7.37,
    "ChurnReason": "string",
    "FeatureUse2": "string",
    "FeatureUse1": "string",
    "FeatureTurnedOn": "string",
    "Covid19IndustryRisk": "string",
    "Covid19CustomerNotes": "string",
    "Covid19Tier": "string",
    "SalesProductFit": "string",
    "SalesExpectations": "string",
    "SalesHandoverNotes": "string",
    "PartnerFit": "string",
    "PartnerCommunicationCadence": "string",
    "NumberOfSupportTicketsOverdue": "string",
    "NumberOfSupportEscalationslastMonth": "string",
    "WasTheCustomerAcquired": "string",
    "WasBudgetCut": "string",
    "DoWeHaveMultipleChampions": "string",
    "DidWeLoseAChampionThatHasNotBeenReplaced": "string",
    "Last90DaysNps": "string",
    "Last90DaysCsat": "string",
    "TotalPurchasedHoursForCurrentQuarter": "string",
    "TotalHoursUsed": "string",
    "FeatureRequests": "string",
    "Csm": "string",
    "SalesforceAccountOwner": "string",
    "SalesforceRegion": "string",
    "AdvId": "string",
    "AdSpendTotalLast30Days": 7.83,
    "ContractMinimum": 1.47,
    "BillingPeriodsInContractPerYear": "string",
    "ToContractMin": 8.81
  },
  "ContactsCount": 16,
  "CrmId": "string",
  "EndDate": "2021-05-11T16:38:27.7138801Z",
  "ExternalId": "string",
  "IsActive": true,
  "LicenseCount": 26,
  "Name": "string",
  "NextRenewalDate": "2021-05-11T16:38:27.7138801Z",
  "ObjectCreatedDate": "2021-05-11T16:38:27.7138801Z",
  "ObjectLastModifiedDate": "2021-05-11T16:38:27.7138801Z",
  "ParentAccountId": 29,
  "ParentNextRenewalDate": "2021-05-11T16:38:27.7138801Z",
  "ParentTotalContractAmount": 9.8,
  "PrimaryChurnScoreId": 9,
  "PrimaryChurnScoreValue": 8.95,
  "StartDate": "2021-05-11T16:38:27.7138801Z",
  "Tags": "string",
  "TenureInDays": 28,
  "TotalContractAmount": 1.22,
  "UsageFrequency": "string",
  "UserAccountId": 9,
  "PrimaryChurnScore@odata.navigationLink": "https://app.churnzero.net/public/v1/Account(8)/PrimaryChurnScore",
  "ParentAccount@odata.navigationLink": "https://app.churnzero.net/public/v1/Account(8)/ParentAccount",
  "UserAccount@odata.navigationLink": "https://app.churnzero.net/public/v1/Account(8)/UserAccount"
}
Parameters
Name Description
Id integer(int64)

Id of CustomListStrategicInitiatives

?$select array[string]

Select properties to be returned

Id, Name, UserAccountId, NextRenewalDate, ParentNextRenewalDate, TotalContractAmount, ParentTotalContractAmount, IsActive, ExternalId, BillingAddressLine1, BillingAddressLine2, BillingAddressCity, BillingAddressState, BillingAddressZip, BillingAddressCountry, StartDate, EndDate, LicenseCount, CrmId, TenureInDays, PrimaryChurnScoreId, PrimaryChurnScoreValue, UsageFrequency, ContactsCount, ParentAccountId, Tags, ObjectCreatedDate, ObjectLastModifiedDate, Cf/SupportOwnerId, Cf/ProductEdition, Cf/Emailcredits, Cf/AtRisk, Cf/UpsellAmount, Cf/CustomerSentiment, Cf/SentimentLastUpdated, Cf/ExecutiveSponsorHasLeft, Cf/Industry, Cf/KpisMet, Cf/Valuescore, Cf/Cstier, Cf/Elpmodel, Cf/EmailCreditsPurchased, Cf/GoLiveDate, Cf/Lifecyclestage, Cf/OnboardingObjective, Cf/TrainingConfigurationNotes, Cf/EngagementScore, Cf/N30DayTimeSpent, Cf/TrainingConfigurationKpisMet, Cf/SalesforceIntegration, Cf/TwitterOauth, Cf/CustomerFit110, Cf/CustomFitExplanation, Cf/Testpicklist, Cf/Outcomes, Cf/OverallColor, Cf/CustomerObjectives, Cf/CurrentSalesVolume, Cf/ToGoal, Cf/NumberOfProjects, Cf/ProjectEffort, Cf/ProjectImpact, Cf/BlogsPublishedLast7, Cf/WeeklyBlogsLimit, Cf/BlogsRemaining, Cf/NotesLastUpdated, Cf/CompetitorsUsed, Cf/Employee, Cf/LicensesPurchased, Cf/AccountPenetration, Cf/ChurnReason, Cf/FeatureUse2, Cf/FeatureUse1, Cf/FeatureTurnedOn, Cf/Covid19IndustryRisk, Cf/Covid19CustomerNotes, Cf/Covid19Tier, Cf/SalesProductFit, Cf/SalesExpectations, Cf/SalesHandoverNotes, Cf/PartnerFit, Cf/PartnerCommunicationCadence, Cf/NumberOfSupportTicketsOverdue, Cf/NumberOfSupportEscalationslastMonth, Cf/WasTheCustomerAcquired, Cf/WasBudgetCut, Cf/DoWeHaveMultipleChampions, Cf/DidWeLoseAChampionThatHasNotBeenReplaced, Cf/Last90DaysNps, Cf/Last90DaysCsat, Cf/TotalPurchasedHoursForCurrentQuarter, Cf/TotalHoursUsed, Cf/FeatureRequests, Cf/Csm, Cf/SalesforceAccountOwner, Cf/SalesforceRegion, Cf/AdvId, Cf/AdSpendTotalLast30Days, Cf/ContractMinimum, Cf/BillingPeriodsInContractPerYear, Cf/ToContractMin
↓ Show Options ↓↑ Hide Options ↑
?$expand array[string]

Expand related entities

*, PrimaryChurnScore, ParentAccount, UserAccount
↓ Show Options ↓↑ Hide Options ↑
Responses
Status Description
200 Account

Retrieved navigation property

400 Error

Bad Request

401 Error

Unauthorized

403 Error

Forbidden

404 Error

Not Found

409 Error

Conflict

429 Error

Too Many Requests

500 Error

Internal Server Error


Get the KeyStakeholder

GET /CustomListStrategicInitiatives({Id})/KeyStakeholder

Code samples

curl -X GET "https://app.churnzero.net/public/v1/CustomListStrategicInitiatives(1)/KeyStakeholder" \
-H "Authorization: Basic c29tZXVzZXI6c3VwM3JTM2NyMzch"

200 response

{
  "Id": 5,
  "AccountId": 20,
  "Cf": {
    "Role": "string",
    "AccountexternalId": 1.9,
    "Language": "string",
    "Admin": false,
    "Active": false,
    "LastLogin": "2021-05-11",
    "LicenseType": "string"
  },
  "CrmId": "string",
  "Email": "string",
  "ExternalId": "string",
  "FirstName": "string",
  "FullName": "string",
  "LastName": "string",
  "MarketingEmailUnsubscribed": false,
  "Name": "string",
  "ObjectCreatedDate": "2021-05-11T16:38:27.7261423Z",
  "ObjectLastModifiedDate": "2021-05-11T16:38:27.7261423Z",
  "Tags": "string",
  "Account@odata.navigationLink": "https://app.churnzero.net/public/v1/Contact(5)/Account"
}
Parameters
Name Description
Id integer(int64)

Id of CustomListStrategicInitiatives

?$select array[string]

Select properties to be returned

Id, AccountId, FirstName, LastName, FullName, Email, Name, ExternalId, CrmId, MarketingEmailUnsubscribed, Tags, ObjectCreatedDate, ObjectLastModifiedDate, Cf/Role, Cf/AccountexternalId, Cf/Language, Cf/Admin, Cf/Active, Cf/LastLogin, Cf/LicenseType
↓ Show Options ↓↑ Hide Options ↑
?$expand array[string]

Expand related entities

*, Account
↓ Show Options ↓↑ Hide Options ↑
Responses
Status Description
200 Contact

Retrieved navigation property

400 Error

Bad Request

401 Error

Unauthorized

403 Error

Forbidden

404 Error

Not Found

409 Error

Conflict

429 Error

Too Many Requests

500 Error

Internal Server Error


Get the Owner

GET /CustomListStrategicInitiatives({Id})/Owner

Code samples

curl -X GET "https://app.churnzero.net/public/v1/CustomListStrategicInitiatives(1)/Owner" \
-H "Authorization: Basic c29tZXVzZXI6c3VwM3JTM2NyMzch"

200 response

{
  "Id": 8,
  "BillingAddressCity": "string",
  "BillingAddressCountry": "string",
  "BillingAddressLine1": "string",
  "BillingAddressLine2": "string",
  "BillingAddressState": "string",
  "BillingAddressZip": "string",
  "Cf": {
    "SupportOwnerId": 15,
    "ProductEdition": "string",
    "Emailcredits": 7.23,
    "AtRisk": true,
    "UpsellAmount": 5.0,
    "CustomerSentiment": "string",
    "SentimentLastUpdated": "2021-05-11",
    "ExecutiveSponsorHasLeft": true,
    "Industry": "string",
    "KpisMet": true,
    "Valuescore": 4.56,
    "Cstier": "string",
    "Elpmodel": "string",
    "EmailCreditsPurchased": 9.13,
    "GoLiveDate": "2021-05-11",
    "Lifecyclestage": "string",
    "OnboardingObjective": "string",
    "TrainingConfigurationNotes": "string",
    "EngagementScore": 9.11,
    "N30DayTimeSpent": 3.64,
    "TrainingConfigurationKpisMet": true,
    "SalesforceIntegration": true,
    "TwitterOauth": false,
    "CustomerFit110": 9.04,
    "CustomFitExplanation": "string",
    "Testpicklist": "string",
    "Outcomes": "string",
    "OverallColor": "string",
    "CustomerObjectives": "string",
    "CurrentSalesVolume": 0.99,
    "ToGoal": 4.94,
    "NumberOfProjects": 4.13,
    "ProjectEffort": "string",
    "ProjectImpact": "string",
    "BlogsPublishedLast7": 9.75,
    "WeeklyBlogsLimit": 9.86,
    "BlogsRemaining": 1.23,
    "NotesLastUpdated": "2021-05-11",
    "CompetitorsUsed": "string",
    "Employee": 5.02,
    "LicensesPurchased": 1.64,
    "AccountPenetration": 7.37,
    "ChurnReason": "string",
    "FeatureUse2": "string",
    "FeatureUse1": "string",
    "FeatureTurnedOn": "string",
    "Covid19IndustryRisk": "string",
    "Covid19CustomerNotes": "string",
    "Covid19Tier": "string",
    "SalesProductFit": "string",
    "SalesExpectations": "string",
    "SalesHandoverNotes": "string",
    "PartnerFit": "string",
    "PartnerCommunicationCadence": "string",
    "NumberOfSupportTicketsOverdue": "string",
    "NumberOfSupportEscalationslastMonth": "string",
    "WasTheCustomerAcquired": "string",
    "WasBudgetCut": "string",
    "DoWeHaveMultipleChampions": "string",
    "DidWeLoseAChampionThatHasNotBeenReplaced": "string",
    "Last90DaysNps": "string",
    "Last90DaysCsat": "string",
    "TotalPurchasedHoursForCurrentQuarter": "string",
    "TotalHoursUsed": "string",
    "FeatureRequests": "string",
    "Csm": "string",
    "SalesforceAccountOwner": "string",
    "SalesforceRegion": "string",
    "AdvId": "string",
    "AdSpendTotalLast30Days": 7.83,
    "ContractMinimum": 1.47,
    "BillingPeriodsInContractPerYear": "string",
    "ToContractMin": 8.81
  },
  "ContactsCount": 16,
  "CrmId": "string",
  "EndDate": "2021-05-11T16:38:27.7138801Z",
  "ExternalId": "string",
  "IsActive": true,
  "LicenseCount": 26,
  "Name": "string",
  "NextRenewalDate": "2021-05-11T16:38:27.7138801Z",
  "ObjectCreatedDate": "2021-05-11T16:38:27.7138801Z",
  "ObjectLastModifiedDate": "2021-05-11T16:38:27.7138801Z",
  "ParentAccountId": 29,
  "ParentNextRenewalDate": "2021-05-11T16:38:27.7138801Z",
  "ParentTotalContractAmount": 9.8,
  "PrimaryChurnScoreId": 9,
  "PrimaryChurnScoreValue": 8.95,
  "StartDate": "2021-05-11T16:38:27.7138801Z",
  "Tags": "string",
  "TenureInDays": 28,
  "TotalContractAmount": 1.22,
  "UsageFrequency": "string",
  "UserAccountId": 9,
  "PrimaryChurnScore@odata.navigationLink": "https://app.churnzero.net/public/v1/Account(8)/PrimaryChurnScore",
  "ParentAccount@odata.navigationLink": "https://app.churnzero.net/public/v1/Account(8)/ParentAccount",
  "UserAccount@odata.navigationLink": "https://app.churnzero.net/public/v1/Account(8)/UserAccount"
}
Parameters
Name Description
Id integer(int64)

Id of CustomListStrategicInitiatives

?$select array[string]

Select properties to be returned

Id, Name, UserAccountId, NextRenewalDate, ParentNextRenewalDate, TotalContractAmount, ParentTotalContractAmount, IsActive, ExternalId, BillingAddressLine1, BillingAddressLine2, BillingAddressCity, BillingAddressState, BillingAddressZip, BillingAddressCountry, StartDate, EndDate, LicenseCount, CrmId, TenureInDays, PrimaryChurnScoreId, PrimaryChurnScoreValue, UsageFrequency, ContactsCount, ParentAccountId, Tags, ObjectCreatedDate, ObjectLastModifiedDate, Cf/SupportOwnerId, Cf/ProductEdition, Cf/Emailcredits, Cf/AtRisk, Cf/UpsellAmount, Cf/CustomerSentiment, Cf/SentimentLastUpdated, Cf/ExecutiveSponsorHasLeft, Cf/Industry, Cf/KpisMet, Cf/Valuescore, Cf/Cstier, Cf/Elpmodel, Cf/EmailCreditsPurchased, Cf/GoLiveDate, Cf/Lifecyclestage, Cf/OnboardingObjective, Cf/TrainingConfigurationNotes, Cf/EngagementScore, Cf/N30DayTimeSpent, Cf/TrainingConfigurationKpisMet, Cf/SalesforceIntegration, Cf/TwitterOauth, Cf/CustomerFit110, Cf/CustomFitExplanation, Cf/Testpicklist, Cf/Outcomes, Cf/OverallColor, Cf/CustomerObjectives, Cf/CurrentSalesVolume, Cf/ToGoal, Cf/NumberOfProjects, Cf/ProjectEffort, Cf/ProjectImpact, Cf/BlogsPublishedLast7, Cf/WeeklyBlogsLimit, Cf/BlogsRemaining, Cf/NotesLastUpdated, Cf/CompetitorsUsed, Cf/Employee, Cf/LicensesPurchased, Cf/AccountPenetration, Cf/ChurnReason, Cf/FeatureUse2, Cf/FeatureUse1, Cf/FeatureTurnedOn, Cf/Covid19IndustryRisk, Cf/Covid19CustomerNotes, Cf/Covid19Tier, Cf/SalesProductFit, Cf/SalesExpectations, Cf/SalesHandoverNotes, Cf/PartnerFit, Cf/PartnerCommunicationCadence, Cf/NumberOfSupportTicketsOverdue, Cf/NumberOfSupportEscalationslastMonth, Cf/WasTheCustomerAcquired, Cf/WasBudgetCut, Cf/DoWeHaveMultipleChampions, Cf/DidWeLoseAChampionThatHasNotBeenReplaced, Cf/Last90DaysNps, Cf/Last90DaysCsat, Cf/TotalPurchasedHoursForCurrentQuarter, Cf/TotalHoursUsed, Cf/FeatureRequests, Cf/Csm, Cf/SalesforceAccountOwner, Cf/SalesforceRegion, Cf/AdvId, Cf/AdSpendTotalLast30Days, Cf/ContractMinimum, Cf/BillingPeriodsInContractPerYear, Cf/ToContractMin
↓ Show Options ↓↑ Hide Options ↑
?$expand array[string]

Expand related entities

*, PrimaryChurnScore, ParentAccount, UserAccount
↓ Show Options ↓↑ Hide Options ↑
Responses
Status Description
200 Account

Retrieved navigation property

400 Error

Bad Request

401 Error

Unauthorized

403 Error

Forbidden

404 Error

Not Found

409 Error

Conflict

429 Error

Too Many Requests

500 Error

Internal Server Error


CustomListOrganization

Link to Zendesk Organization Connected to Zendesk Support entity Organization.

Permissions

Bulk Read - Custom Tables


Get all CustomOrganizations

GET /CustomListOrganization

Code samples

curl -X GET "https://app.churnzero.net/public/v1/CustomListOrganization" \
-H "Authorization: Basic c29tZXVzZXI6c3VwM3JTM2NyMzch"

200 response

{
  "value": [
    {
      "Id": 7,
      "AccountId": 14,
      "ObjectCreatedDate": "2021-05-11T16:38:30.1247808Z",
      "ObjectLastModifiedDate": "2021-05-11T16:38:30.1247808Z",
      "Account@odata.navigationLink": "https://app.churnzero.net/public/v1/CustomListOrganization(7)/Account"
    }
  ],
  "@odata.nextLink": "https://app.churnzero.net/public/v1/CustomListOrganization?$skip=100"
}
Parameters
Name Description
?$filter array[string]

Filter items by property values

AccountId, Use/SegmentId, Use/SegmentColumnSetId
↓ Show Options ↓↑ Hide Options ↑
?$orderby array[string]

Order items by property values

ObjectCreatedDate, ObjectLastModifiedDate
↓ Show Options ↓↑ Hide Options ↑
?$select array[string]

Select properties to be returned

SeeInZendesk, AccountId
↓ Show Options ↓↑ Hide Options ↑
?$expand array[string]

Expand related entities

*, Account
↓ Show Options ↓↑ Hide Options ↑
?$top integer(int32)

Show only the first n items

?$skip integer(int32)

Skip the first n items

?$count boolean

Include count of items

Responses
Status Description
200 array[CustomListOrganization]

Retrieved entities

400 Error

Bad Request

401 Error

Unauthorized

403 Error

Forbidden

409 Error

Conflict

429 Error

Too Many Requests

500 Error

Internal Server Error


Get a CustomListOrganization

GET /CustomListOrganization({Id})

Code samples

curl -X GET "https://app.churnzero.net/public/v1/CustomListOrganization(7)" \
-H "Authorization: Basic c29tZXVzZXI6c3VwM3JTM2NyMzch"

200 response

{
  "Id": 7,
  "AccountId": 14,
  "ObjectCreatedDate": "2021-05-11T16:38:30.1247808Z",
  "ObjectLastModifiedDate": "2021-05-11T16:38:30.1247808Z",
  "Account@odata.navigationLink": "https://app.churnzero.net/public/v1/CustomListOrganization(7)/Account"
}
Parameters
Name Description
Id integer(int64)

Id of CustomListOrganization

?$select array[string]

Select properties to be returned

SeeInZendesk, AccountId
↓ Show Options ↓↑ Hide Options ↑
?$expand array[string]

Expand related entities

*, Account
↓ Show Options ↓↑ Hide Options ↑
Responses
Status Description
200 CustomListOrganization

Retrieved entity

400 Error

Bad Request

401 Error

Unauthorized

403 Error

Forbidden

404 Error

Not Found

409 Error

Conflict

429 Error

Too Many Requests

500 Error

Internal Server Error


Get the Account

GET /CustomListOrganization({Id})/Account

Code samples

curl -X GET "https://app.churnzero.net/public/v1/CustomListOrganization(7)/Account" \
-H "Authorization: Basic c29tZXVzZXI6c3VwM3JTM2NyMzch"

200 response

{
  "Id": 8,
  "BillingAddressCity": "string",
  "BillingAddressCountry": "string",
  "BillingAddressLine1": "string",
  "BillingAddressLine2": "string",
  "BillingAddressState": "string",
  "BillingAddressZip": "string",
  "Cf": {
    "SupportOwnerId": 15,
    "ProductEdition": "string",
    "Emailcredits": 7.23,
    "AtRisk": true,
    "UpsellAmount": 5.0,
    "CustomerSentiment": "string",
    "SentimentLastUpdated": "2021-05-11",
    "ExecutiveSponsorHasLeft": true,
    "Industry": "string",
    "KpisMet": true,
    "Valuescore": 4.56,
    "Cstier": "string",
    "Elpmodel": "string",
    "EmailCreditsPurchased": 9.13,
    "GoLiveDate": "2021-05-11",
    "Lifecyclestage": "string",
    "OnboardingObjective": "string",
    "TrainingConfigurationNotes": "string",
    "EngagementScore": 9.11,
    "N30DayTimeSpent": 3.64,
    "TrainingConfigurationKpisMet": true,
    "SalesforceIntegration": true,
    "TwitterOauth": false,
    "CustomerFit110": 9.04,
    "CustomFitExplanation": "string",
    "Testpicklist": "string",
    "Outcomes": "string",
    "OverallColor": "string",
    "CustomerObjectives": "string",
    "CurrentSalesVolume": 0.99,
    "ToGoal": 4.94,
    "NumberOfProjects": 4.13,
    "ProjectEffort": "string",
    "ProjectImpact": "string",
    "BlogsPublishedLast7": 9.75,
    "WeeklyBlogsLimit": 9.86,
    "BlogsRemaining": 1.23,
    "NotesLastUpdated": "2021-05-11",
    "CompetitorsUsed": "string",
    "Employee": 5.02,
    "LicensesPurchased": 1.64,
    "AccountPenetration": 7.37,
    "ChurnReason": "string",
    "FeatureUse2": "string",
    "FeatureUse1": "string",
    "FeatureTurnedOn": "string",
    "Covid19IndustryRisk": "string",
    "Covid19CustomerNotes": "string",
    "Covid19Tier": "string",
    "SalesProductFit": "string",
    "SalesExpectations": "string",
    "SalesHandoverNotes": "string",
    "PartnerFit": "string",
    "PartnerCommunicationCadence": "string",
    "NumberOfSupportTicketsOverdue": "string",
    "NumberOfSupportEscalationslastMonth": "string",
    "WasTheCustomerAcquired": "string",
    "WasBudgetCut": "string",
    "DoWeHaveMultipleChampions": "string",
    "DidWeLoseAChampionThatHasNotBeenReplaced": "string",
    "Last90DaysNps": "string",
    "Last90DaysCsat": "string",
    "TotalPurchasedHoursForCurrentQuarter": "string",
    "TotalHoursUsed": "string",
    "FeatureRequests": "string",
    "Csm": "string",
    "SalesforceAccountOwner": "string",
    "SalesforceRegion": "string",
    "AdvId": "string",
    "AdSpendTotalLast30Days": 7.83,
    "ContractMinimum": 1.47,
    "BillingPeriodsInContractPerYear": "string",
    "ToContractMin": 8.81
  },
  "ContactsCount": 16,
  "CrmId": "string",
  "EndDate": "2021-05-11T16:38:27.7138801Z",
  "ExternalId": "string",
  "IsActive": true,
  "LicenseCount": 26,
  "Name": "string",
  "NextRenewalDate": "2021-05-11T16:38:27.7138801Z",
  "ObjectCreatedDate": "2021-05-11T16:38:27.7138801Z",
  "ObjectLastModifiedDate": "2021-05-11T16:38:27.7138801Z",
  "ParentAccountId": 29,
  "ParentNextRenewalDate": "2021-05-11T16:38:27.7138801Z",
  "ParentTotalContractAmount": 9.8,
  "PrimaryChurnScoreId": 9,
  "PrimaryChurnScoreValue": 8.95,
  "StartDate": "2021-05-11T16:38:27.7138801Z",
  "Tags": "string",
  "TenureInDays": 28,
  "TotalContractAmount": 1.22,
  "UsageFrequency": "string",
  "UserAccountId": 9,
  "PrimaryChurnScore@odata.navigationLink": "https://app.churnzero.net/public/v1/Account(8)/PrimaryChurnScore",
  "ParentAccount@odata.navigationLink": "https://app.churnzero.net/public/v1/Account(8)/ParentAccount",
  "UserAccount@odata.navigationLink": "https://app.churnzero.net/public/v1/Account(8)/UserAccount"
}
Parameters
Name Description
Id integer(int64)

Id of CustomListOrganization

?$select array[string]

Select properties to be returned

Id, Name, UserAccountId, NextRenewalDate, ParentNextRenewalDate, TotalContractAmount, ParentTotalContractAmount, IsActive, ExternalId, BillingAddressLine1, BillingAddressLine2, BillingAddressCity, BillingAddressState, BillingAddressZip, BillingAddressCountry, StartDate, EndDate, LicenseCount, CrmId, TenureInDays, PrimaryChurnScoreId, PrimaryChurnScoreValue, UsageFrequency, ContactsCount, ParentAccountId, Tags, ObjectCreatedDate, ObjectLastModifiedDate, Cf/SupportOwnerId, Cf/ProductEdition, Cf/Emailcredits, Cf/AtRisk, Cf/UpsellAmount, Cf/CustomerSentiment, Cf/SentimentLastUpdated, Cf/ExecutiveSponsorHasLeft, Cf/Industry, Cf/KpisMet, Cf/Valuescore, Cf/Cstier, Cf/Elpmodel, Cf/EmailCreditsPurchased, Cf/GoLiveDate, Cf/Lifecyclestage, Cf/OnboardingObjective, Cf/TrainingConfigurationNotes, Cf/EngagementScore, Cf/N30DayTimeSpent, Cf/TrainingConfigurationKpisMet, Cf/SalesforceIntegration, Cf/TwitterOauth, Cf/CustomerFit110, Cf/CustomFitExplanation, Cf/Testpicklist, Cf/Outcomes, Cf/OverallColor, Cf/CustomerObjectives, Cf/CurrentSalesVolume, Cf/ToGoal, Cf/NumberOfProjects, Cf/ProjectEffort, Cf/ProjectImpact, Cf/BlogsPublishedLast7, Cf/WeeklyBlogsLimit, Cf/BlogsRemaining, Cf/NotesLastUpdated, Cf/CompetitorsUsed, Cf/Employee, Cf/LicensesPurchased, Cf/AccountPenetration, Cf/ChurnReason, Cf/FeatureUse2, Cf/FeatureUse1, Cf/FeatureTurnedOn, Cf/Covid19IndustryRisk, Cf/Covid19CustomerNotes, Cf/Covid19Tier, Cf/SalesProductFit, Cf/SalesExpectations, Cf/SalesHandoverNotes, Cf/PartnerFit, Cf/PartnerCommunicationCadence, Cf/NumberOfSupportTicketsOverdue, Cf/NumberOfSupportEscalationslastMonth, Cf/WasTheCustomerAcquired, Cf/WasBudgetCut, Cf/DoWeHaveMultipleChampions, Cf/DidWeLoseAChampionThatHasNotBeenReplaced, Cf/Last90DaysNps, Cf/Last90DaysCsat, Cf/TotalPurchasedHoursForCurrentQuarter, Cf/TotalHoursUsed, Cf/FeatureRequests, Cf/Csm, Cf/SalesforceAccountOwner, Cf/SalesforceRegion, Cf/AdvId, Cf/AdSpendTotalLast30Days, Cf/ContractMinimum, Cf/BillingPeriodsInContractPerYear, Cf/ToContractMin
↓ Show Options ↓↑ Hide Options ↑
?$expand array[string]

Expand related entities

*, PrimaryChurnScore, ParentAccount, UserAccount
↓ Show Options ↓↑ Hide Options ↑
Responses
Status Description
200 Account

Retrieved navigation property

400 Error

Bad Request

401 Error

Unauthorized

403 Error

Forbidden

404 Error

Not Found

409 Error

Conflict

429 Error

Too Many Requests

500 Error

Internal Server Error


CustomListMSTeamsUsage

Permissions

Bulk Read - Custom Tables


Get all CustomMSTeamsUsages

GET /CustomListMSTeamsUsage

Code samples

curl -X GET "https://app.churnzero.net/public/v1/CustomListMSTeamsUsage" \
-H "Authorization: Basic c29tZXVzZXI6c3VwM3JTM2NyMzch"

200 response

{
  "value": [
    {
      "Id": 3,
      "AccountId": 2,
      "ActiveChannels": 0.48,
      "ActiveUsers": 7.82,
      "ChannelMessages": 8.88,
      "DisplayName": "string",
      "Guests": 4.29,
      "Identifier": "string",
      "LastActivity": "2021-05-11T16:38:30.3849682Z",
      "MeetingsOrganized": 0.42,
      "Mentions": 1.45,
      "ObjectCreatedDate": "2021-05-11T16:38:30.3849682Z",
      "ObjectLastModifiedDate": "2021-05-11T16:38:30.3849682Z",
      "PostMessages": 0.1,
      "Privacy": "string",
      "Reactions": 7.15,
      "ReplyMessages": 9.04,
      "UrgentMessages": 3.56,
      "UserId": "string",
      "Account@odata.navigationLink": "https://app.churnzero.net/public/v1/CustomListMSTeamsUsage(3)/Account"
    }
  ],
  "@odata.nextLink": "https://app.churnzero.net/public/v1/CustomListMSTeamsUsage?$skip=100"
}
Parameters
Name Description
?$filter array[string]

Filter items by property values

AccountId, DisplayName, UserId, Privacy, ActiveUsers, ActiveChannels, Guests, ReplyMessages, PostMessages, MeetingsOrganized, UrgentMessages, Reactions, Mentions, ChannelMessages, LastActivity, Use/SegmentId, Use/SegmentColumnSetId
↓ Show Options ↓↑ Hide Options ↑
?$orderby array[string]

Order items by property values

ObjectCreatedDate, ObjectLastModifiedDate, DisplayName, UserId, Privacy, ActiveUsers, ActiveChannels, Guests, ReplyMessages, PostMessages, MeetingsOrganized, UrgentMessages, Reactions, Mentions, ChannelMessages, LastActivity
↓ Show Options ↓↑ Hide Options ↑
?$select array[string]

Select properties to be returned

AccountId, Identifier, DisplayName, UserId, Privacy, ActiveUsers, ActiveChannels, Guests, ReplyMessages, PostMessages, MeetingsOrganized, UrgentMessages, Reactions, Mentions, ChannelMessages, LastActivity
↓ Show Options ↓↑ Hide Options ↑
?$expand array[string]

Expand related entities

*, Account
↓ Show Options ↓↑ Hide Options ↑
?$top integer(int32)

Show only the first n items

?$skip integer(int32)

Skip the first n items

?$count boolean

Include count of items

Responses
Status Description
200 array[CustomListMSTeamsUsage]

Retrieved entities

400 Error

Bad Request

401 Error

Unauthorized

403 Error

Forbidden

409 Error

Conflict

429 Error

Too Many Requests

500 Error

Internal Server Error


Get a CustomListMSTeamsUsage

GET /CustomListMSTeamsUsage({Id})

Code samples

curl -X GET "https://app.churnzero.net/public/v1/CustomListMSTeamsUsage(3)" \
-H "Authorization: Basic c29tZXVzZXI6c3VwM3JTM2NyMzch"

200 response

{
  "Id": 3,
  "AccountId": 2,
  "ActiveChannels": 0.48,
  "ActiveUsers": 7.82,
  "ChannelMessages": 8.88,
  "DisplayName": "string",
  "Guests": 4.29,
  "Identifier": "string",
  "LastActivity": "2021-05-11T16:38:30.3849682Z",
  "MeetingsOrganized": 0.42,
  "Mentions": 1.45,
  "ObjectCreatedDate": "2021-05-11T16:38:30.3849682Z",
  "ObjectLastModifiedDate": "2021-05-11T16:38:30.3849682Z",
  "PostMessages": 0.1,
  "Privacy": "string",
  "Reactions": 7.15,
  "ReplyMessages": 9.04,
  "UrgentMessages": 3.56,
  "UserId": "string",
  "Account@odata.navigationLink": "https://app.churnzero.net/public/v1/CustomListMSTeamsUsage(3)/Account"
}
Parameters
Name Description
Id integer(int64)

Id of CustomListMSTeamsUsage

?$select array[string]

Select properties to be returned

AccountId, Identifier, DisplayName, UserId, Privacy, ActiveUsers, ActiveChannels, Guests, ReplyMessages, PostMessages, MeetingsOrganized, UrgentMessages, Reactions, Mentions, ChannelMessages, LastActivity
↓ Show Options ↓↑ Hide Options ↑
?$expand array[string]

Expand related entities

*, Account
↓ Show Options ↓↑ Hide Options ↑
Responses
Status Description
200 CustomListMSTeamsUsage

Retrieved entity

400 Error

Bad Request

401 Error

Unauthorized

403 Error

Forbidden

404 Error

Not Found

409 Error

Conflict

429 Error

Too Many Requests

500 Error

Internal Server Error


Get the Account

GET /CustomListMSTeamsUsage({Id})/Account

Code samples

curl -X GET "https://app.churnzero.net/public/v1/CustomListMSTeamsUsage(3)/Account" \
-H "Authorization: Basic c29tZXVzZXI6c3VwM3JTM2NyMzch"

200 response

{
  "Id": 8,
  "BillingAddressCity": "string",
  "BillingAddressCountry": "string",
  "BillingAddressLine1": "string",
  "BillingAddressLine2": "string",
  "BillingAddressState": "string",
  "BillingAddressZip": "string",
  "Cf": {
    "SupportOwnerId": 15,
    "ProductEdition": "string",
    "Emailcredits": 7.23,
    "AtRisk": true,
    "UpsellAmount": 5.0,
    "CustomerSentiment": "string",
    "SentimentLastUpdated": "2021-05-11",
    "ExecutiveSponsorHasLeft": true,
    "Industry": "string",
    "KpisMet": true,
    "Valuescore": 4.56,
    "Cstier": "string",
    "Elpmodel": "string",
    "EmailCreditsPurchased": 9.13,
    "GoLiveDate": "2021-05-11",
    "Lifecyclestage": "string",
    "OnboardingObjective": "string",
    "TrainingConfigurationNotes": "string",
    "EngagementScore": 9.11,
    "N30DayTimeSpent": 3.64,
    "TrainingConfigurationKpisMet": true,
    "SalesforceIntegration": true,
    "TwitterOauth": false,
    "CustomerFit110": 9.04,
    "CustomFitExplanation": "string",
    "Testpicklist": "string",
    "Outcomes": "string",
    "OverallColor": "string",
    "CustomerObjectives": "string",
    "CurrentSalesVolume": 0.99,
    "ToGoal": 4.94,
    "NumberOfProjects": 4.13,
    "ProjectEffort": "string",
    "ProjectImpact": "string",
    "BlogsPublishedLast7": 9.75,
    "WeeklyBlogsLimit": 9.86,
    "BlogsRemaining": 1.23,
    "NotesLastUpdated": "2021-05-11",
    "CompetitorsUsed": "string",
    "Employee": 5.02,
    "LicensesPurchased": 1.64,
    "AccountPenetration": 7.37,
    "ChurnReason": "string",
    "FeatureUse2": "string",
    "FeatureUse1": "string",
    "FeatureTurnedOn": "string",
    "Covid19IndustryRisk": "string",
    "Covid19CustomerNotes": "string",
    "Covid19Tier": "string",
    "SalesProductFit": "string",
    "SalesExpectations": "string",
    "SalesHandoverNotes": "string",
    "PartnerFit": "string",
    "PartnerCommunicationCadence": "string",
    "NumberOfSupportTicketsOverdue": "string",
    "NumberOfSupportEscalationslastMonth": "string",
    "WasTheCustomerAcquired": "string",
    "WasBudgetCut": "string",
    "DoWeHaveMultipleChampions": "string",
    "DidWeLoseAChampionThatHasNotBeenReplaced": "string",
    "Last90DaysNps": "string",
    "Last90DaysCsat": "string",
    "TotalPurchasedHoursForCurrentQuarter": "string",
    "TotalHoursUsed": "string",
    "FeatureRequests": "string",
    "Csm": "string",
    "SalesforceAccountOwner": "string",
    "SalesforceRegion": "string",
    "AdvId": "string",
    "AdSpendTotalLast30Days": 7.83,
    "ContractMinimum": 1.47,
    "BillingPeriodsInContractPerYear": "string",
    "ToContractMin": 8.81
  },
  "ContactsCount": 16,
  "CrmId": "string",
  "EndDate": "2021-05-11T16:38:27.7138801Z",
  "ExternalId": "string",
  "IsActive": true,
  "LicenseCount": 26,
  "Name": "string",
  "NextRenewalDate": "2021-05-11T16:38:27.7138801Z",
  "ObjectCreatedDate": "2021-05-11T16:38:27.7138801Z",
  "ObjectLastModifiedDate": "2021-05-11T16:38:27.7138801Z",
  "ParentAccountId": 29,
  "ParentNextRenewalDate": "2021-05-11T16:38:27.7138801Z",
  "ParentTotalContractAmount": 9.8,
  "PrimaryChurnScoreId": 9,
  "PrimaryChurnScoreValue": 8.95,
  "StartDate": "2021-05-11T16:38:27.7138801Z",
  "Tags": "string",
  "TenureInDays": 28,
  "TotalContractAmount": 1.22,
  "UsageFrequency": "string",
  "UserAccountId": 9,
  "PrimaryChurnScore@odata.navigationLink": "https://app.churnzero.net/public/v1/Account(8)/PrimaryChurnScore",
  "ParentAccount@odata.navigationLink": "https://app.churnzero.net/public/v1/Account(8)/ParentAccount",
  "UserAccount@odata.navigationLink": "https://app.churnzero.net/public/v1/Account(8)/UserAccount"
}
Parameters
Name Description
Id integer(int64)

Id of CustomListMSTeamsUsage

?$select array[string]

Select properties to be returned

Id, Name, UserAccountId, NextRenewalDate, ParentNextRenewalDate, TotalContractAmount, ParentTotalContractAmount, IsActive, ExternalId, BillingAddressLine1, BillingAddressLine2, BillingAddressCity, BillingAddressState, BillingAddressZip, BillingAddressCountry, StartDate, EndDate, LicenseCount, CrmId, TenureInDays, PrimaryChurnScoreId, PrimaryChurnScoreValue, UsageFrequency, ContactsCount, ParentAccountId, Tags, ObjectCreatedDate, ObjectLastModifiedDate, Cf/SupportOwnerId, Cf/ProductEdition, Cf/Emailcredits, Cf/AtRisk, Cf/UpsellAmount, Cf/CustomerSentiment, Cf/SentimentLastUpdated, Cf/ExecutiveSponsorHasLeft, Cf/Industry, Cf/KpisMet, Cf/Valuescore, Cf/Cstier, Cf/Elpmodel, Cf/EmailCreditsPurchased, Cf/GoLiveDate, Cf/Lifecyclestage, Cf/OnboardingObjective, Cf/TrainingConfigurationNotes, Cf/EngagementScore, Cf/N30DayTimeSpent, Cf/TrainingConfigurationKpisMet, Cf/SalesforceIntegration, Cf/TwitterOauth, Cf/CustomerFit110, Cf/CustomFitExplanation, Cf/Testpicklist, Cf/Outcomes, Cf/OverallColor, Cf/CustomerObjectives, Cf/CurrentSalesVolume, Cf/ToGoal, Cf/NumberOfProjects, Cf/ProjectEffort, Cf/ProjectImpact, Cf/BlogsPublishedLast7, Cf/WeeklyBlogsLimit, Cf/BlogsRemaining, Cf/NotesLastUpdated, Cf/CompetitorsUsed, Cf/Employee, Cf/LicensesPurchased, Cf/AccountPenetration, Cf/ChurnReason, Cf/FeatureUse2, Cf/FeatureUse1, Cf/FeatureTurnedOn, Cf/Covid19IndustryRisk, Cf/Covid19CustomerNotes, Cf/Covid19Tier, Cf/SalesProductFit, Cf/SalesExpectations, Cf/SalesHandoverNotes, Cf/PartnerFit, Cf/PartnerCommunicationCadence, Cf/NumberOfSupportTicketsOverdue, Cf/NumberOfSupportEscalationslastMonth, Cf/WasTheCustomerAcquired, Cf/WasBudgetCut, Cf/DoWeHaveMultipleChampions, Cf/DidWeLoseAChampionThatHasNotBeenReplaced, Cf/Last90DaysNps, Cf/Last90DaysCsat, Cf/TotalPurchasedHoursForCurrentQuarter, Cf/TotalHoursUsed, Cf/FeatureRequests, Cf/Csm, Cf/SalesforceAccountOwner, Cf/SalesforceRegion, Cf/AdvId, Cf/AdSpendTotalLast30Days, Cf/ContractMinimum, Cf/BillingPeriodsInContractPerYear, Cf/ToContractMin
↓ Show Options ↓↑ Hide Options ↑
?$expand array[string]

Expand related entities

*, PrimaryChurnScore, ParentAccount, UserAccount
↓ Show Options ↓↑ Hide Options ↑
Responses
Status Description
200 Account

Retrieved navigation property

400 Error

Bad Request

401 Error

Unauthorized

403 Error

Forbidden

404 Error

Not Found

409 Error

Conflict

429 Error

Too Many Requests

500 Error

Internal Server Error


CustomListElevTest

Permissions

Bulk Read - Custom Tables


Get all CustomElevTests

GET /CustomListElevTest

Code samples

curl -X GET "https://app.churnzero.net/public/v1/CustomListElevTest" \
-H "Authorization: Basic c29tZXVzZXI6c3VwM3JTM2NyMzch"

200 response

{
  "value": [
    {
      "Id": 5,
      "Accountname": "string",
      "Cstier": "string",
      "CzAccountNameId": 28,
      "Engagementscore": 0.22,
      "Lifecyclestage": "string",
      "Obfuscatedarr": 9.86,
      "ObjectCreatedDate": "2021-05-11T16:38:31.0416404Z",
      "ObjectLastModifiedDate": "2021-05-11T16:38:31.0416404Z",
      "Overallcolor": "string",
      "Overallscore": 6.48,
      "Renewal": "2021-05-11",
      "Renewalscore": "string",
      "State": "string",
      "Successlead": "string",
      "ValueScore": 0.37,
      "CzAccountName@odata.navigationLink": "https://app.churnzero.net/public/v1/CustomListElevTest(5)/CzAccountName"
    }
  ],
  "@odata.nextLink": "https://app.churnzero.net/public/v1/CustomListElevTest?$skip=100"
}
Parameters
Name Description
?$filter array[string]

Filter items by property values

CzAccountNameId, Accountname, State, ValueScore, Engagementscore, Obfuscatedarr, Renewal, Overallcolor, Overallscore, Renewalscore, Lifecyclestage, Successlead, Cstier, Use/SegmentId, Use/SegmentColumnSetId
↓ Show Options ↓↑ Hide Options ↑
?$orderby array[string]

Order items by property values

ObjectCreatedDate, ObjectLastModifiedDate, Accountname, State, ValueScore, Engagementscore, Obfuscatedarr, Renewal, Overallcolor, Overallscore, Renewalscore, Lifecyclestage, Successlead, Cstier
↓ Show Options ↓↑ Hide Options ↑
?$select array[string]

Select properties to be returned

CzAccountNameId, Accountname, State, ValueScore, Engagementscore, Obfuscatedarr, Renewal, Overallcolor, Overallscore, Renewalscore, Lifecyclestage, Successlead, Cstier
↓ Show Options ↓↑ Hide Options ↑
?$expand array[string]

Expand related entities

*, CzAccountName
↓ Show Options ↓↑ Hide Options ↑
?$top integer(int32)

Show only the first n items

?$skip integer(int32)

Skip the first n items

?$count boolean

Include count of items

Responses
Status Description
200 array[CustomListElevTest]

Retrieved entities

400 Error

Bad Request

401 Error

Unauthorized

403 Error

Forbidden

409 Error

Conflict

429 Error

Too Many Requests

500 Error

Internal Server Error


Get a CustomListElevTest

GET /CustomListElevTest({Id})

Code samples

curl -X GET "https://app.churnzero.net/public/v1/CustomListElevTest(5)" \
-H "Authorization: Basic c29tZXVzZXI6c3VwM3JTM2NyMzch"

200 response

{
  "Id": 5,
  "Accountname": "string",
  "Cstier": "string",
  "CzAccountNameId": 28,
  "Engagementscore": 0.22,
  "Lifecyclestage": "string",
  "Obfuscatedarr": 9.86,
  "ObjectCreatedDate": "2021-05-11T16:38:31.0416404Z",
  "ObjectLastModifiedDate": "2021-05-11T16:38:31.0416404Z",
  "Overallcolor": "string",
  "Overallscore": 6.48,
  "Renewal": "2021-05-11",
  "Renewalscore": "string",
  "State": "string",
  "Successlead": "string",
  "ValueScore": 0.37,
  "CzAccountName@odata.navigationLink": "https://app.churnzero.net/public/v1/CustomListElevTest(5)/CzAccountName"
}
Parameters
Name Description
Id integer(int64)

Id of CustomListElevTest

?$select array[string]

Select properties to be returned

CzAccountNameId, Accountname, State, ValueScore, Engagementscore, Obfuscatedarr, Renewal, Overallcolor, Overallscore, Renewalscore, Lifecyclestage, Successlead, Cstier
↓ Show Options ↓↑ Hide Options ↑
?$expand array[string]

Expand related entities

*, CzAccountName
↓ Show Options ↓↑ Hide Options ↑
Responses
Status Description
200 CustomListElevTest

Retrieved entity

400 Error

Bad Request

401 Error

Unauthorized

403 Error

Forbidden

404 Error

Not Found

409 Error

Conflict

429 Error

Too Many Requests

500 Error

Internal Server Error


Get the CzAccountName

GET /CustomListElevTest({Id})/CzAccountName

Code samples

curl -X GET "https://app.churnzero.net/public/v1/CustomListElevTest(5)/CzAccountName" \
-H "Authorization: Basic c29tZXVzZXI6c3VwM3JTM2NyMzch"

200 response

{
  "Id": 8,
  "BillingAddressCity": "string",
  "BillingAddressCountry": "string",
  "BillingAddressLine1": "string",
  "BillingAddressLine2": "string",
  "BillingAddressState": "string",
  "BillingAddressZip": "string",
  "Cf": {
    "SupportOwnerId": 15,
    "ProductEdition": "string",
    "Emailcredits": 7.23,
    "AtRisk": true,
    "UpsellAmount": 5.0,
    "CustomerSentiment": "string",
    "SentimentLastUpdated": "2021-05-11",
    "ExecutiveSponsorHasLeft": true,
    "Industry": "string",
    "KpisMet": true,
    "Valuescore": 4.56,
    "Cstier": "string",
    "Elpmodel": "string",
    "EmailCreditsPurchased": 9.13,
    "GoLiveDate": "2021-05-11",
    "Lifecyclestage": "string",
    "OnboardingObjective": "string",
    "TrainingConfigurationNotes": "string",
    "EngagementScore": 9.11,
    "N30DayTimeSpent": 3.64,
    "TrainingConfigurationKpisMet": true,
    "SalesforceIntegration": true,
    "TwitterOauth": false,
    "CustomerFit110": 9.04,
    "CustomFitExplanation": "string",
    "Testpicklist": "string",
    "Outcomes": "string",
    "OverallColor": "string",
    "CustomerObjectives": "string",
    "CurrentSalesVolume": 0.99,
    "ToGoal": 4.94,
    "NumberOfProjects": 4.13,
    "ProjectEffort": "string",
    "ProjectImpact": "string",
    "BlogsPublishedLast7": 9.75,
    "WeeklyBlogsLimit": 9.86,
    "BlogsRemaining": 1.23,
    "NotesLastUpdated": "2021-05-11",
    "CompetitorsUsed": "string",
    "Employee": 5.02,
    "LicensesPurchased": 1.64,
    "AccountPenetration": 7.37,
    "ChurnReason": "string",
    "FeatureUse2": "string",
    "FeatureUse1": "string",
    "FeatureTurnedOn": "string",
    "Covid19IndustryRisk": "string",
    "Covid19CustomerNotes": "string",
    "Covid19Tier": "string",
    "SalesProductFit": "string",
    "SalesExpectations": "string",
    "SalesHandoverNotes": "string",
    "PartnerFit": "string",
    "PartnerCommunicationCadence": "string",
    "NumberOfSupportTicketsOverdue": "string",
    "NumberOfSupportEscalationslastMonth": "string",
    "WasTheCustomerAcquired": "string",
    "WasBudgetCut": "string",
    "DoWeHaveMultipleChampions": "string",
    "DidWeLoseAChampionThatHasNotBeenReplaced": "string",
    "Last90DaysNps": "string",
    "Last90DaysCsat": "string",
    "TotalPurchasedHoursForCurrentQuarter": "string",
    "TotalHoursUsed": "string",
    "FeatureRequests": "string",
    "Csm": "string",
    "SalesforceAccountOwner": "string",
    "SalesforceRegion": "string",
    "AdvId": "string",
    "AdSpendTotalLast30Days": 7.83,
    "ContractMinimum": 1.47,
    "BillingPeriodsInContractPerYear": "string",
    "ToContractMin": 8.81
  },
  "ContactsCount": 16,
  "CrmId": "string",
  "EndDate": "2021-05-11T16:38:27.7138801Z",
  "ExternalId": "string",
  "IsActive": true,
  "LicenseCount": 26,
  "Name": "string",
  "NextRenewalDate": "2021-05-11T16:38:27.7138801Z",
  "ObjectCreatedDate": "2021-05-11T16:38:27.7138801Z",
  "ObjectLastModifiedDate": "2021-05-11T16:38:27.7138801Z",
  "ParentAccountId": 29,
  "ParentNextRenewalDate": "2021-05-11T16:38:27.7138801Z",
  "ParentTotalContractAmount": 9.8,
  "PrimaryChurnScoreId": 9,
  "PrimaryChurnScoreValue": 8.95,
  "StartDate": "2021-05-11T16:38:27.7138801Z",
  "Tags": "string",
  "TenureInDays": 28,
  "TotalContractAmount": 1.22,
  "UsageFrequency": "string",
  "UserAccountId": 9,
  "PrimaryChurnScore@odata.navigationLink": "https://app.churnzero.net/public/v1/Account(8)/PrimaryChurnScore",
  "ParentAccount@odata.navigationLink": "https://app.churnzero.net/public/v1/Account(8)/ParentAccount",
  "UserAccount@odata.navigationLink": "https://app.churnzero.net/public/v1/Account(8)/UserAccount"
}
Parameters
Name Description
Id integer(int64)

Id of CustomListElevTest

?$select array[string]

Select properties to be returned

Id, Name, UserAccountId, NextRenewalDate, ParentNextRenewalDate, TotalContractAmount, ParentTotalContractAmount, IsActive, ExternalId, BillingAddressLine1, BillingAddressLine2, BillingAddressCity, BillingAddressState, BillingAddressZip, BillingAddressCountry, StartDate, EndDate, LicenseCount, CrmId, TenureInDays, PrimaryChurnScoreId, PrimaryChurnScoreValue, UsageFrequency, ContactsCount, ParentAccountId, Tags, ObjectCreatedDate, ObjectLastModifiedDate, Cf/SupportOwnerId, Cf/ProductEdition, Cf/Emailcredits, Cf/AtRisk, Cf/UpsellAmount, Cf/CustomerSentiment, Cf/SentimentLastUpdated, Cf/ExecutiveSponsorHasLeft, Cf/Industry, Cf/KpisMet, Cf/Valuescore, Cf/Cstier, Cf/Elpmodel, Cf/EmailCreditsPurchased, Cf/GoLiveDate, Cf/Lifecyclestage, Cf/OnboardingObjective, Cf/TrainingConfigurationNotes, Cf/EngagementScore, Cf/N30DayTimeSpent, Cf/TrainingConfigurationKpisMet, Cf/SalesforceIntegration, Cf/TwitterOauth, Cf/CustomerFit110, Cf/CustomFitExplanation, Cf/Testpicklist, Cf/Outcomes, Cf/OverallColor, Cf/CustomerObjectives, Cf/CurrentSalesVolume, Cf/ToGoal, Cf/NumberOfProjects, Cf/ProjectEffort, Cf/ProjectImpact, Cf/BlogsPublishedLast7, Cf/WeeklyBlogsLimit, Cf/BlogsRemaining, Cf/NotesLastUpdated, Cf/CompetitorsUsed, Cf/Employee, Cf/LicensesPurchased, Cf/AccountPenetration, Cf/ChurnReason, Cf/FeatureUse2, Cf/FeatureUse1, Cf/FeatureTurnedOn, Cf/Covid19IndustryRisk, Cf/Covid19CustomerNotes, Cf/Covid19Tier, Cf/SalesProductFit, Cf/SalesExpectations, Cf/SalesHandoverNotes, Cf/PartnerFit, Cf/PartnerCommunicationCadence, Cf/NumberOfSupportTicketsOverdue, Cf/NumberOfSupportEscalationslastMonth, Cf/WasTheCustomerAcquired, Cf/WasBudgetCut, Cf/DoWeHaveMultipleChampions, Cf/DidWeLoseAChampionThatHasNotBeenReplaced, Cf/Last90DaysNps, Cf/Last90DaysCsat, Cf/TotalPurchasedHoursForCurrentQuarter, Cf/TotalHoursUsed, Cf/FeatureRequests, Cf/Csm, Cf/SalesforceAccountOwner, Cf/SalesforceRegion, Cf/AdvId, Cf/AdSpendTotalLast30Days, Cf/ContractMinimum, Cf/BillingPeriodsInContractPerYear, Cf/ToContractMin
↓ Show Options ↓↑ Hide Options ↑
?$expand array[string]

Expand related entities

*, PrimaryChurnScore, ParentAccount, UserAccount
↓ Show Options ↓↑ Hide Options ↑
Responses
Status Description
200 Account

Retrieved navigation property

400 Error

Bad Request

401 Error

Unauthorized

403 Error

Forbidden

404 Error

Not Found

409 Error

Conflict

429 Error

Too Many Requests

500 Error

Internal Server Error


CustomListIncidentServiceRequest

Permissions

Bulk Read - Custom Tables


Get all CustomIncidentServiceRequests

GET /CustomListIncidentServiceRequest

Code samples

curl -X GET "https://app.churnzero.net/public/v1/CustomListIncidentServiceRequest" \
-H "Authorization: Basic c29tZXVzZXI6c3VwM3JTM2NyMzch"

200 response

{
  "value": [
    {
      "Id": 6,
      "AccountId": 2,
      "Approvers2Id": 12,
      "AssigneeId": 23,
      "Build": "string",
      "CabReviewer": "string",
      "CabReviewer2": "string",
      "Category": "string",
      "CodeFixRequired": false,
      "Created": "2021-05-11T16:38:31.3494739Z",
      "CustomFieldApproversId": 25,
      "Description": "string",
      "IssueKey": "string",
      "IssueType": "string",
      "ObjectCreatedDate": "2021-05-11T16:38:31.3494739Z",
      "ObjectLastModifiedDate": "2021-05-11T16:38:31.3494739Z",
      "Priority": "string",
      "Reporter": "string",
      "RequesterType": "string",
      "Resolved": "2021-05-11T16:38:31.3494739Z",
      "Status": "string",
      "Summary": "string",
      "Updated": "2021-05-11T16:38:31.3494739Z",
      "Assignee@odata.navigationLink": "https://app.churnzero.net/public/v1/CustomListIncidentServiceRequest(6)/Assignee",
      "CustomFieldApprovers@odata.navigationLink": "https://app.churnzero.net/public/v1/CustomListIncidentServiceRequest(6)/CustomFieldApprovers",
      "Approvers2@odata.navigationLink": "https://app.churnzero.net/public/v1/CustomListIncidentServiceRequest(6)/Approvers2",
      "Account@odata.navigationLink": "https://app.churnzero.net/public/v1/CustomListIncidentServiceRequest(6)/Account"
    }
  ],
  "@odata.nextLink": "https://app.churnzero.net/public/v1/CustomListIncidentServiceRequest?$skip=100"
}
Parameters
Name Description
?$filter array[string]

Filter items by property values

IssueKey, IssueType, Status, Priority, AssigneeId, Reporter, Created, Updated, Resolved, Description, CustomFieldApproversId, Approvers2Id, Build, CabReviewer, CabReviewer2, Category, CodeFixRequired, AccountId, RequesterType, Use/SegmentId, Use/SegmentColumnSetId
↓ Show Options ↓↑ Hide Options ↑
?$orderby array[string]

Order items by property values

ObjectCreatedDate, ObjectLastModifiedDate, IssueKey, IssueType, Status, Priority, Reporter, Created, Updated, Resolved, Description, Build, CabReviewer, CabReviewer2, Category, CodeFixRequired, RequesterType
↓ Show Options ↓↑ Hide Options ↑
?$select array[string]

Select properties to be returned

Summary, IssueKey, IssueType, Status, Priority, AssigneeId, Reporter, Created, Updated, Resolved, Description, CustomFieldApproversId, Approvers2Id, Build, CabReviewer, CabReviewer2, Category, CodeFixRequired, AccountId, RequesterType
↓ Show Options ↓↑ Hide Options ↑
?$expand array[string]

Expand related entities

*, Assignee, CustomFieldApprovers, Approvers2, Account
↓ Show Options ↓↑ Hide Options ↑
?$top integer(int32)

Show only the first n items

?$skip integer(int32)

Skip the first n items

?$count boolean

Include count of items

Responses
Status Description
200 array[CustomListIncidentServiceRequest]

Retrieved entities

400 Error

Bad Request

401 Error

Unauthorized

403 Error

Forbidden

409 Error

Conflict

429 Error

Too Many Requests

500 Error

Internal Server Error


Get a CustomListIncidentServiceRequest

GET /CustomListIncidentServiceRequest({Id})

Code samples

curl -X GET "https://app.churnzero.net/public/v1/CustomListIncidentServiceRequest(6)" \
-H "Authorization: Basic c29tZXVzZXI6c3VwM3JTM2NyMzch"

200 response

{
  "Id": 6,
  "AccountId": 2,
  "Approvers2Id": 12,
  "AssigneeId": 23,
  "Build": "string",
  "CabReviewer": "string",
  "CabReviewer2": "string",
  "Category": "string",
  "CodeFixRequired": false,
  "Created": "2021-05-11T16:38:31.3494739Z",
  "CustomFieldApproversId": 25,
  "Description": "string",
  "IssueKey": "string",
  "IssueType": "string",
  "ObjectCreatedDate": "2021-05-11T16:38:31.3494739Z",
  "ObjectLastModifiedDate": "2021-05-11T16:38:31.3494739Z",
  "Priority": "string",
  "Reporter": "string",
  "RequesterType": "string",
  "Resolved": "2021-05-11T16:38:31.3494739Z",
  "Status": "string",
  "Summary": "string",
  "Updated": "2021-05-11T16:38:31.3494739Z",
  "Assignee@odata.navigationLink": "https://app.churnzero.net/public/v1/CustomListIncidentServiceRequest(6)/Assignee",
  "CustomFieldApprovers@odata.navigationLink": "https://app.churnzero.net/public/v1/CustomListIncidentServiceRequest(6)/CustomFieldApprovers",
  "Approvers2@odata.navigationLink": "https://app.churnzero.net/public/v1/CustomListIncidentServiceRequest(6)/Approvers2",
  "Account@odata.navigationLink": "https://app.churnzero.net/public/v1/CustomListIncidentServiceRequest(6)/Account"
}
Parameters
Name Description
Id integer(int64)

Id of CustomListIncidentServiceRequest

?$select array[string]

Select properties to be returned

Summary, IssueKey, IssueType, Status, Priority, AssigneeId, Reporter, Created, Updated, Resolved, Description, CustomFieldApproversId, Approvers2Id, Build, CabReviewer, CabReviewer2, Category, CodeFixRequired, AccountId, RequesterType
↓ Show Options ↓↑ Hide Options ↑
?$expand array[string]

Expand related entities

*, Assignee, CustomFieldApprovers, Approvers2, Account
↓ Show Options ↓↑ Hide Options ↑
Responses
Status Description
200 CustomListIncidentServiceRequest

Retrieved entity

400 Error

Bad Request

401 Error

Unauthorized

403 Error

Forbidden

404 Error

Not Found

409 Error

Conflict

429 Error

Too Many Requests

500 Error

Internal Server Error


Get the Account

GET /CustomListIncidentServiceRequest({Id})/Account

Code samples

curl -X GET "https://app.churnzero.net/public/v1/CustomListIncidentServiceRequest(6)/Account" \
-H "Authorization: Basic c29tZXVzZXI6c3VwM3JTM2NyMzch"

200 response

{
  "Id": 8,
  "BillingAddressCity": "string",
  "BillingAddressCountry": "string",
  "BillingAddressLine1": "string",
  "BillingAddressLine2": "string",
  "BillingAddressState": "string",
  "BillingAddressZip": "string",
  "Cf": {
    "SupportOwnerId": 15,
    "ProductEdition": "string",
    "Emailcredits": 7.23,
    "AtRisk": true,
    "UpsellAmount": 5.0,
    "CustomerSentiment": "string",
    "SentimentLastUpdated": "2021-05-11",
    "ExecutiveSponsorHasLeft": true,
    "Industry": "string",
    "KpisMet": true,
    "Valuescore": 4.56,
    "Cstier": "string",
    "Elpmodel": "string",
    "EmailCreditsPurchased": 9.13,
    "GoLiveDate": "2021-05-11",
    "Lifecyclestage": "string",
    "OnboardingObjective": "string",
    "TrainingConfigurationNotes": "string",
    "EngagementScore": 9.11,
    "N30DayTimeSpent": 3.64,
    "TrainingConfigurationKpisMet": true,
    "SalesforceIntegration": true,
    "TwitterOauth": false,
    "CustomerFit110": 9.04,
    "CustomFitExplanation": "string",
    "Testpicklist": "string",
    "Outcomes": "string",
    "OverallColor": "string",
    "CustomerObjectives": "string",
    "CurrentSalesVolume": 0.99,
    "ToGoal": 4.94,
    "NumberOfProjects": 4.13,
    "ProjectEffort": "string",
    "ProjectImpact": "string",
    "BlogsPublishedLast7": 9.75,
    "WeeklyBlogsLimit": 9.86,
    "BlogsRemaining": 1.23,
    "NotesLastUpdated": "2021-05-11",
    "CompetitorsUsed": "string",
    "Employee": 5.02,
    "LicensesPurchased": 1.64,
    "AccountPenetration": 7.37,
    "ChurnReason": "string",
    "FeatureUse2": "string",
    "FeatureUse1": "string",
    "FeatureTurnedOn": "string",
    "Covid19IndustryRisk": "string",
    "Covid19CustomerNotes": "string",
    "Covid19Tier": "string",
    "SalesProductFit": "string",
    "SalesExpectations": "string",
    "SalesHandoverNotes": "string",
    "PartnerFit": "string",
    "PartnerCommunicationCadence": "string",
    "NumberOfSupportTicketsOverdue": "string",
    "NumberOfSupportEscalationslastMonth": "string",
    "WasTheCustomerAcquired": "string",
    "WasBudgetCut": "string",
    "DoWeHaveMultipleChampions": "string",
    "DidWeLoseAChampionThatHasNotBeenReplaced": "string",
    "Last90DaysNps": "string",
    "Last90DaysCsat": "string",
    "TotalPurchasedHoursForCurrentQuarter": "string",
    "TotalHoursUsed": "string",
    "FeatureRequests": "string",
    "Csm": "string",
    "SalesforceAccountOwner": "string",
    "SalesforceRegion": "string",
    "AdvId": "string",
    "AdSpendTotalLast30Days": 7.83,
    "ContractMinimum": 1.47,
    "BillingPeriodsInContractPerYear": "string",
    "ToContractMin": 8.81
  },
  "ContactsCount": 16,
  "CrmId": "string",
  "EndDate": "2021-05-11T16:38:27.7138801Z",
  "ExternalId": "string",
  "IsActive": true,
  "LicenseCount": 26,
  "Name": "string",
  "NextRenewalDate": "2021-05-11T16:38:27.7138801Z",
  "ObjectCreatedDate": "2021-05-11T16:38:27.7138801Z",
  "ObjectLastModifiedDate": "2021-05-11T16:38:27.7138801Z",
  "ParentAccountId": 29,
  "ParentNextRenewalDate": "2021-05-11T16:38:27.7138801Z",
  "ParentTotalContractAmount": 9.8,
  "PrimaryChurnScoreId": 9,
  "PrimaryChurnScoreValue": 8.95,
  "StartDate": "2021-05-11T16:38:27.7138801Z",
  "Tags": "string",
  "TenureInDays": 28,
  "TotalContractAmount": 1.22,
  "UsageFrequency": "string",
  "UserAccountId": 9,
  "PrimaryChurnScore@odata.navigationLink": "https://app.churnzero.net/public/v1/Account(8)/PrimaryChurnScore",
  "ParentAccount@odata.navigationLink": "https://app.churnzero.net/public/v1/Account(8)/ParentAccount",
  "UserAccount@odata.navigationLink": "https://app.churnzero.net/public/v1/Account(8)/UserAccount"
}
Parameters
Name Description
Id integer(int64)

Id of CustomListIncidentServiceRequest

?$select array[string]

Select properties to be returned

Id, Name, UserAccountId, NextRenewalDate, ParentNextRenewalDate, TotalContractAmount, ParentTotalContractAmount, IsActive, ExternalId, BillingAddressLine1, BillingAddressLine2, BillingAddressCity, BillingAddressState, BillingAddressZip, BillingAddressCountry, StartDate, EndDate, LicenseCount, CrmId, TenureInDays, PrimaryChurnScoreId, PrimaryChurnScoreValue, UsageFrequency, ContactsCount, ParentAccountId, Tags, ObjectCreatedDate, ObjectLastModifiedDate, Cf/SupportOwnerId, Cf/ProductEdition, Cf/Emailcredits, Cf/AtRisk, Cf/UpsellAmount, Cf/CustomerSentiment, Cf/SentimentLastUpdated, Cf/ExecutiveSponsorHasLeft, Cf/Industry, Cf/KpisMet, Cf/Valuescore, Cf/Cstier, Cf/Elpmodel, Cf/EmailCreditsPurchased, Cf/GoLiveDate, Cf/Lifecyclestage, Cf/OnboardingObjective, Cf/TrainingConfigurationNotes, Cf/EngagementScore, Cf/N30DayTimeSpent, Cf/TrainingConfigurationKpisMet, Cf/SalesforceIntegration, Cf/TwitterOauth, Cf/CustomerFit110, Cf/CustomFitExplanation, Cf/Testpicklist, Cf/Outcomes, Cf/OverallColor, Cf/CustomerObjectives, Cf/CurrentSalesVolume, Cf/ToGoal, Cf/NumberOfProjects, Cf/ProjectEffort, Cf/ProjectImpact, Cf/BlogsPublishedLast7, Cf/WeeklyBlogsLimit, Cf/BlogsRemaining, Cf/NotesLastUpdated, Cf/CompetitorsUsed, Cf/Employee, Cf/LicensesPurchased, Cf/AccountPenetration, Cf/ChurnReason, Cf/FeatureUse2, Cf/FeatureUse1, Cf/FeatureTurnedOn, Cf/Covid19IndustryRisk, Cf/Covid19CustomerNotes, Cf/Covid19Tier, Cf/SalesProductFit, Cf/SalesExpectations, Cf/SalesHandoverNotes, Cf/PartnerFit, Cf/PartnerCommunicationCadence, Cf/NumberOfSupportTicketsOverdue, Cf/NumberOfSupportEscalationslastMonth, Cf/WasTheCustomerAcquired, Cf/WasBudgetCut, Cf/DoWeHaveMultipleChampions, Cf/DidWeLoseAChampionThatHasNotBeenReplaced, Cf/Last90DaysNps, Cf/Last90DaysCsat, Cf/TotalPurchasedHoursForCurrentQuarter, Cf/TotalHoursUsed, Cf/FeatureRequests, Cf/Csm, Cf/SalesforceAccountOwner, Cf/SalesforceRegion, Cf/AdvId, Cf/AdSpendTotalLast30Days, Cf/ContractMinimum, Cf/BillingPeriodsInContractPerYear, Cf/ToContractMin
↓ Show Options ↓↑ Hide Options ↑
?$expand array[string]

Expand related entities

*, PrimaryChurnScore, ParentAccount, UserAccount
↓ Show Options ↓↑ Hide Options ↑
Responses
Status Description
200 Account

Retrieved navigation property

400 Error

Bad Request

401 Error

Unauthorized

403 Error

Forbidden

404 Error

Not Found

409 Error

Conflict

429 Error

Too Many Requests

500 Error

Internal Server Error


Get the Approvers2

GET /CustomListIncidentServiceRequest({Id})/Approvers2

Code samples

curl -X GET "https://app.churnzero.net/public/v1/CustomListIncidentServiceRequest(6)/Approvers2" \
-H "Authorization: Basic c29tZXVzZXI6c3VwM3JTM2NyMzch"

200 response

{
  "Id": 8,
  "AvatarUrl": "string",
  "CanLogIn": false,
  "Cf": {
    "CalendarLink": "string"
  },
  "CrmId": "string",
  "Email": "string",
  "FirstName": "string",
  "HasAccounts": false,
  "IsActive": true,
  "LastName": "string",
  "MobilePhone": "string",
  "Name": "string",
  "ObjectCreatedDate": "2021-05-11T16:38:27.7373125Z",
  "ObjectLastModifiedDate": "2021-05-11T16:38:27.7373125Z",
  "OfficePhone": "string",
  "Title": "string",
  "UserName": "string"
}
Parameters
Name Description
Id integer(int64)

Id of CustomListIncidentServiceRequest

?$select array[string]

Select properties to be returned

Id, UserName, FirstName, LastName, Name, Email, HasAccounts, AvatarUrl, MobilePhone, OfficePhone, Title, CanLogIn, CrmId, IsActive, ObjectCreatedDate, ObjectLastModifiedDate, Cf/CalendarLink
↓ Show Options ↓↑ Hide Options ↑
?$expand array[string]

Expand related entities

*
↓ Show Options ↓↑ Hide Options ↑
Responses
Status Description
200 UserAccount

Retrieved navigation property

400 Error

Bad Request

401 Error

Unauthorized

403 Error

Forbidden

404 Error

Not Found

409 Error

Conflict

429 Error

Too Many Requests

500 Error

Internal Server Error


Get the Assignee

GET /CustomListIncidentServiceRequest({Id})/Assignee

Code samples

curl -X GET "https://app.churnzero.net/public/v1/CustomListIncidentServiceRequest(6)/Assignee" \
-H "Authorization: Basic c29tZXVzZXI6c3VwM3JTM2NyMzch"

200 response

{
  "Id": 8,
  "AvatarUrl": "string",
  "CanLogIn": false,
  "Cf": {
    "CalendarLink": "string"
  },
  "CrmId": "string",
  "Email": "string",
  "FirstName": "string",
  "HasAccounts": false,
  "IsActive": true,
  "LastName": "string",
  "MobilePhone": "string",
  "Name": "string",
  "ObjectCreatedDate": "2021-05-11T16:38:27.7373125Z",
  "ObjectLastModifiedDate": "2021-05-11T16:38:27.7373125Z",
  "OfficePhone": "string",
  "Title": "string",
  "UserName": "string"
}
Parameters
Name Description
Id integer(int64)

Id of CustomListIncidentServiceRequest

?$select array[string]

Select properties to be returned

Id, UserName, FirstName, LastName, Name, Email, HasAccounts, AvatarUrl, MobilePhone, OfficePhone, Title, CanLogIn, CrmId, IsActive, ObjectCreatedDate, ObjectLastModifiedDate, Cf/CalendarLink
↓ Show Options ↓↑ Hide Options ↑
?$expand array[string]

Expand related entities

*
↓ Show Options ↓↑ Hide Options ↑
Responses
Status Description
200 UserAccount

Retrieved navigation property

400 Error

Bad Request

401 Error

Unauthorized

403 Error

Forbidden

404 Error

Not Found

409 Error

Conflict

429 Error

Too Many Requests

500 Error

Internal Server Error


Get the CustomFieldApprovers

GET /CustomListIncidentServiceRequest({Id})/CustomFieldApprovers

Code samples

curl -X GET "https://app.churnzero.net/public/v1/CustomListIncidentServiceRequest(6)/CustomFieldApprovers" \
-H "Authorization: Basic c29tZXVzZXI6c3VwM3JTM2NyMzch"

200 response

{
  "Id": 8,
  "AvatarUrl": "string",
  "CanLogIn": false,
  "Cf": {
    "CalendarLink": "string"
  },
  "CrmId": "string",
  "Email": "string",
  "FirstName": "string",
  "HasAccounts": false,
  "IsActive": true,
  "LastName": "string",
  "MobilePhone": "string",
  "Name": "string",
  "ObjectCreatedDate": "2021-05-11T16:38:27.7373125Z",
  "ObjectLastModifiedDate": "2021-05-11T16:38:27.7373125Z",
  "OfficePhone": "string",
  "Title": "string",
  "UserName": "string"
}
Parameters
Name Description
Id integer(int64)

Id of CustomListIncidentServiceRequest

?$select array[string]

Select properties to be returned

Id, UserName, FirstName, LastName, Name, Email, HasAccounts, AvatarUrl, MobilePhone, OfficePhone, Title, CanLogIn, CrmId, IsActive, ObjectCreatedDate, ObjectLastModifiedDate, Cf/CalendarLink
↓ Show Options ↓↑ Hide Options ↑
?$expand array[string]

Expand related entities

*
↓ Show Options ↓↑ Hide Options ↑
Responses
Status Description
200 UserAccount

Retrieved navigation property

400 Error

Bad Request

401 Error

Unauthorized

403 Error

Forbidden

404 Error

Not Found

409 Error

Conflict

429 Error

Too Many Requests

500 Error

Internal Server Error


CustomListClientInvoicingData

Permissions

Bulk Read - Custom Tables


Get all CustomClientInvoicingData

GET /CustomListClientInvoicingData

Code samples

curl -X GET "https://app.churnzero.net/public/v1/CustomListClientInvoicingData" \
-H "Authorization: Basic c29tZXVzZXI6c3VwM3JTM2NyMzch"

200 response

{
  "value": [
    {
      "Id": 9,
      "AccountId": 4,
      "Advancearrear": "string",
      "AmountUsdEquivalentOnTheDateOfInvoice": 9.66,
      "Currency": "string",
      "Frequency": "string",
      "InvoiceDate": "2021-05-11",
      "InvoiceNumber": "string",
      "InvoicePeriodEndDate": "2021-05-11",
      "InvoicePeriodStartDate": "2021-05-11",
      "InvoiceServiceType": "string",
      "NextInvoiceDate": "2021-05-11",
      "NextInvoiceMonth": "string",
      "NextPeriodEndDate": "2021-05-11",
      "NextPeriodStartDate": "2021-05-11",
      "ObjectCreatedDate": "2021-05-11T16:38:31.6778471Z",
      "ObjectLastModifiedDate": "2021-05-11T16:38:31.6778471Z",
      "PaymentDueDate": "2021-05-11",
      "PaymentDueDateAsPerMsa": 4.85,
      "PaymentReceivedDate": "2021-05-11",
      "SowName": "string",
      "Account@odata.navigationLink": "https://app.churnzero.net/public/v1/CustomListClientInvoicingData(9)/Account"
    }
  ],
  "@odata.nextLink": "https://app.churnzero.net/public/v1/CustomListClientInvoicingData?$skip=100"
}
Parameters
Name Description
?$filter array[string]

Filter items by property values

SowName, InvoiceServiceType, Frequency, Advancearrear, PaymentDueDateAsPerMsa, InvoiceDate, InvoicePeriodStartDate, InvoicePeriodEndDate, AmountUsdEquivalentOnTheDateOfInvoice, Currency, PaymentDueDate, PaymentReceivedDate, NextPeriodStartDate, NextPeriodEndDate, NextInvoiceMonth, NextInvoiceDate, AccountId, Use/SegmentId, Use/SegmentColumnSetId
↓ Show Options ↓↑ Hide Options ↑
?$orderby array[string]

Order items by property values

ObjectCreatedDate, ObjectLastModifiedDate, SowName, InvoiceServiceType, Frequency, Advancearrear, PaymentDueDateAsPerMsa, InvoiceDate, InvoicePeriodStartDate, InvoicePeriodEndDate, AmountUsdEquivalentOnTheDateOfInvoice, Currency, PaymentDueDate, PaymentReceivedDate, NextPeriodStartDate, NextPeriodEndDate, NextInvoiceMonth, NextInvoiceDate
↓ Show Options ↓↑ Hide Options ↑
?$select array[string]

Select properties to be returned

InvoiceNumber, SowName, InvoiceServiceType, Frequency, Advancearrear, PaymentDueDateAsPerMsa, InvoiceDate, InvoicePeriodStartDate, InvoicePeriodEndDate, AmountUsdEquivalentOnTheDateOfInvoice, Currency, PaymentDueDate, PaymentReceivedDate, NextPeriodStartDate, NextPeriodEndDate, NextInvoiceMonth, NextInvoiceDate, AccountId
↓ Show Options ↓↑ Hide Options ↑
?$expand array[string]

Expand related entities

*, Account
↓ Show Options ↓↑ Hide Options ↑
?$top integer(int32)

Show only the first n items

?$skip integer(int32)

Skip the first n items

?$count boolean

Include count of items

Responses
Status Description
200 array[CustomListClientInvoicingData]

Retrieved entities

400 Error

Bad Request

401 Error

Unauthorized

403 Error

Forbidden

409 Error

Conflict

429 Error

Too Many Requests

500 Error

Internal Server Error


Get a CustomListClientInvoicingData

GET /CustomListClientInvoicingData({Id})

Code samples

curl -X GET "https://app.churnzero.net/public/v1/CustomListClientInvoicingData(9)" \
-H "Authorization: Basic c29tZXVzZXI6c3VwM3JTM2NyMzch"

200 response

{
  "Id": 9,
  "AccountId": 4,
  "Advancearrear": "string",
  "AmountUsdEquivalentOnTheDateOfInvoice": 9.66,
  "Currency": "string",
  "Frequency": "string",
  "InvoiceDate": "2021-05-11",
  "InvoiceNumber": "string",
  "InvoicePeriodEndDate": "2021-05-11",
  "InvoicePeriodStartDate": "2021-05-11",
  "InvoiceServiceType": "string",
  "NextInvoiceDate": "2021-05-11",
  "NextInvoiceMonth": "string",
  "NextPeriodEndDate": "2021-05-11",
  "NextPeriodStartDate": "2021-05-11",
  "ObjectCreatedDate": "2021-05-11T16:38:31.6778471Z",
  "ObjectLastModifiedDate": "2021-05-11T16:38:31.6778471Z",
  "PaymentDueDate": "2021-05-11",
  "PaymentDueDateAsPerMsa": 4.85,
  "PaymentReceivedDate": "2021-05-11",
  "SowName": "string",
  "Account@odata.navigationLink": "https://app.churnzero.net/public/v1/CustomListClientInvoicingData(9)/Account"
}
Parameters
Name Description
Id integer(int64)

Id of CustomListClientInvoicingData

?$select array[string]

Select properties to be returned

InvoiceNumber, SowName, InvoiceServiceType, Frequency, Advancearrear, PaymentDueDateAsPerMsa, InvoiceDate, InvoicePeriodStartDate, InvoicePeriodEndDate, AmountUsdEquivalentOnTheDateOfInvoice, Currency, PaymentDueDate, PaymentReceivedDate, NextPeriodStartDate, NextPeriodEndDate, NextInvoiceMonth, NextInvoiceDate, AccountId
↓ Show Options ↓↑ Hide Options ↑
?$expand array[string]

Expand related entities

*, Account
↓ Show Options ↓↑ Hide Options ↑
Responses
Status Description
200 CustomListClientInvoicingData

Retrieved entity

400 Error

Bad Request

401 Error

Unauthorized

403 Error

Forbidden

404 Error

Not Found

409 Error

Conflict

429 Error

Too Many Requests

500 Error

Internal Server Error


Get the Account

GET /CustomListClientInvoicingData({Id})/Account

Code samples

curl -X GET "https://app.churnzero.net/public/v1/CustomListClientInvoicingData(9)/Account" \
-H "Authorization: Basic c29tZXVzZXI6c3VwM3JTM2NyMzch"

200 response

{
  "Id": 8,
  "BillingAddressCity": "string",
  "BillingAddressCountry": "string",
  "BillingAddressLine1": "string",
  "BillingAddressLine2": "string",
  "BillingAddressState": "string",
  "BillingAddressZip": "string",
  "Cf": {
    "SupportOwnerId": 15,
    "ProductEdition": "string",
    "Emailcredits": 7.23,
    "AtRisk": true,
    "UpsellAmount": 5.0,
    "CustomerSentiment": "string",
    "SentimentLastUpdated": "2021-05-11",
    "ExecutiveSponsorHasLeft": true,
    "Industry": "string",
    "KpisMet": true,
    "Valuescore": 4.56,
    "Cstier": "string",
    "Elpmodel": "string",
    "EmailCreditsPurchased": 9.13,
    "GoLiveDate": "2021-05-11",
    "Lifecyclestage": "string",
    "OnboardingObjective": "string",
    "TrainingConfigurationNotes": "string",
    "EngagementScore": 9.11,
    "N30DayTimeSpent": 3.64,
    "TrainingConfigurationKpisMet": true,
    "SalesforceIntegration": true,
    "TwitterOauth": false,
    "CustomerFit110": 9.04,
    "CustomFitExplanation": "string",
    "Testpicklist": "string",
    "Outcomes": "string",
    "OverallColor": "string",
    "CustomerObjectives": "string",
    "CurrentSalesVolume": 0.99,
    "ToGoal": 4.94,
    "NumberOfProjects": 4.13,
    "ProjectEffort": "string",
    "ProjectImpact": "string",
    "BlogsPublishedLast7": 9.75,
    "WeeklyBlogsLimit": 9.86,
    "BlogsRemaining": 1.23,
    "NotesLastUpdated": "2021-05-11",
    "CompetitorsUsed": "string",
    "Employee": 5.02,
    "LicensesPurchased": 1.64,
    "AccountPenetration": 7.37,
    "ChurnReason": "string",
    "FeatureUse2": "string",
    "FeatureUse1": "string",
    "FeatureTurnedOn": "string",
    "Covid19IndustryRisk": "string",
    "Covid19CustomerNotes": "string",
    "Covid19Tier": "string",
    "SalesProductFit": "string",
    "SalesExpectations": "string",
    "SalesHandoverNotes": "string",
    "PartnerFit": "string",
    "PartnerCommunicationCadence": "string",
    "NumberOfSupportTicketsOverdue": "string",
    "NumberOfSupportEscalationslastMonth": "string",
    "WasTheCustomerAcquired": "string",
    "WasBudgetCut": "string",
    "DoWeHaveMultipleChampions": "string",
    "DidWeLoseAChampionThatHasNotBeenReplaced": "string",
    "Last90DaysNps": "string",
    "Last90DaysCsat": "string",
    "TotalPurchasedHoursForCurrentQuarter": "string",
    "TotalHoursUsed": "string",
    "FeatureRequests": "string",
    "Csm": "string",
    "SalesforceAccountOwner": "string",
    "SalesforceRegion": "string",
    "AdvId": "string",
    "AdSpendTotalLast30Days": 7.83,
    "ContractMinimum": 1.47,
    "BillingPeriodsInContractPerYear": "string",
    "ToContractMin": 8.81
  },
  "ContactsCount": 16,
  "CrmId": "string",
  "EndDate": "2021-05-11T16:38:27.7138801Z",
  "ExternalId": "string",
  "IsActive": true,
  "LicenseCount": 26,
  "Name": "string",
  "NextRenewalDate": "2021-05-11T16:38:27.7138801Z",
  "ObjectCreatedDate": "2021-05-11T16:38:27.7138801Z",
  "ObjectLastModifiedDate": "2021-05-11T16:38:27.7138801Z",
  "ParentAccountId": 29,
  "ParentNextRenewalDate": "2021-05-11T16:38:27.7138801Z",
  "ParentTotalContractAmount": 9.8,
  "PrimaryChurnScoreId": 9,
  "PrimaryChurnScoreValue": 8.95,
  "StartDate": "2021-05-11T16:38:27.7138801Z",
  "Tags": "string",
  "TenureInDays": 28,
  "TotalContractAmount": 1.22,
  "UsageFrequency": "string",
  "UserAccountId": 9,
  "PrimaryChurnScore@odata.navigationLink": "https://app.churnzero.net/public/v1/Account(8)/PrimaryChurnScore",
  "ParentAccount@odata.navigationLink": "https://app.churnzero.net/public/v1/Account(8)/ParentAccount",
  "UserAccount@odata.navigationLink": "https://app.churnzero.net/public/v1/Account(8)/UserAccount"
}
Parameters
Name Description
Id integer(int64)

Id of CustomListClientInvoicingData

?$select array[string]

Select properties to be returned

Id, Name, UserAccountId, NextRenewalDate, ParentNextRenewalDate, TotalContractAmount, ParentTotalContractAmount, IsActive, ExternalId, BillingAddressLine1, BillingAddressLine2, BillingAddressCity, BillingAddressState, BillingAddressZip, BillingAddressCountry, StartDate, EndDate, LicenseCount, CrmId, TenureInDays, PrimaryChurnScoreId, PrimaryChurnScoreValue, UsageFrequency, ContactsCount, ParentAccountId, Tags, ObjectCreatedDate, ObjectLastModifiedDate, Cf/SupportOwnerId, Cf/ProductEdition, Cf/Emailcredits, Cf/AtRisk, Cf/UpsellAmount, Cf/CustomerSentiment, Cf/SentimentLastUpdated, Cf/ExecutiveSponsorHasLeft, Cf/Industry, Cf/KpisMet, Cf/Valuescore, Cf/Cstier, Cf/Elpmodel, Cf/EmailCreditsPurchased, Cf/GoLiveDate, Cf/Lifecyclestage, Cf/OnboardingObjective, Cf/TrainingConfigurationNotes, Cf/EngagementScore, Cf/N30DayTimeSpent, Cf/TrainingConfigurationKpisMet, Cf/SalesforceIntegration, Cf/TwitterOauth, Cf/CustomerFit110, Cf/CustomFitExplanation, Cf/Testpicklist, Cf/Outcomes, Cf/OverallColor, Cf/CustomerObjectives, Cf/CurrentSalesVolume, Cf/ToGoal, Cf/NumberOfProjects, Cf/ProjectEffort, Cf/ProjectImpact, Cf/BlogsPublishedLast7, Cf/WeeklyBlogsLimit, Cf/BlogsRemaining, Cf/NotesLastUpdated, Cf/CompetitorsUsed, Cf/Employee, Cf/LicensesPurchased, Cf/AccountPenetration, Cf/ChurnReason, Cf/FeatureUse2, Cf/FeatureUse1, Cf/FeatureTurnedOn, Cf/Covid19IndustryRisk, Cf/Covid19CustomerNotes, Cf/Covid19Tier, Cf/SalesProductFit, Cf/SalesExpectations, Cf/SalesHandoverNotes, Cf/PartnerFit, Cf/PartnerCommunicationCadence, Cf/NumberOfSupportTicketsOverdue, Cf/NumberOfSupportEscalationslastMonth, Cf/WasTheCustomerAcquired, Cf/WasBudgetCut, Cf/DoWeHaveMultipleChampions, Cf/DidWeLoseAChampionThatHasNotBeenReplaced, Cf/Last90DaysNps, Cf/Last90DaysCsat, Cf/TotalPurchasedHoursForCurrentQuarter, Cf/TotalHoursUsed, Cf/FeatureRequests, Cf/Csm, Cf/SalesforceAccountOwner, Cf/SalesforceRegion, Cf/AdvId, Cf/AdSpendTotalLast30Days, Cf/ContractMinimum, Cf/BillingPeriodsInContractPerYear, Cf/ToContractMin
↓ Show Options ↓↑ Hide Options ↑
?$expand array[string]

Expand related entities

*, PrimaryChurnScore, ParentAccount, UserAccount
↓ Show Options ↓↑ Hide Options ↑
Responses
Status Description
200 Account

Retrieved navigation property

400 Error

Bad Request

401 Error

Unauthorized

403 Error

Forbidden

404 Error

Not Found

409 Error

Conflict

429 Error

Too Many Requests

500 Error

Internal Server Error


Schemas

The schema definitions for each object requested or returned from ChurnZero's REST API.


Account

Account available in ChurnZero.

{
  "Id": 8,
  "BillingAddressCity": "string",
  "BillingAddressCountry": "string",
  "BillingAddressLine1": "string",
  "BillingAddressLine2": "string",
  "BillingAddressState": "string",
  "BillingAddressZip": "string",
  "Cf": {
    "SupportOwnerId": 15,
    "ProductEdition": "string",
    "Emailcredits": 7.23,
    "AtRisk": true,
    "UpsellAmount": 5.0,
    "CustomerSentiment": "string",
    "SentimentLastUpdated": "2021-05-11",
    "ExecutiveSponsorHasLeft": true,
    "Industry": "string",
    "KpisMet": true,
    "Valuescore": 4.56,
    "Cstier": "string",
    "Elpmodel": "string",
    "EmailCreditsPurchased": 9.13,
    "GoLiveDate": "2021-05-11",
    "Lifecyclestage": "string",
    "OnboardingObjective": "string",
    "TrainingConfigurationNotes": "string",
    "EngagementScore": 9.11,
    "N30DayTimeSpent": 3.64,
    "TrainingConfigurationKpisMet": true,
    "SalesforceIntegration": true,
    "TwitterOauth": false,
    "CustomerFit110": 9.04,
    "CustomFitExplanation": "string",
    "Testpicklist": "string",
    "Outcomes": "string",
    "OverallColor": "string",
    "CustomerObjectives": "string",
    "CurrentSalesVolume": 0.99,
    "ToGoal": 4.94,
    "NumberOfProjects": 4.13,
    "ProjectEffort": "string",
    "ProjectImpact": "string",
    "BlogsPublishedLast7": 9.75,
    "WeeklyBlogsLimit": 9.86,
    "BlogsRemaining": 1.23,
    "NotesLastUpdated": "2021-05-11",
    "CompetitorsUsed": "string",
    "Employee": 5.02,
    "LicensesPurchased": 1.64,
    "AccountPenetration": 7.37,
    "ChurnReason": "string",
    "FeatureUse2": "string",
    "FeatureUse1": "string",
    "FeatureTurnedOn": "string",
    "Covid19IndustryRisk": "string",
    "Covid19CustomerNotes": "string",
    "Covid19Tier": "string",
    "SalesProductFit": "string",
    "SalesExpectations": "string",
    "SalesHandoverNotes": "string",
    "PartnerFit": "string",
    "PartnerCommunicationCadence": "string",
    "NumberOfSupportTicketsOverdue": "string",
    "NumberOfSupportEscalationslastMonth": "string",
    "WasTheCustomerAcquired": "string",
    "WasBudgetCut": "string",
    "DoWeHaveMultipleChampions": "string",
    "DidWeLoseAChampionThatHasNotBeenReplaced": "string",
    "Last90DaysNps": "string",
    "Last90DaysCsat": "string",
    "TotalPurchasedHoursForCurrentQuarter": "string",
    "TotalHoursUsed": "string",
    "FeatureRequests": "string",
    "Csm": "string",
    "SalesforceAccountOwner": "string",
    "SalesforceRegion": "string",
    "AdvId": "string",
    "AdSpendTotalLast30Days": 7.83,
    "ContractMinimum": 1.47,
    "BillingPeriodsInContractPerYear": "string",
    "ToContractMin": 8.81
  },
  "ContactsCount": 16,
  "CrmId": "string",
  "EndDate": "2021-05-11T16:38:27.7138801Z",
  "ExternalId": "string",
  "IsActive": true,
  "LicenseCount": 26,
  "Name": "string",
  "NextRenewalDate": "2021-05-11T16:38:27.7138801Z",
  "ObjectCreatedDate": "2021-05-11T16:38:27.7138801Z",
  "ObjectLastModifiedDate": "2021-05-11T16:38:27.7138801Z",
  "ParentAccountId": 29,
  "ParentNextRenewalDate": "2021-05-11T16:38:27.7138801Z",
  "ParentTotalContractAmount": 9.8,
  "PrimaryChurnScoreId": 9,
  "PrimaryChurnScoreValue": 8.95,
  "StartDate": "2021-05-11T16:38:27.7138801Z",
  "Tags": "string",
  "TenureInDays": 28,
  "TotalContractAmount": 1.22,
  "UsageFrequency": "string",
  "UserAccountId": 9,
  "PrimaryChurnScore@odata.navigationLink": "https://app.churnzero.net/public/v1/Account(8)/PrimaryChurnScore",
  "ParentAccount@odata.navigationLink": "https://app.churnzero.net/public/v1/Account(8)/ParentAccount",
  "UserAccount@odata.navigationLink": "https://app.churnzero.net/public/v1/Account(8)/UserAccount"
}

Properties

Name Description
Id integer(int64)

Internal identifier for ChurnZero.

BillingAddressCity string

The Account's billing address city.

BillingAddressCountry string

The Account's billing address country.

BillingAddressLine1 string

The Account's billing address line 1.

BillingAddressLine2 string

The Account's billing address line 2.

BillingAddressState string

The Account's billing address state.

BillingAddressZip string

The Account's billing address zip.

Cf objectReferences the AccountCf object.
ContactsCount integer(int32)

The number of Contacts associated with this Account.

CrmId string

The ID that this Account is linked to in an external source.

EndDate string(date-time)

The date/time this Account ended. ISO 8601 formatted string.

ExternalId string

The Account's External Id.

IsActive boolean

True if this Account is deemed active.

LicenseCount integer(int32)

The Account's license count.

Name string

The Account name.

NextRenewalDate string(date-time)

The date/time for this Account's next renewal. ISO 8601 formatted string.

ObjectCreatedDate string(date-time)

The date/time the Account record was created. ISO 8601 formatted string.

ObjectLastModifiedDate string(date-time)

The date/time the Account record was last modified. ISO 8601 formatted string.

ParentAccountId integer(int64)

The Id of the Parent Account.

ParentNextRenewalDate string(date-time)

The date/time for the Parent Account's next renewal. ISO 8601 formatted string.

ParentTotalContractAmount number

The Total Contract Amount of the Parent Account.

PrimaryChurnScoreId integer(int64)

The Id of the ChurnScore that is marked as primary for this Account.

PrimaryChurnScoreValue number

The value of the Primary ChurnScore.

StartDate string(date-time)

The date/time this Account started. ISO 8601 formatted string.

Tags array[string]References the object.
TenureInDays integer(int32)

The number of days since this Account's start date.

TotalContractAmount number

The Total Contract Amount of this Account.

UsageFrequency string
UserAccountId integer(int64)

The Account owner's Id.

PrimaryChurnScore objectReferences the ChurnScore object.
ParentAccount objectReferences the Account object.
UserAccount objectReferences the UserAccount object.


ChurnScore

Churn Score available in ChurnZero.

{
  "Id": 9,
  "GradingBottom": 6.1,
  "GradingTop": 1.36,
  "Name": "string"
}

Properties

Name Description
Id integer(int64)

Internal identifier for ChurnZero.

GradingBottom number

The lower-bounds value of the grading scale.

GradingTop number

The higher-bounds value of the grading scale.

Name string

The name of the Churn Score.


ChurnScoreCalculation

Churn Score Calculation available in ChurnZero.

{
  "Id": 3,
  "AccountId": 1,
  "CalculationDay": "2021-05-11",
  "ChurnScoreId": 28,
  "IsActive": false,
  "IsPrimary": false,
  "Score": 6.13,
  "Account@odata.navigationLink": "https://app.churnzero.net/public/v1/ChurnScoreCalculation(3)/Account",
  "ChurnScore@odata.navigationLink": "https://app.churnzero.net/public/v1/ChurnScoreCalculation(3)/ChurnScore"
}

Properties

Name Description
Id integer(int64)

Internal identifier for ChurnZero.

AccountId integer(int64)

The ID of the Account associated with this calculation.

CalculationDay string(date)

The day the calculation was perfromed.

ChurnScoreId integer(int64)

The ID of the Churn Score associated with this calculation.

IsActive boolean

True if the calculation is deemed active.

IsPrimary boolean

True if the calculation is primary.

Score number

The calculated Churn Score value.

Account objectReferences the Account object.
ChurnScore objectReferences the ChurnScore object.


ChurnScoreFactor

Churn Score Factor available in ChurnZero.

{
  "Id": 4,
  "ChurnScoreFactorType": "string",
  "ChurnScoreId": 1,
  "Name": "string",
  "ChurnScore@odata.navigationLink": "https://app.churnzero.net/public/v1/ChurnScoreFactor(4)/ChurnScore"
}

Properties

Name Description
Id integer(int64)

Internal identifier for ChurnZero.

ChurnScoreFactorType string

The type of Churn Score Factor.

EventCount, SegmentBonus, ActiveContacts, LicenseUtilization, Tenure, RenewalAmount, TimeInApp, ActiveDays, AccountAttribute, TaskLoggedActivities, TaskMostRecentActivity, CustomTable, NumberOfContactMessagesSent, MostRecentMessageSent, JourneyProgress, NumberOfContactMessagesReceived, MostRecentMessageReceived, NumberOfContactMessagesSentOrReceived, MostRecentMessageSentOrReceived, SurveyScore
↓ Show Values ↓↑ Hide Values ↑
ChurnScoreId integer(int64)

The Id of the Churn Score associated with this Churn Score Factor.

Name string

The name of the Churn Score Factor.

ChurnScore objectReferences the ChurnScore object.


ChurnScoreFactorCalculation

Churn Score Factor Calculation available in ChurnZero.

{
  "Id": 8,
  "AccountId": 26,
  "CalculationDay": "2021-05-11",
  "ChurnScoreFactorId": 4,
  "ChurnScoreId": 29,
  "Score": 8.78,
  "Account@odata.navigationLink": "https://app.churnzero.net/public/v1/ChurnScoreFactorCalculation(8)/Account",
  "ChurnScore@odata.navigationLink": "https://app.churnzero.net/public/v1/ChurnScoreFactorCalculation(8)/ChurnScore",
  "ChurnScoreFactor@odata.navigationLink": "https://app.churnzero.net/public/v1/ChurnScoreFactorCalculation(8)/ChurnScoreFactor"
}

Properties

Name Description
Id integer(int64)

Internal identifier for ChurnZero.

AccountId integer(int64)

The ID of the Account associated with this calculation.

CalculationDay string(date)

The day the calculation was perfromed.

ChurnScoreFactorId integer(int64)

The ID of the Churn Score Factor associated with this calculation.

ChurnScoreId integer(int64)

The ID of the Churn Score associated with this calculation.

Score number

The calculated Churn Score Factor value.

Account objectReferences the Account object.
ChurnScore objectReferences the ChurnScore object.
ChurnScoreFactor objectReferences the ChurnScoreFactor object.


Contact

Contact available in ChurnZero.

{
  "Id": 5,
  "AccountId": 20,
  "Cf": {
    "Role": "string",
    "AccountexternalId": 1.9,
    "Language": "string",
    "Admin": false,
    "Active": false,
    "LastLogin": "2021-05-11",
    "LicenseType": "string"
  },
  "CrmId": "string",
  "Email": "string",
  "ExternalId": "string",
  "FirstName": "string",
  "FullName": "string",
  "LastName": "string",
  "MarketingEmailUnsubscribed": false,
  "Name": "string",
  "ObjectCreatedDate": "2021-05-11T16:38:27.7261423Z",
  "ObjectLastModifiedDate": "2021-05-11T16:38:27.7261423Z",
  "Tags": "string",
  "Account@odata.navigationLink": "https://app.churnzero.net/public/v1/Contact(5)/Account"
}

Properties

Name Description
Id integer(int64)

Internal identifier for ChurnZero.

AccountId integer(int64)

The Id of the Account associated with this Contact.

Cf objectReferences the ContactCf object.
CrmId string

The Id that this Contact is linked to in an external source.

Email string

The Contact's email.

ExternalId string

The Contact's External Id.

FirstName string

The Contact's first name.

FullName string

The Contact's full name. Typically this is just a combination of FirstName and LastName.

LastName string

The Contact's last name.

MarketingEmailUnsubscribed boolean

True if the Contact has chosen to unsubscribe from marketing emails.

Name string

The Contact's combined First Name, Last Name, and Email if available.

ObjectCreatedDate string(date-time)

The date/time the Contact record was created. ISO 8601 formatted string.

ObjectLastModifiedDate string(date-time)

The date/time the Contact record was last modified. ISO 8601 formatted string.

Tags array[string]References the object.
Account objectReferences the Account object.


Error

{
  "error": {
    "code": "403",
    "message": "Forbidden"
  }
}

Properties

Name Description
code string

The status code.

message string

The error message.


Event

Event available in ChurnZero.

{
  "Id": 6,
  "AccountId": 26,
  "Cf": {
    "EventId": 3
  },
  "ContactId": 7,
  "Description": "string",
  "EventDate": "2021-05-11T16:38:27.7453951Z",
  "EventTypeId": 27,
  "Quantity": "string",
  "Contact@odata.navigationLink": "https://app.churnzero.net/public/v1/Event(6)/Contact",
  "Account@odata.navigationLink": "https://app.churnzero.net/public/v1/Event(6)/Account",
  "EventType@odata.navigationLink": "https://app.churnzero.net/public/v1/Event(6)/EventType"
}

Properties

Name Description
Id integer(int64)

Internal identifier for ChurnZero.

AccountId integer(int64)

The Id of the Account associated with this Event.

Cf objectReferences the EventCf object.
ContactId integer(int64)

The Id of the Contact associated with this Event.

Description string

The Event's description.

EventDate string(date-time)

The date/time the Event occurred. ISO 8601 formatted string.

EventTypeId integer(int64)

The Id of the type of Event.

Quantity number(decimal)

The number of times the Event occurred.

Contact objectReferences the Contact object.
Account objectReferences the Account object.
EventType objectReferences the EventType object.


EventType

Event Type available in ChurnZero.

{
  "Id": 4,
  "Name": "string"
}

Properties

Name Description
Id integer(int64)

Internal identifier for ChurnZero.

Name string

The name of the Event Type.


FollowUpQuestion

Follow up question that can be associated with a survey.

{
  "Question": "string",
  "AnswerType": "string"
}

Properties

Name Description
Question string

The text of the question.

AnswerType string

The type of answer associated with the question.


RelatedAccountChurnScore

The Churn Score related to an Account. Accessed dynamically through Segment Column Set selection.

{
  "Id": 123,
  "Name": "Churn Score Name",
  "Score": 66
}

Properties

Name Description
Id integer(int64)

Internal identifier for ChurnZero.

Name string

The name of the Churn Score.

Score number

The calculated Churn Score value.


RelatedAccountChurnScoreHistory

The Churn Score History related to an Account. Accessed dynamically through Segment Column Set selection.

{
  "ChurnScore": {
    "Id": 123,
    "Name": "Churn Score Name"
  },
  "CalculationDay": "2020-12-11",
  "IsPrimary": false,
  "Score": 66,
  "TimeFrame": "SevenDaysAgo"
}

Properties

Name Description
ChurnScore objectReferences the RelatedAccountChurnScore object.
CalculationDay string(date)

The day the calculation was perfromed.

IsPrimary boolean

True if the Churn Score is primary.

Score number(double)

The calculated Churn Score value.

TimeFrame string

The desired Time Frame of the calculation.


RelatedAccountJourney

The Journey related to an Account. Accessed dynamically through Segment Column Set selection.

{
  "Id": 123,
  "Name": "Journey Name",
  "IsCompleted": false,
  "IsFailed": false,
  "Status": "OnTrack",
  "BeginDate": "2020-10-27T19:10:50.783Z",
  "EndDate": "2020-10-27T19:10:50.783Z",
  "DaysIn": 68,
  "DaysOver": 0
}

Properties

Name Description
Id integer(int64)

The Id of the Journey associated with the Account.

Name string

The name of the journey.

IsCompleted boolean

True if the Account has completed the journey.

IsFailed boolean

True if the Account has failed the journey.

Status string

The Account's journey status.

BeginDate string(date-time)

The date the Account entered the journey.

EndDate string(date-time)

The date the Account ended the journey.

DaysIn integer(int32)

The number of days the Account has been in the journey.

DaysOver integer(int32)

The number of days the Account is past the completion date.


RelatedAccountRole

The Role related to an Account. Accessed dynamically through Segment Column Set selection.

{
  "Id": 123,
  "Name": "Account Role Name",
  "UserAccount": {
    "Id": 123,
    "Name": "User Name"
  }
}

Properties

Name Description
Id integer(int64)

Internal identifier for ChurnZero.

Name string

The name of the Account Role.

UserAccount objectReferences the RelatedAccountRoleUserAccount object.


RelatedAccountRoleUserAccount

The User associated to an Account Role. Accessed dynamically through Segment Column Set selection.

{
  "Id": 123,
  "Name": "User Name"
}

Properties

Name Description
Id integer(int64)

Internal identifier for ChurnZero.

Name string

The name of the User.


RelatedAccountSurveyScore

The Survey Scores related to an Account. Accessed dynamically through Segment Column Set selection.

{
  "NPS": 67,
  "CSAT": 79,
  "CES": 82
}

Properties

Name Description
NPS integer(int32)

The NPS survey score for the Account.

CSAT integer(int32)

The CSAT survey score for the Account.

CES integer(int32)

The CES survey score for the Account.


RelatedAggregates

The Aggregates related to an Account/Contact. Accessed dynamically through Segment Column Set selection.

{
  "AggregateDuration": "last7",
  "ActiveDays": 45,
  "ActiveContacts": 13,
  "LicenseUtilization": 13,
  "TimeSpent": [
    {
      "ApplicationModule": "Application Module Name",
      "Minutes": 14
    }
  ],
  "Events": [
    {
      "EventType": {
        "Id": 123,
        "Name": "Event Name"
      },
      "TotalEvents": 334,
      "DistinctContacts": 23,
      "MaxEventDate": "2020-10-27T19:10:50.783Z",
      "MinEventDate": "2020-10-27T19:10:50.783Z",
      "EventQuantitySum": 45,
      "EventMostRecentQuantity": 13
    }
  ]
}

Properties

Name Description
TimeSpent array[object]References the RelatedTimeSpent object.
Events array[object]References the RelatedEvent object.
AggrgegateDuration string

The Duration used for the aggregate.

ActiveDays integer(int32)

The calculated number of Active Days.

ActiveContacts integer(int32)

The calculated number of Active Contacts.

LicenseUtilization integer(int32)

The calculated License Utilization.


RelatedAttributes

The Attributes related to an Account/Contact. Accessed dynamically through Segment Column Set selection.

{
  "Roles": [
    {
      "Id": 123,
      "Name": "Account Role Name",
      "UserAccount": {
        "Id": 123,
        "Name": "User Name"
      }
    }
  ],
  "RoleManagers": [
    {
      "Id": 123,
      "Name": "Account Role Name",
      "UserAccount": {
        "Id": 123,
        "Name": "User Name"
      }
    }
  ],
  "ChurnScores": [
    {
      "Id": 123,
      "Name": "Churn Score Name",
      "Score": 66
    }
  ],
  "Journeys": [
    {
      "Id": 123,
      "Name": "Journey Name",
      "IsCompleted": false,
      "IsFailed": false,
      "Status": "OnTrack",
      "BeginDate": "2020-10-27T19:10:50.783Z",
      "EndDate": "2020-10-27T19:10:50.783Z",
      "DaysIn": 68,
      "DaysOver": 0
    }
  ],
  "ChurnScoreHistory": [
    {
      "ChurnScore": {
        "Id": 123,
        "Name": "Churn Score Name"
      },
      "CalculationDay": "2020-12-11",
      "IsPrimary": false,
      "Score": 66,
      "TimeFrame": "SevenDaysAgo"
    }
  ],
  "MostRecentSurveyResponses": {
    "NPS": {
      "Comment": "The comment",
      "Rating": 100,
      "ResponseDate": "2020-10-27T19:10:07.932Z"
    },
    "CSAT": {
      "Comment": "The comment",
      "Rating": 100,
      "ResponseDate": "2020-10-27T19:10:07.932Z"
    },
    "CES": {
      "Comment": "The comment",
      "Rating": 100,
      "ResponseDate": "2020-10-27T19:10:07.932Z"
    }
  }
}

Properties

Name Description
Roles array[object]References the RelatedAccountRole object.
RoleManagers array[object]References the RelatedAccountRole object.
ChurnScores array[object]References the RelatedAccountChurnScore object.
Journeys array[object]References the RelatedAccountJourney object.
ChurnScoreHistory array[object]References the RelatedAccountChurnScoreHistory object.
MostRecentSurveyResponses objectReferences the RelatedContactSurveyTypes object.


RelatedContactSurveyResponse

The Survey Response related to a Contact. Accessed dynamically through Segment Column Set selection.

{
  "Comment": "The comment",
  "Rating": 100,
  "ResponseDate": "2020-10-27T19:10:07.932Z"
}

Properties

Name Description
Comment string

The Contact's comment from the survey.

Rating integer(int32)

The Contact's rating from the survey.

ResponseDate string(date-time)

The date the Contact completed the survey.


RelatedContactSurveyTypes

Surveys related to a Contact. Accessed dynamically through Segment Column Set selection.

{
  "NPS": {
    "Comment": "The comment",
    "Rating": 100,
    "ResponseDate": "2020-10-27T19:10:07.932Z"
  },
  "CSAT": {
    "Comment": "The comment",
    "Rating": 100,
    "ResponseDate": "2020-10-27T19:10:07.932Z"
  },
  "CES": {
    "Comment": "The comment",
    "Rating": 100,
    "ResponseDate": "2020-10-27T19:10:07.932Z"
  }
}

Properties

Name Description
NPS objectReferences the RelatedContactSurveyResponse object.
CSAT objectReferences the RelatedContactSurveyResponse object.
CES objectReferences the RelatedContactSurveyResponse object.


RelatedEvent

The Event aggregates related to an Entity. Accessed dynamically through Segment Column Set selection.

{
  "EventType": {
    "Id": 123,
    "Name": "Event Name"
  },
  "TotalEvents": 334,
  "DistinctContacts": 23,
  "MaxEventDate": "2020-10-27T19:10:50.783Z",
  "MinEventDate": "2020-10-27T19:10:50.783Z",
  "EventQuantitySum": 45,
  "EventMostRecentQuantity": 13
}

Properties

Name Description
EventType objectReferences the RelatedEventType object.
TotalEvents integer(int32)

The number of Total Events for the Event Type.

DistinctContacts integer(int32)

The number of Distinct Contacts for the Event Type.

MaxEventDate string(date-time)

The Maximum Event Date for the Event Type.

MinEventDate string(date-time)

The Minimum Event Date for the Event Type.

EventQuantitySum integer(int32)

The sum of Events for the Event Type.

EventMostRecentQuantity integer(int32)

The number of Most Recent Events for the Event Type.


RelatedEventType

The Event Type associated to an Event aggregate. Accessed dynamically through Segment Column Set selection.

{
  "Id": 123,
  "Name": "Event Name"
}

Properties

Name Description
Id integer(int64)

Internal identifier for ChurnZero.

Name string

The name of the Event Type.


RelatedTimeSpent

{
  "ApplicationModule": "Application Module Name",
  "Minutes": 14
}

Properties

Name Description
ApplicationModule string
Minutes integer(int32)


Segment

Segment available in ChurnZero.

{
  "Id": 9,
  "Entity": "string",
  "IsGlobal": true,
  "Name": "string",
  "ObjectCreatedDate": "2021-05-11T16:38:27.7455152Z",
  "ObjectLastModifiedDate": "2021-05-11T16:38:27.7455152Z"
}

Properties

Name Description
Id integer(int64)

Internal identifier for ChurnZero.

Entity string

The Entity associated with this Segment.

Account, Contact, Event, Task, CustomListTicket, CustomListFinancialData, CustomListCourseCompletions, CustomListOpportunities, CustomListStrategicInitiatives, CustomListOrganization, CustomListMSTeamsUsage, CustomListElevTest, CustomListIncidentServiceRequest, CustomListClientInvoicingData
↓ Show Values ↓↑ Hide Values ↑
IsGlobal boolean

True if the Segment is globally accessible.

Name string

The name of the Segment.

ObjectCreatedDate string(date-time)

The date/time the Segment record was created. ISO 8601 formatted string.

ObjectLastModifiedDate string(date-time)

The date/time the Segment record was last modified. ISO 8601 formatted string.


SegmentColumnSet

SegmentColumnSet available in ChurnZero.

{
  "Id": 4,
  "Entity": "string",
  "Name": "string",
  "ObjectCreatedDate": "2021-05-11T16:38:27.7674631Z",
  "ObjectLastModifiedDate": "2021-05-11T16:38:27.7674631Z",
  "ShareType": "string",
  "UserAccountId": 25,
  "UserAccount@odata.navigationLink": "https://app.churnzero.net/public/v1/SegmentColumnSet(4)/UserAccount"
}

Properties

Name Description
Id integer(int64)

Internal identifier for ChurnZero.

Entity string

The entity associated with this SegmentColumnSet.

Account, Contact, Event, Task, CustomListTicket, CustomListFinancialData, CustomListCourseCompletions, CustomListOpportunities, CustomListStrategicInitiatives, CustomListOrganization, CustomListMSTeamsUsage, CustomListElevTest, CustomListIncidentServiceRequest, CustomListClientInvoicingData
↓ Show Values ↓↑ Hide Values ↑
Name string

The name of the SegmentSegmentColumnSet.

ObjectCreatedDate string(date-time)

The date/time the SegmentColumnSet record was created. ISO 8601 formatted string.

ObjectLastModifiedDate string(date-time)

The date/time the SegmentColumnSet record was last modified. ISO 8601 formatted string.

ShareType string

The accessibility of the SegmentColumnSet.

Private, Domain, All
↓ Show Values ↓↑ Hide Values ↑
UserAccountId integer(int64)

The SegmentColumnSet owner's Id.

UserAccount objectReferences the UserAccount object.


Survey

Survey definition available in ChurnZero.

{
  "Id": 4,
  "CampaignStatus": "string",
  "CampaignType": "string",
  "DripOverMonths": 20,
  "FollowUpQuestions": "string",
  "IsActive": true,
  "Name": "string",
  "RecurringEveryMonths": 20,
  "SegmentIds": "string",
  "Settings@odata.navigationLink": "https://app.churnzero.net/public/v1/Survey(4)/Settings",
  "SurveyQuestion": "string",
  "SurveyType": "string"
}

Properties

Name Description
Id integer(int64)

Internal identifier for ChurnZero.

CampaignStatus string

The status of the survey. (Draft, Paused, Running, Complete, Archived)

CampaignType string

The campaign type of the survey. (Standard, PointInTime, External)

DripOverMonths integer(int32)

The drip rate of the survey.

FollowUpQuestions array[object]References the FollowUpQuestion object.
IsActive boolean

If the survey is active.

Name string

The name of the survey.

RecurringEveryMonths integer(int32)

The number of months until the survey reoccurs.

SegmentIds array[integer]References the object.
Settings objectReferences the SurveySettings object.
SurveyQuestion string

The question of the survey.

SurveyType string

The type of the survey. (NPS, CSAT, CES)


SurveyResponse

Survey response collected in ChurnZero for a Survey.

{
  "Id": 6,
  "AccountId": 23,
  "Comment": "string",
  "ContactId": 10,
  "FollowUpAnswerType": "string",
  "FollowUpQuestion": "string",
  "FollowUpResponse": "string",
  "NextReminderDate": "2021-05-11T16:38:27.7927078Z",
  "ResponseDate": "2021-05-11T16:38:27.7927078Z",
  "ResponseSource": "string",
  "Score": 3,
  "SurveyId": 2,
  "Account@odata.navigationLink": "https://app.churnzero.net/public/v1/SurveyResponse(6)/Account",
  "Contact@odata.navigationLink": "https://app.churnzero.net/public/v1/SurveyResponse(6)/Contact",
  "Survey@odata.navigationLink": "https://app.churnzero.net/public/v1/SurveyResponse(6)/Survey"
}

Properties

Name Description
Id integer(int64)

Internal identifier for ChurnZero.

AccountId integer(int64)

The ID of the Account associated with this survey response.

Comment string

The comment that was given for the survey response.

ContactId integer(int64)

The ID of the Contact associated with this survey response.

FollowUpAnswerType string

The data type of the follow up answer. (Text, YesNo, Currency, Date, Number, Percent, SingleSelect, MultiSelect)

FollowUpQuestion string

The follow up question associated with this survey response.

FollowUpResponse string

The response to the follow up question.

NextReminderDate string(date-time)

The date the next reminder will occur. ISO 8601 formatted string.

ResponseDate string(date-time)

The date that the response was created. ISO 8601 formatted string.

ResponseSource string

The source of the survey response. (Announcement, Email)

Score integer(int32)

The score that was given for the survey response.

SurveyId integer(int64)

The ID of the Survey associated with this survey response.

Account objectReferences the Account object.
Contact objectReferences the Contact object.
Survey objectReferences the Survey object.


SurveySettings

Additional settings on a survey.

{
  "ChoiceCount": "integer",
  "AnswerType": "string"
}

Properties

Name Description
ChoiceCount integer(int32)

The number of choices available to answer a survey.

AnswerType string

The type of answer associated with the question.


Task

Task available in ChurnZero.

{
  "Id": 1,
  "AccountId": 27,
  "Cf": {
    "Type": "string",
    "AssignedById": 27,
    "MeetingNotesAndAgenda": "string",
    "MeetingSentiment": "string",
    "TimeSpenteffortinMinutes": 6.39,
    "Collaborator1Id": 2,
    "Collaborator2Id": 12,
    "OpportunityFound": "string",
    "ZoomRecording": "string"
  },
  "CloseDate": "2021-05-11T16:38:27.7924681Z",
  "Comments": "string",
  "ContactId": 3,
  "CrmId": "string",
  "DueDate": "2021-05-11T16:38:27.7924681Z",
  "IsClosed": true,
  "IsHighPriority": true,
  "ObjectCreatedDate": "2021-05-11T16:38:27.7924681Z",
  "ObjectLastModifiedDate": "2021-05-11T16:38:27.7924681Z",
  "Subject": "string",
  "TaskPriorityId": 6,
  "TaskStatusId": 1,
  "TaskType": "string",
  "UserAccountId": 23,
  "Account@odata.navigationLink": "https://app.churnzero.net/public/v1/Task(1)/Account",
  "Contact@odata.navigationLink": "https://app.churnzero.net/public/v1/Task(1)/Contact",
  "UserAccount@odata.navigationLink": "https://app.churnzero.net/public/v1/Task(1)/UserAccount",
  "TaskPriority@odata.navigationLink": "https://app.churnzero.net/public/v1/Task(1)/TaskPriority",
  "TaskStatus@odata.navigationLink": "https://app.churnzero.net/public/v1/Task(1)/TaskStatus"
}

Properties

Name Description
Id integer(int64)

Internal identifier for ChurnZero.

AccountId integer(int64)

The Id of the Account associated with this Task.

Cf objectReferences the TaskCf object.
CloseDate string(date-time)

The close date of the Task. ISO 8601 formatted string.

Comments string

Comments related to the task.

ContactId integer(int64)

The Id of the Contact associated with this Task.

CrmId string

The Id that this Task is linked to in an external source.

DueDate string(date-time)

The due date of the Task. ISO 8601 formatted string.

IsClosed boolean

True if the Task is closed.

IsHighPriority boolean

True if the Task is high priority.

ObjectCreatedDate string(date-time)

The date/time the Task record was created. ISO 8601 formatted string.

ObjectLastModifiedDate string(date-time)

The date/time the Task record was last modified. ISO 8601 formatted string.

Subject string

The subject of the Task.

TaskPriorityId integer(int64)

The Id of the Task's Priority.

TaskStatusId integer(int64)

The Id of the Task's Status.

TaskType string

The type of the Task.

UserAccountId integer(int64)

The Task owner's Id.

Account objectReferences the Account object.
Contact objectReferences the Contact object.
UserAccount objectReferences the UserAccount object.
TaskPriority objectReferences the TaskPriority object.
TaskStatus objectReferences the TaskStatus object.


TaskPriority

Task Priority available in ChurnZero.

{
  "Id": 1,
  "IsDefault": false,
  "IsHighPriority": true,
  "Name": "string"
}

Properties

Name Description
Id integer(int64)

Internal identifier for ChurnZero.

IsDefault boolean

True if the Task Priority is the default.

IsHighPriority boolean

True if the Task Priority is high priority.

Name string

The Task Priority's name.


TaskStatus

Task Status available in ChurnZero.

{
  "Id": 5,
  "IsClosed": true,
  "IsDefault": true,
  "Name": "string"
}

Properties

Name Description
Id integer(int64)

Internal identifier for ChurnZero.

IsClosed boolean

True if the Task Status is closed.

IsDefault boolean

True if the Task Status is the default.

Name string

The Task Status' name.


UserAccount

User Account available in ChurnZero.

{
  "Id": 8,
  "AvatarUrl": "string",
  "CanLogIn": false,
  "Cf": {
    "CalendarLink": "string"
  },
  "CrmId": "string",
  "Email": "string",
  "FirstName": "string",
  "HasAccounts": false,
  "IsActive": true,
  "LastName": "string",
  "MobilePhone": "string",
  "Name": "string",
  "ObjectCreatedDate": "2021-05-11T16:38:27.7373125Z",
  "ObjectLastModifiedDate": "2021-05-11T16:38:27.7373125Z",
  "OfficePhone": "string",
  "Title": "string",
  "UserName": "string"
}

Properties

Name Description
Id integer(int64)

Internal identifier for ChurnZero.

AvatarUrl string

The URL to this User's avatar.

CanLogIn boolean

True if the User Account can log into ChurnZero.

Cf objectReferences the UserAccountCf object.
CrmId string

The Id that this User Account is linked to in an external source.

Email string

The User's email.

FirstName string

The User's first name.

HasAccounts boolean

True if the User Account owns Accounts in ChurnZero.

IsActive boolean

True if the User Account is active in ChurnZero.

LastName string

The User's last name.

MobilePhone string

The User's mobile phone number.

Name string

The User's full name.

ObjectCreatedDate string(date-time)

The date/time the UserAccount record was created. ISO 8601 formatted string.

ObjectLastModifiedDate string(date-time)

The date/time the UserAccount record was last modified. ISO 8601 formatted string.

OfficePhone string

The User's office phone number.

Title string

The User's title.

UserName string

The UserName used to log into ChurnZero.


AccountCf

Account available in ChurnZero.

{
  "SupportOwnerId": 15,
  "ProductEdition": "string",
  "Emailcredits": 7.23,
  "AtRisk": true,
  "UpsellAmount": 5.0,
  "CustomerSentiment": "string",
  "SentimentLastUpdated": "2021-05-11",
  "ExecutiveSponsorHasLeft": true,
  "Industry": "string",
  "KpisMet": true,
  "Valuescore": 4.56,
  "Cstier": "string",
  "Elpmodel": "string",
  "EmailCreditsPurchased": 9.13,
  "GoLiveDate": "2021-05-11",
  "Lifecyclestage": "string",
  "OnboardingObjective": "string",
  "TrainingConfigurationNotes": "string",
  "EngagementScore": 9.11,
  "N30DayTimeSpent": 3.64,
  "TrainingConfigurationKpisMet": true,
  "SalesforceIntegration": true,
  "TwitterOauth": false,
  "CustomerFit110": 9.04,
  "CustomFitExplanation": "string",
  "Testpicklist": "string",
  "Outcomes": "string",
  "OverallColor": "string",
  "CustomerObjectives": "string",
  "CurrentSalesVolume": 0.99,
  "ToGoal": 4.94,
  "NumberOfProjects": 4.13,
  "ProjectEffort": "string",
  "ProjectImpact": "string",
  "BlogsPublishedLast7": 9.75,
  "WeeklyBlogsLimit": 9.86,
  "BlogsRemaining": 1.23,
  "NotesLastUpdated": "2021-05-11",
  "CompetitorsUsed": "string",
  "Employee": 5.02,
  "LicensesPurchased": 1.64,
  "AccountPenetration": 7.37,
  "ChurnReason": "string",
  "FeatureUse2": "string",
  "FeatureUse1": "string",
  "FeatureTurnedOn": "string",
  "Covid19IndustryRisk": "string",
  "Covid19CustomerNotes": "string",
  "Covid19Tier": "string",
  "SalesProductFit": "string",
  "SalesExpectations": "string",
  "SalesHandoverNotes": "string",
  "PartnerFit": "string",
  "PartnerCommunicationCadence": "string",
  "NumberOfSupportTicketsOverdue": "string",
  "NumberOfSupportEscalationslastMonth": "string",
  "WasTheCustomerAcquired": "string",
  "WasBudgetCut": "string",
  "DoWeHaveMultipleChampions": "string",
  "DidWeLoseAChampionThatHasNotBeenReplaced": "string",
  "Last90DaysNps": "string",
  "Last90DaysCsat": "string",
  "TotalPurchasedHoursForCurrentQuarter": "string",
  "TotalHoursUsed": "string",
  "FeatureRequests": "string",
  "Csm": "string",
  "SalesforceAccountOwner": "string",
  "SalesforceRegion": "string",
  "AdvId": "string",
  "AdSpendTotalLast30Days": 7.83,
  "ContractMinimum": 1.47,
  "BillingPeriodsInContractPerYear": "string",
  "ToContractMin": 8.81
}

Properties

Name Description
SupportOwnerId integer(int64)
ProductEdition string(picklist)
Gold, Silver, Bronze
↓ Show Values ↓↑ Hide Values ↑
Emailcredits number
AtRisk boolean
UpsellAmount number
CustomerSentiment string(picklist)
Red, Yellow, Green
↓ Show Values ↓↑ Hide Values ↑
SentimentLastUpdated string(date)
ExecutiveSponsorHasLeft boolean
Industry string(picklist)
Business Services/Technology, Computer Software/Gaming, Education Tech, Manufacturing, non-profit/charity, Retail, Travel/Tourism/Hospitality
↓ Show Values ↓↑ Hide Values ↑
KpisMet boolean
Valuescore number
Cstier string
Elpmodel string
EmailCreditsPurchased number
GoLiveDate string(date)
Lifecyclestage array[string]References the object.
OnboardingObjective string
TrainingConfigurationNotes string
EngagementScore number
N30DayTimeSpent number
TrainingConfigurationKpisMet boolean
SalesforceIntegration boolean
TwitterOauth boolean
CustomerFit110 number
CustomFitExplanation string
Testpicklist string(picklist)
Increase Web Traffic, Drive New Sales, Get New Additions to Marketing Database, Increase Awareness, Drive Social Media
↓ Show Values ↓↑ Hide Values ↑
Outcomes string
OverallColor string
CustomerObjectives array[string]References the object.
CurrentSalesVolume number
ToGoal number
NumberOfProjects number
ProjectEffort array[string]References the object.
ProjectImpact array[string]References the object.
BlogsPublishedLast7 number
WeeklyBlogsLimit number
BlogsRemaining number
NotesLastUpdated string(date)
CompetitorsUsed array[string]References the object.
Employee number
LicensesPurchased number
AccountPenetration number
ChurnReason array[string]References the object.
FeatureUse2 array[string]References the object.
FeatureUse1 array[string]References the object.
FeatureTurnedOn array[string]References the object.
Covid19IndustryRisk string(picklist)
High Risk, Average Risk, Low Risk, Potentially Positive
↓ Show Values ↓↑ Hide Values ↑
Covid19CustomerNotes string
Covid19Tier string(picklist)
Business as Usual, Business as Mostly Usual, Extreme Risk, Needs Involvement, Immediate Engagement
↓ Show Values ↓↑ Hide Values ↑
SalesProductFit string
SalesExpectations string
SalesHandoverNotes string
PartnerFit string
PartnerCommunicationCadence string
NumberOfSupportTicketsOverdue string
NumberOfSupportEscalationslastMonth string
WasTheCustomerAcquired string
WasBudgetCut string
DoWeHaveMultipleChampions string
DidWeLoseAChampionThatHasNotBeenReplaced string
Last90DaysNps string
Last90DaysCsat string
TotalPurchasedHoursForCurrentQuarter string
TotalHoursUsed string
FeatureRequests string
Csm string
SalesforceAccountOwner string
SalesforceRegion string
AdvId string
AdSpendTotalLast30Days number
ContractMinimum number
BillingPeriodsInContractPerYear string(picklist)
1, 2, 4, 12
↓ Show Values ↓↑ Hide Values ↑
ToContractMin number


ContactCf

Contact available in ChurnZero.

{
  "Role": "string",
  "AccountexternalId": 1.9,
  "Language": "string",
  "Admin": false,
  "Active": false,
  "LastLogin": "2021-05-11",
  "LicenseType": "string"
}

Properties

Name Description
Role string
AccountexternalId number
Language string
Admin boolean
Active boolean
LastLogin string(date)
LicenseType string(picklist)
Starter, Standard
↓ Show Values ↓↑ Hide Values ↑


EventCf

Event available in ChurnZero.

{
  "EventId": 3
}

Properties

Name Description
EventId integer(int64)


TaskCf

Task available in ChurnZero.

{
  "Type": "string",
  "AssignedById": 27,
  "MeetingNotesAndAgenda": "string",
  "MeetingSentiment": "string",
  "TimeSpenteffortinMinutes": 6.39,
  "Collaborator1Id": 2,
  "Collaborator2Id": 12,
  "OpportunityFound": "string",
  "ZoomRecording": "string"
}

Properties

Name Description
Type string(picklist)
Support Ticket, Renewal Conversation - 60 minutes, Demo - 45 minutes, QBR - 90 minutes, In Person Meeting - 90 minutes, Training - 60 minutes, Call - touch base - 30 minutes
↓ Show Values ↓↑ Hide Values ↑
AssignedById integer(int64)
MeetingNotesAndAgenda string
MeetingSentiment string(picklist)
Great!, Good, Neutral, Difficult, Terrible
↓ Show Values ↓↑ Hide Values ↑
TimeSpenteffortinMinutes number
Collaborator1Id integer(int64)
Collaborator2Id integer(int64)
OpportunityFound string(picklist)
Expansion, Upsell, Upsell + Expansion, Other
↓ Show Values ↓↑ Hide Values ↑
ZoomRecording string


UserAccountCf

User Account available in ChurnZero.

{
  "CalendarLink": "string"
}

Properties

Name Description
CalendarLink string


CustomListClientInvoicingData

{
  "Id": 9,
  "AccountId": 4,
  "Advancearrear": "string",
  "AmountUsdEquivalentOnTheDateOfInvoice": 9.66,
  "Currency": "string",
  "Frequency": "string",
  "InvoiceDate": "2021-05-11",
  "InvoiceNumber": "string",
  "InvoicePeriodEndDate": "2021-05-11",
  "InvoicePeriodStartDate": "2021-05-11",
  "InvoiceServiceType": "string",
  "NextInvoiceDate": "2021-05-11",
  "NextInvoiceMonth": "string",
  "NextPeriodEndDate": "2021-05-11",
  "NextPeriodStartDate": "2021-05-11",
  "ObjectCreatedDate": "2021-05-11T16:38:31.6778471Z",
  "ObjectLastModifiedDate": "2021-05-11T16:38:31.6778471Z",
  "PaymentDueDate": "2021-05-11",
  "PaymentDueDateAsPerMsa": 4.85,
  "PaymentReceivedDate": "2021-05-11",
  "SowName": "string",
  "Account@odata.navigationLink": "https://app.churnzero.net/public/v1/CustomListClientInvoicingData(9)/Account"
}

Properties

Name Description
Id integer(int64)

Internal identifier for ChurnZero.

AccountId integer(int64)
Advancearrear string
AmountUsdEquivalentOnTheDateOfInvoice number
Currency string
Frequency string
InvoiceDate string(date)
InvoiceNumber string
InvoicePeriodEndDate string(date)
InvoicePeriodStartDate string(date)
InvoiceServiceType string
NextInvoiceDate string(date)
NextInvoiceMonth string
NextPeriodEndDate string(date)
NextPeriodStartDate string(date)
ObjectCreatedDate string(date-time)

The date/time the CustomListClientInvoicingData record was created. ISO 8601 formatted string.

ObjectLastModifiedDate string(date-time)

The date/time the CustomListClientInvoicingData record was last modified. ISO 8601 formatted string.

PaymentDueDate string(date)
PaymentDueDateAsPerMsa number
PaymentReceivedDate string(date)
SowName string
Account objectReferences the Account object.


CustomListCourseCompletions

Understanding the courses completed by each customer

{
  "Id": 2,
  "AccountId": 1,
  "Completed": true,
  "CourseEndDate": "string",
  "CourseNumber": "string",
  "CourseStartDate": "2021-05-11",
  "CourseTitle": "string",
  "ObjectCreatedDate": "2021-05-11T16:38:28.2589236Z",
  "ObjectLastModifiedDate": "2021-05-11T16:38:28.2589236Z",
  "Account@odata.navigationLink": "https://app.churnzero.net/public/v1/CustomListCourseCompletions(2)/Account"
}

Properties

Name Description
Id integer(int64)

Internal identifier for ChurnZero.

AccountId integer(int64)
Completed boolean
CourseEndDate string
CourseNumber string
CourseStartDate string(date)
CourseTitle string
ObjectCreatedDate string(date-time)

The date/time the CustomListCourseCompletions record was created. ISO 8601 formatted string.

ObjectLastModifiedDate string(date-time)

The date/time the CustomListCourseCompletions record was last modified. ISO 8601 formatted string.

Account objectReferences the Account object.


CustomListElevTest

{
  "Id": 5,
  "Accountname": "string",
  "Cstier": "string",
  "CzAccountNameId": 28,
  "Engagementscore": 0.22,
  "Lifecyclestage": "string",
  "Obfuscatedarr": 9.86,
  "ObjectCreatedDate": "2021-05-11T16:38:31.0416404Z",
  "ObjectLastModifiedDate": "2021-05-11T16:38:31.0416404Z",
  "Overallcolor": "string",
  "Overallscore": 6.48,
  "Renewal": "2021-05-11",
  "Renewalscore": "string",
  "State": "string",
  "Successlead": "string",
  "ValueScore": 0.37,
  "CzAccountName@odata.navigationLink": "https://app.churnzero.net/public/v1/CustomListElevTest(5)/CzAccountName"
}

Properties

Name Description
Id integer(int64)

Internal identifier for ChurnZero.

Accountname string
Cstier string
CzAccountNameId integer(int64)
Engagementscore number
Lifecyclestage string
Obfuscatedarr number
ObjectCreatedDate string(date-time)

The date/time the CustomListElevTest record was created. ISO 8601 formatted string.

ObjectLastModifiedDate string(date-time)

The date/time the CustomListElevTest record was last modified. ISO 8601 formatted string.

Overallcolor string
Overallscore number
Renewal string(date)
Renewalscore string
State string
Successlead string
ValueScore number
CzAccountName objectReferences the Account object.


CustomListFinancialData

This is all the financial data

{
  "Id": 8,
  "AccountId": 8,
  "DaysOverdue": 9.87,
  "DueDate": "2021-05-11",
  "InvoiceNumber": "string",
  "InvoicePaId": false,
  "ObjectCreatedDate": "2021-05-11T16:38:28.1310656Z",
  "ObjectLastModifiedDate": "2021-05-11T16:38:28.1310656Z",
  "State": "string",
  "Account@odata.navigationLink": "https://app.churnzero.net/public/v1/CustomListFinancialData(8)/Account"
}

Properties

Name Description
Id integer(int64)

Internal identifier for ChurnZero.

AccountId integer(int64)
DaysOverdue number
DueDate string(date)
InvoiceNumber string
InvoicePaId boolean
ObjectCreatedDate string(date-time)

The date/time the CustomListFinancialData record was created. ISO 8601 formatted string.

ObjectLastModifiedDate string(date-time)

The date/time the CustomListFinancialData record was last modified. ISO 8601 formatted string.

State string
Account objectReferences the Account object.


CustomListIncidentServiceRequest

{
  "Id": 6,
  "AccountId": 2,
  "Approvers2Id": 12,
  "AssigneeId": 23,
  "Build": "string",
  "CabReviewer": "string",
  "CabReviewer2": "string",
  "Category": "string",
  "CodeFixRequired": false,
  "Created": "2021-05-11T16:38:31.3494739Z",
  "CustomFieldApproversId": 25,
  "Description": "string",
  "IssueKey": "string",
  "IssueType": "string",
  "ObjectCreatedDate": "2021-05-11T16:38:31.3494739Z",
  "ObjectLastModifiedDate": "2021-05-11T16:38:31.3494739Z",
  "Priority": "string",
  "Reporter": "string",
  "RequesterType": "string",
  "Resolved": "2021-05-11T16:38:31.3494739Z",
  "Status": "string",
  "Summary": "string",
  "Updated": "2021-05-11T16:38:31.3494739Z",
  "Assignee@odata.navigationLink": "https://app.churnzero.net/public/v1/CustomListIncidentServiceRequest(6)/Assignee",
  "CustomFieldApprovers@odata.navigationLink": "https://app.churnzero.net/public/v1/CustomListIncidentServiceRequest(6)/CustomFieldApprovers",
  "Approvers2@odata.navigationLink": "https://app.churnzero.net/public/v1/CustomListIncidentServiceRequest(6)/Approvers2",
  "Account@odata.navigationLink": "https://app.churnzero.net/public/v1/CustomListIncidentServiceRequest(6)/Account"
}

Properties

Name Description
Id integer(int64)

Internal identifier for ChurnZero.

AccountId integer(int64)
Approvers2Id integer(int64)
AssigneeId integer(int64)
Build string
CabReviewer string
CabReviewer2 string
Category string
CodeFixRequired boolean
Created string(date-time)

ISO 8601 formatted string.

CustomFieldApproversId integer(int64)
Description string
IssueKey string
IssueType string
ObjectCreatedDate string(date-time)

The date/time the CustomListIncidentServiceRequest record was created. ISO 8601 formatted string.

ObjectLastModifiedDate string(date-time)

The date/time the CustomListIncidentServiceRequest record was last modified. ISO 8601 formatted string.

Priority string
Reporter string
RequesterType string
Resolved string(date-time)

ISO 8601 formatted string.

Status string
Summary string
Updated string(date-time)

ISO 8601 formatted string.

Assignee objectReferences the UserAccount object.
CustomFieldApprovers objectReferences the UserAccount object.
Approvers2 objectReferences the UserAccount object.
Account objectReferences the Account object.


CustomListMSTeamsUsage

{
  "Id": 3,
  "AccountId": 2,
  "ActiveChannels": 0.48,
  "ActiveUsers": 7.82,
  "ChannelMessages": 8.88,
  "DisplayName": "string",
  "Guests": 4.29,
  "Identifier": "string",
  "LastActivity": "2021-05-11T16:38:30.3849682Z",
  "MeetingsOrganized": 0.42,
  "Mentions": 1.45,
  "ObjectCreatedDate": "2021-05-11T16:38:30.3849682Z",
  "ObjectLastModifiedDate": "2021-05-11T16:38:30.3849682Z",
  "PostMessages": 0.1,
  "Privacy": "string",
  "Reactions": 7.15,
  "ReplyMessages": 9.04,
  "UrgentMessages": 3.56,
  "UserId": "string",
  "Account@odata.navigationLink": "https://app.churnzero.net/public/v1/CustomListMSTeamsUsage(3)/Account"
}

Properties

Name Description
Id integer(int64)

Internal identifier for ChurnZero.

AccountId integer(int64)
ActiveChannels number
ActiveUsers number
ChannelMessages number
DisplayName string
Guests number
Identifier string
LastActivity string(date-time)

ISO 8601 formatted string.

MeetingsOrganized number
Mentions number
ObjectCreatedDate string(date-time)

The date/time the CustomListMSTeamsUsage record was created. ISO 8601 formatted string.

ObjectLastModifiedDate string(date-time)

The date/time the CustomListMSTeamsUsage record was last modified. ISO 8601 formatted string.

PostMessages number
Privacy string
Reactions number
ReplyMessages number
UrgentMessages number
UserId string
Account objectReferences the Account object.


CustomListOpportunities

{
  "Id": 9,
  "AccountDirectorId": 8,
  "AccountId": 2,
  "AnnualManagedServicesFee": 9.26,
  "AnnualSubscriptionFee": 8.47,
  "ChannelType": "string",
  "CloseDate": "2021-05-11",
  "ClosedLostNotes": "string",
  "ClosedLostReason": "string",
  "Competitors": "string",
  "CreatedById": 4,
  "CreatedDate": "2021-05-11",
  "DaysAtCurrentStage": 3.5,
  "Description": "string",
  "ExecutiveCoachId": 25,
  "FinancialReportingRegion": "string",
  "FutureScope": "string",
  "ImplementationStartDate": "2021-05-11",
  "IndustryVertical": "string",
  "Modules": "string",
  "NextStep": "string",
  "NumberOfContracts": 7.84,
  "NumberOfSuppliersclients": 0.06,
  "ObjectCreatedDate": "2021-05-11T16:38:28.4246913Z",
  "ObjectLastModifiedDate": "2021-05-11T16:38:28.4246913Z",
  "OnetimeImplementationFee": 4.53,
  "OpportunityCountry": "string",
  "OpportunityName": "string",
  "OpportunityOwnerId": 2,
  "OpportunityState": "string",
  "PocEndDate": "2021-05-11",
  "PocOutcome": "string",
  "PocScope": "string",
  "PocStartDate": "2021-05-11",
  "PocValue": 2.74,
  "Probability": 0.96,
  "ProductType": "string",
  "SalesTerritory": "string",
  "SirionForecast": "string",
  "SloppId": "string",
  "Stage": "string",
  "StartDateOfCurrentStage": "2021-05-11",
  "TotalArrwithProbability": 8.91,
  "TotalArrwoProbability": 1.26,
  "Account@odata.navigationLink": "https://app.churnzero.net/public/v1/CustomListOpportunities(9)/Account",
  "OpportunityOwner@odata.navigationLink": "https://app.churnzero.net/public/v1/CustomListOpportunities(9)/OpportunityOwner",
  "ExecutiveCoach@odata.navigationLink": "https://app.churnzero.net/public/v1/CustomListOpportunities(9)/ExecutiveCoach",
  "AccountDirector@odata.navigationLink": "https://app.churnzero.net/public/v1/CustomListOpportunities(9)/AccountDirector",
  "CreatedBy@odata.navigationLink": "https://app.churnzero.net/public/v1/CustomListOpportunities(9)/CreatedBy"
}

Properties

Name Description
Id integer(int64)

Internal identifier for ChurnZero.

AccountDirectorId integer(int64)
AccountId integer(int64)
AnnualManagedServicesFee number
AnnualSubscriptionFee number
ChannelType string
CloseDate string(date)
ClosedLostNotes string
ClosedLostReason string
Competitors string
CreatedById integer(int64)
CreatedDate string(date)
DaysAtCurrentStage number
Description string
ExecutiveCoachId integer(int64)
FinancialReportingRegion string
FutureScope string
ImplementationStartDate string(date)
IndustryVertical string
Modules string
NextStep string
NumberOfContracts number
NumberOfSuppliersclients number
ObjectCreatedDate string(date-time)

The date/time the CustomListOpportunities record was created. ISO 8601 formatted string.

ObjectLastModifiedDate string(date-time)

The date/time the CustomListOpportunities record was last modified. ISO 8601 formatted string.

OnetimeImplementationFee number
OpportunityCountry string
OpportunityName string
OpportunityOwnerId integer(int64)
OpportunityState string
PocEndDate string(date)
PocOutcome string
PocScope string
PocStartDate string(date)
PocValue number
Probability number
ProductType string
SalesTerritory string
SirionForecast string
SloppId string
Stage string(picklist)
1 - Initial Demo/Evaluation/RFI, 2 - Example, 3 - Example, 4 - POC, 5 - Example, 6 - Closed Won, 7 - At Risk, 8 - Closed Lost
↓ Show Values ↓↑ Hide Values ↑
StartDateOfCurrentStage string(date)
TotalArrwithProbability number
TotalArrwoProbability number
Account objectReferences the Account object.
OpportunityOwner objectReferences the UserAccount object.
ExecutiveCoach objectReferences the UserAccount object.
AccountDirector objectReferences the UserAccount object.
CreatedBy objectReferences the UserAccount object.


CustomListOrganization

Link to Zendesk Organization Connected to Zendesk Support entity Organization.

{
  "Id": 7,
  "AccountId": 14,
  "ObjectCreatedDate": "2021-05-11T16:38:30.1247808Z",
  "ObjectLastModifiedDate": "2021-05-11T16:38:30.1247808Z",
  "Account@odata.navigationLink": "https://app.churnzero.net/public/v1/CustomListOrganization(7)/Account"
}

Properties

Name Description
Id integer(int64)

Internal identifier for ChurnZero.

AccountId integer(int64)

Connected to Zendesk Support field cz_account_id.

ObjectCreatedDate string(date-time)

The date/time the CustomListOrganization record was created. ISO 8601 formatted string.

ObjectLastModifiedDate string(date-time)

The date/time the CustomListOrganization record was last modified. ISO 8601 formatted string.

Account objectReferences the Account object.


CustomListStrategicInitiatives

{
  "Id": 1,
  "Accomplished": "string",
  "AccountId": 15,
  "ApplicableModules": "string",
  "Budget": 5.63,
  "BusinessImpact": "string",
  "BusinessObjective": "string",
  "CallOutline": "string",
  "CurrentInitiative": false,
  "CustomerAsks": "string",
  "DocExample2": "string",
  "DocExample3": "string",
  "EbrDate": "2021-05-11",
  "IllumioAsks": "string",
  "KeyStakeholderId": 24,
  "NextStepsoutcomes": "string",
  "ObjectCreatedDate": "2021-05-11T16:38:29.5059158Z",
  "ObjectLastModifiedDate": "2021-05-11T16:38:29.5059158Z",
  "OwnerId": 8,
  "Reason": "string",
  "Scope": "string",
  "SuccessCriteria": "string",
  "Timeline": "2021-05-11",
  "Account@odata.navigationLink": "https://app.churnzero.net/public/v1/CustomListStrategicInitiatives(1)/Account",
  "Owner@odata.navigationLink": "https://app.churnzero.net/public/v1/CustomListStrategicInitiatives(1)/Owner",
  "KeyStakeholder@odata.navigationLink": "https://app.churnzero.net/public/v1/CustomListStrategicInitiatives(1)/KeyStakeholder"
}

Properties

Name Description
Id integer(int64)

Internal identifier for ChurnZero.

Accomplished string
AccountId integer(int64)
ApplicableModules array[string]References the object.
Budget number
BusinessImpact string
BusinessObjective string
CallOutline string
CurrentInitiative boolean
CustomerAsks string
DocExample2 string
DocExample3 string
EbrDate string(date)
IllumioAsks string
KeyStakeholderId integer(int64)
NextStepsoutcomes string
ObjectCreatedDate string(date-time)

The date/time the CustomListStrategicInitiatives record was created. ISO 8601 formatted string.

ObjectLastModifiedDate string(date-time)

The date/time the CustomListStrategicInitiatives record was last modified. ISO 8601 formatted string.

OwnerId integer(int64)
Reason string
Scope string
SuccessCriteria string
Timeline string(date)
Account objectReferences the Account object.
Owner objectReferences the Account object.
KeyStakeholder objectReferences the Contact object.


CustomListTicket

Link to Zendesk Ticket Connected to Zendesk Support entity Ticket.

{
  "Id": 4,
  "AccountId": 2,
  "Assignee": "string",
  "Commentcount": 8.65,
  "ContactId": 24,
  "Createdat": "2021-05-11T16:38:27.8311758Z",
  "CzAlertMarker": true,
  "Description": "string",
  "Dueat": "2021-05-11T16:38:27.8311758Z",
  "ObjectCreatedDate": "2021-05-11T16:38:27.8311758Z",
  "ObjectLastModifiedDate": "2021-05-11T16:38:27.8311758Z",
  "Priority": "string",
  "Recipient": "string",
  "Requester": "string",
  "Status": "string",
  "Subject": "string",
  "Submitter": "string",
  "Type": "string",
  "Updatedat": "2021-05-11T16:38:27.8311758Z",
  "UseraccountId": 28,
  "Account@odata.navigationLink": "https://app.churnzero.net/public/v1/CustomListTicket(4)/Account",
  "Contact@odata.navigationLink": "https://app.churnzero.net/public/v1/CustomListTicket(4)/Contact",
  "Useraccount@odata.navigationLink": "https://app.churnzero.net/public/v1/CustomListTicket(4)/Useraccount"
}

Properties

Name Description
Id integer(int64)

Internal identifier for ChurnZero.

AccountId integer(int64)

Connected to Zendesk Support field cz_account_id.

Assignee string

Connected to Zendesk Support field cz_assignee.

Commentcount number

Connected to Zendesk Support field comment_count.

ContactId integer(int64)

Connected to Zendesk Support field cz_contact_id.

Createdat string(date-time)

Connected to Zendesk Support field created_at. ISO 8601 formatted string.

CzAlertMarker boolean
Description string

Connected to Zendesk Support field description.

Dueat string(date-time)

Connected to Zendesk Support field due_at. ISO 8601 formatted string.

ObjectCreatedDate string(date-time)

The date/time the CustomListTicket record was created. ISO 8601 formatted string.

ObjectLastModifiedDate string(date-time)

The date/time the CustomListTicket record was last modified. ISO 8601 formatted string.

Priority string(picklist)

Connected to Zendesk Support field priority.

urgent, high, normal, low
↓ Show Values ↓↑ Hide Values ↑
Recipient string

Connected to Zendesk Support field recipient.

Requester string

Connected to Zendesk Support field cz_requester.

Status string(picklist)

Connected to Zendesk Support field status.

new, open, pending, hold, solved, closed
↓ Show Values ↓↑ Hide Values ↑
Subject string

Connected to Zendesk Support field subject.

Submitter string

Connected to Zendesk Support field cz_submitter.

Type string(picklist)

Connected to Zendesk Support field type.

problem, incident, question, task
↓ Show Values ↓↑ Hide Values ↑
Updatedat string(date-time)

Connected to Zendesk Support field updated_at. ISO 8601 formatted string.

UseraccountId integer(int64)

Connected to Zendesk Support field cz_user_account_id.

Account objectReferences the Account object.
Contact objectReferences the Contact object.
Useraccount objectReferences the UserAccount object.