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
Bulk Read - Journeys

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

For example, given a username of someuser and an API Key of sup3rS3cr37!ApiK3y the following would be a cURL command manually encoding the header.

curl -X GET "https://marketingpony.us1app.churnzero.net/public/v1/Account" \
-H "Authorization: Basic c29tZXVzZXI6c3VwM3JTM2NyMzchQXBpSzN5"

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
400	Bad Request	This usually occurs because of a missing or malformed parameter. Check the documentation and the syntax of your request and try again.
401	Unauthorized	A valid authentication token was not provided with the request, so the API could not associate a user with the request.
403	Forbidden	The 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.
404	Not Found	Either 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.
409	Conflict	The underlying model/schema has changed. Usually caused by a race condition. Sending the request again will succeed.
429	Too Many Requests	You have exceeded one of the enforced rate limits in the API. See the documentation on rate limiting for more information.
500	Internal Server Error	There 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://marketingpony.us1app.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://marketingpony.us1app.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://marketingpony.us1app.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://marketingpony.us1app.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://marketingpony.us1app.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://marketingpony.us1app.churnzero.net/public/v1/SegmentColumnSet(16)/UserAccount"
        }
    ],
    "@odata.nextLink": "https://marketingpony.us1app.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://marketingpony.us1app.churnzero.net//public/v1/$metadata#Account(Id,Name)",
    "value": [
        {
            "Id": 25024,
            "Name": "Auer LLC"
        },
        {
            "Id": 23908,
            "Name": "Auer, DuBuque and Wunsch"
        },
        ...
    ],
    "@odata.nextLink": "https://marketingpony.us1app.churnzero.net//public/v1/Account?$select=Id%2CName&$skip=100"
}

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


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

{
    "@odata.context": "https://marketingpony.us1app.churnzero.net//public/v1/$metadata#Account(Id,Name)",
    "value": [
        {
            "Id": 22323,
            "Name": "Bahringer, Hessel and Schmitt"
        },
        {
            "Id": 25088,
            "Name": "Bahringer-Cruickshank"
        },
        ...
    ],
    "@odata.nextLink": "https://marketingpony.us1app.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://marketingpony.us1app.churnzero.net//public/v1/$metadata#Account(Id,Name)",
    "value": []
}

The page size for all collection requests is 100 results. Paging can be accomplished by simply following the provided @odata.nextLink property, this is known as server side paging. With server side paging the @odata.nextLink will contain either a $skip or $skiptoken parameter that will access the next page of data. When following the @odata.nextLink, the link should be used as is and not interpreted. The format of the link could possibly change to provide performance enhancements automatically to all clients utilizing server side paging. Changes to the @odata.nextLink are considered non-breaking changes.

Client side paging can also be used where the @odata.nextLink is ignored and the $skip parameter is merely incremented by the caller of the API.

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'`
number(int32)	Represents a 32-bit signed integer	$filter=LicenseCount gt `400`
number(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'`
number(int32)	Represents a 32-bit signed integer	`3245`
number(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

GET/Account
GET/Account({Id})
GET/Account({Id})/DirectParentAccount
GET/Account({Id})/ParentAccount
GET/Account({Id})/PrimaryChurnScore
GET/Account({Id})/UltimateParentAccount
GET/Account({Id})/UserAccount
GET/Account(AccountExternalId='{AccountExternalId}')

Account available in ChurnZero.

Permissions

Bulk Read - Accounts

Get all Accounts

GET /Account

Code samples

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

200 response

{
  "value": [
    {
      "Id": 5,
      "BillingAddressCity": "string",
      "BillingAddressCountry": "string",
      "BillingAddressLine1": "string",
      "BillingAddressLine2": "string",
      "BillingAddressState": "string",
      "BillingAddressZip": "string",
      "ContactsCount": 16,
      "CrmId": "string",
      "DirectParentAccountId": 25,
      "EndDate": "2025-10-18T14:00:32.3288567Z",
      "ExternalId": "string",
      "IsActive": false,
      "LicenseCount": 20,
      "Name": "string",
      "NextRenewalDate": "2025-10-18T14:00:32.3288567Z",
      "ObjectCreatedDate": "2025-10-18T14:00:32.3288567Z",
      "ObjectLastModifiedDate": "2025-10-18T14:00:32.3288567Z",
      "ParentAccountId": 4,
      "ParentNextRenewalDate": "2025-10-18T14:00:32.3288567Z",
      "ParentTotalContractAmount": "string",
      "PrimaryChurnScoreId": 9,
      "PrimaryChurnScoreValue": "string",
      "StartDate": "2025-10-18T14:00:32.3288567Z",
      "Tags": "string",
      "TenureInDays": 18,
      "TotalContractAmount": "string",
      "UltimateParentAccountId": 18,
      "UsageFrequency": "string",
      "UserAccountId": 8,
      "PrimaryChurnScore@odata.navigationLink": "https://marketingpony.us1app.churnzero.net/public/v1/Account(5)/PrimaryChurnScore",
      "ParentAccount@odata.navigationLink": "https://marketingpony.us1app.churnzero.net/public/v1/Account(5)/ParentAccount",
      "UserAccount@odata.navigationLink": "https://marketingpony.us1app.churnzero.net/public/v1/Account(5)/UserAccount",
      "DirectParentAccount@odata.navigationLink": "https://marketingpony.us1app.churnzero.net/public/v1/Account(5)/DirectParentAccount",
      "UltimateParentAccount@odata.navigationLink": "https://marketingpony.us1app.churnzero.net/public/v1/Account(5)/UltimateParentAccount"
    }
  ],
  "@odata.nextLink": "https://marketingpony.us1app.churnzero.net/public/v1/Account?$skiptoken=eyJmIjpbeyJuIjoiSWQiLCJ2IjoiNzY2OSJ9XSwibyI6NH0"
}

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, DirectParentAccountId, UltimateParentAccountId, PrimaryChurnScoreId, IsActive, Use/SegmentId, Use/SegmentColumnSetId
↓ Show Options ↓			↑ Hide Options ↑
	$orderby array[string]	Order items by property values
Id, Name, NextRenewalDate, ParentNextRenewalDate, TotalContractAmount, ParentTotalContractAmount, BillingAddressLine1, BillingAddressLine2, BillingAddressCity, BillingAddressState, BillingAddressZip, BillingAddressCountry, StartDate, EndDate, LicenseCount, TenureInDays, PrimaryChurnScoreValue, ContactsCount, ObjectCreatedDate, ObjectLastModifiedDate
↓ 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, DirectParentAccountId, UltimateParentAccountId, Tags, ObjectCreatedDate, ObjectLastModifiedDate
↓ Show Options ↓			↑ Hide Options ↑
	$expand array[string]	Expand related entities
*, DirectParentAccount, ParentAccount, PrimaryChurnScore, UltimateParentAccount, UserAccount
↓ Show Options ↓			↑ Hide Options ↑
	$top number(int32)	Show only the first n items
	$skip number(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://marketingpony.us1app.churnzero.net/public/v1/Account(5)" \
-H "Authorization: Basic c29tZXVzZXI6c3VwM3JTM2NyMzch"

200 response

{
  "Id": 5,
  "BillingAddressCity": "string",
  "BillingAddressCountry": "string",
  "BillingAddressLine1": "string",
  "BillingAddressLine2": "string",
  "BillingAddressState": "string",
  "BillingAddressZip": "string",
  "ContactsCount": 16,
  "CrmId": "string",
  "DirectParentAccountId": 25,
  "EndDate": "2025-10-18T14:00:32.3288567Z",
  "ExternalId": "string",
  "IsActive": false,
  "LicenseCount": 20,
  "Name": "string",
  "NextRenewalDate": "2025-10-18T14:00:32.3288567Z",
  "ObjectCreatedDate": "2025-10-18T14:00:32.3288567Z",
  "ObjectLastModifiedDate": "2025-10-18T14:00:32.3288567Z",
  "ParentAccountId": 4,
  "ParentNextRenewalDate": "2025-10-18T14:00:32.3288567Z",
  "ParentTotalContractAmount": "string",
  "PrimaryChurnScoreId": 9,
  "PrimaryChurnScoreValue": "string",
  "StartDate": "2025-10-18T14:00:32.3288567Z",
  "Tags": "string",
  "TenureInDays": 18,
  "TotalContractAmount": "string",
  "UltimateParentAccountId": 18,
  "UsageFrequency": "string",
  "UserAccountId": 8,
  "PrimaryChurnScore@odata.navigationLink": "https://marketingpony.us1app.churnzero.net/public/v1/Account(5)/PrimaryChurnScore",
  "ParentAccount@odata.navigationLink": "https://marketingpony.us1app.churnzero.net/public/v1/Account(5)/ParentAccount",
  "UserAccount@odata.navigationLink": "https://marketingpony.us1app.churnzero.net/public/v1/Account(5)/UserAccount",
  "DirectParentAccount@odata.navigationLink": "https://marketingpony.us1app.churnzero.net/public/v1/Account(5)/DirectParentAccount",
  "UltimateParentAccount@odata.navigationLink": "https://marketingpony.us1app.churnzero.net/public/v1/Account(5)/UltimateParentAccount"
}

Parameters

	Name	Description
	Id number(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, DirectParentAccountId, UltimateParentAccountId, Tags, ObjectCreatedDate, ObjectLastModifiedDate
↓ Show Options ↓			↑ Hide Options ↑
	$expand array[string]	Expand related entities
*, DirectParentAccount, ParentAccount, PrimaryChurnScore, UltimateParentAccount, 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 DirectParentAccount

GET /Account({Id})/DirectParentAccount

Code samples

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

200 response

{
  "Id": 5,
  "BillingAddressCity": "string",
  "BillingAddressCountry": "string",
  "BillingAddressLine1": "string",
  "BillingAddressLine2": "string",
  "BillingAddressState": "string",
  "BillingAddressZip": "string",
  "ContactsCount": 16,
  "CrmId": "string",
  "DirectParentAccountId": 25,
  "EndDate": "2025-10-18T14:00:32.3288567Z",
  "ExternalId": "string",
  "IsActive": false,
  "LicenseCount": 20,
  "Name": "string",
  "NextRenewalDate": "2025-10-18T14:00:32.3288567Z",
  "ObjectCreatedDate": "2025-10-18T14:00:32.3288567Z",
  "ObjectLastModifiedDate": "2025-10-18T14:00:32.3288567Z",
  "ParentAccountId": 4,
  "ParentNextRenewalDate": "2025-10-18T14:00:32.3288567Z",
  "ParentTotalContractAmount": "string",
  "PrimaryChurnScoreId": 9,
  "PrimaryChurnScoreValue": "string",
  "StartDate": "2025-10-18T14:00:32.3288567Z",
  "Tags": "string",
  "TenureInDays": 18,
  "TotalContractAmount": "string",
  "UltimateParentAccountId": 18,
  "UsageFrequency": "string",
  "UserAccountId": 8,
  "PrimaryChurnScore@odata.navigationLink": "https://marketingpony.us1app.churnzero.net/public/v1/Account(5)/PrimaryChurnScore",
  "ParentAccount@odata.navigationLink": "https://marketingpony.us1app.churnzero.net/public/v1/Account(5)/ParentAccount",
  "UserAccount@odata.navigationLink": "https://marketingpony.us1app.churnzero.net/public/v1/Account(5)/UserAccount",
  "DirectParentAccount@odata.navigationLink": "https://marketingpony.us1app.churnzero.net/public/v1/Account(5)/DirectParentAccount",
  "UltimateParentAccount@odata.navigationLink": "https://marketingpony.us1app.churnzero.net/public/v1/Account(5)/UltimateParentAccount"
}

Parameters

	Name	Description
	Id number(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, DirectParentAccountId, UltimateParentAccountId, Tags, ObjectCreatedDate, ObjectLastModifiedDate
↓ Show Options ↓			↑ Hide Options ↑
	$expand array[string]	Expand related entities
*, DirectParentAccount, ParentAccount, PrimaryChurnScore, UltimateParentAccount, 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 ParentAccount

GET /Account({Id})/ParentAccount

Code samples

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

200 response

{
  "Id": 5,
  "BillingAddressCity": "string",
  "BillingAddressCountry": "string",
  "BillingAddressLine1": "string",
  "BillingAddressLine2": "string",
  "BillingAddressState": "string",
  "BillingAddressZip": "string",
  "ContactsCount": 16,
  "CrmId": "string",
  "DirectParentAccountId": 25,
  "EndDate": "2025-10-18T14:00:32.3288567Z",
  "ExternalId": "string",
  "IsActive": false,
  "LicenseCount": 20,
  "Name": "string",
  "NextRenewalDate": "2025-10-18T14:00:32.3288567Z",
  "ObjectCreatedDate": "2025-10-18T14:00:32.3288567Z",
  "ObjectLastModifiedDate": "2025-10-18T14:00:32.3288567Z",
  "ParentAccountId": 4,
  "ParentNextRenewalDate": "2025-10-18T14:00:32.3288567Z",
  "ParentTotalContractAmount": "string",
  "PrimaryChurnScoreId": 9,
  "PrimaryChurnScoreValue": "string",
  "StartDate": "2025-10-18T14:00:32.3288567Z",
  "Tags": "string",
  "TenureInDays": 18,
  "TotalContractAmount": "string",
  "UltimateParentAccountId": 18,
  "UsageFrequency": "string",
  "UserAccountId": 8,
  "PrimaryChurnScore@odata.navigationLink": "https://marketingpony.us1app.churnzero.net/public/v1/Account(5)/PrimaryChurnScore",
  "ParentAccount@odata.navigationLink": "https://marketingpony.us1app.churnzero.net/public/v1/Account(5)/ParentAccount",
  "UserAccount@odata.navigationLink": "https://marketingpony.us1app.churnzero.net/public/v1/Account(5)/UserAccount",
  "DirectParentAccount@odata.navigationLink": "https://marketingpony.us1app.churnzero.net/public/v1/Account(5)/DirectParentAccount",
  "UltimateParentAccount@odata.navigationLink": "https://marketingpony.us1app.churnzero.net/public/v1/Account(5)/UltimateParentAccount"
}

Parameters

	Name	Description
	Id number(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, DirectParentAccountId, UltimateParentAccountId, Tags, ObjectCreatedDate, ObjectLastModifiedDate
↓ Show Options ↓			↑ Hide Options ↑
	$expand array[string]	Expand related entities
*, DirectParentAccount, ParentAccount, PrimaryChurnScore, UltimateParentAccount, 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://marketingpony.us1app.churnzero.net/public/v1/Account(5)/PrimaryChurnScore" \
-H "Authorization: Basic c29tZXVzZXI6c3VwM3JTM2NyMzch"

200 response

{
  "Id": 6,
  "GradingBottom": "string",
  "GradingTop": "string",
  "Name": "string"
}

Parameters

	Name	Description
	Id number(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 UltimateParentAccount

GET /Account({Id})/UltimateParentAccount

Code samples

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

200 response

{
  "Id": 5,
  "BillingAddressCity": "string",
  "BillingAddressCountry": "string",
  "BillingAddressLine1": "string",
  "BillingAddressLine2": "string",
  "BillingAddressState": "string",
  "BillingAddressZip": "string",
  "ContactsCount": 16,
  "CrmId": "string",
  "DirectParentAccountId": 25,
  "EndDate": "2025-10-18T14:00:32.3288567Z",
  "ExternalId": "string",
  "IsActive": false,
  "LicenseCount": 20,
  "Name": "string",
  "NextRenewalDate": "2025-10-18T14:00:32.3288567Z",
  "ObjectCreatedDate": "2025-10-18T14:00:32.3288567Z",
  "ObjectLastModifiedDate": "2025-10-18T14:00:32.3288567Z",
  "ParentAccountId": 4,
  "ParentNextRenewalDate": "2025-10-18T14:00:32.3288567Z",
  "ParentTotalContractAmount": "string",
  "PrimaryChurnScoreId": 9,
  "PrimaryChurnScoreValue": "string",
  "StartDate": "2025-10-18T14:00:32.3288567Z",
  "Tags": "string",
  "TenureInDays": 18,
  "TotalContractAmount": "string",
  "UltimateParentAccountId": 18,
  "UsageFrequency": "string",
  "UserAccountId": 8,
  "PrimaryChurnScore@odata.navigationLink": "https://marketingpony.us1app.churnzero.net/public/v1/Account(5)/PrimaryChurnScore",
  "ParentAccount@odata.navigationLink": "https://marketingpony.us1app.churnzero.net/public/v1/Account(5)/ParentAccount",
  "UserAccount@odata.navigationLink": "https://marketingpony.us1app.churnzero.net/public/v1/Account(5)/UserAccount",
  "DirectParentAccount@odata.navigationLink": "https://marketingpony.us1app.churnzero.net/public/v1/Account(5)/DirectParentAccount",
  "UltimateParentAccount@odata.navigationLink": "https://marketingpony.us1app.churnzero.net/public/v1/Account(5)/UltimateParentAccount"
}

Parameters

	Name	Description
	Id number(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, DirectParentAccountId, UltimateParentAccountId, Tags, ObjectCreatedDate, ObjectLastModifiedDate
↓ Show Options ↓			↑ Hide Options ↑
	$expand array[string]	Expand related entities
*, DirectParentAccount, ParentAccount, PrimaryChurnScore, UltimateParentAccount, 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 UserAccount

GET /Account({Id})/UserAccount

Code samples

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

200 response

{
  "Id": 5,
  "AvatarUrl": "string",
  "CanLogIn": true,
  "CrmId": "string",
  "Email": "string",
  "FirstName": "string",
  "HasAccounts": false,
  "IsActive": true,
  "LastName": "string",
  "MobilePhone": "string",
  "Name": "string",
  "ObjectCreatedDate": "2025-10-18T14:00:32.5926853Z",
  "ObjectLastModifiedDate": "2025-10-18T14:00:32.5926853Z",
  "OfficePhone": "string",
  "Title": "string",
  "UserName": "string"
}

Parameters

	Name	Description
	Id number(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
↓ 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://marketingpony.us1app.churnzero.net/public/v1/Account(AccountExternalId='string')" \
-H "Authorization: Basic c29tZXVzZXI6c3VwM3JTM2NyMzch"

200 response

{
  "Id": 5,
  "BillingAddressCity": "string",
  "BillingAddressCountry": "string",
  "BillingAddressLine1": "string",
  "BillingAddressLine2": "string",
  "BillingAddressState": "string",
  "BillingAddressZip": "string",
  "ContactsCount": 16,
  "CrmId": "string",
  "DirectParentAccountId": 25,
  "EndDate": "2025-10-18T14:00:32.3288567Z",
  "ExternalId": "string",
  "IsActive": false,
  "LicenseCount": 20,
  "Name": "string",
  "NextRenewalDate": "2025-10-18T14:00:32.3288567Z",
  "ObjectCreatedDate": "2025-10-18T14:00:32.3288567Z",
  "ObjectLastModifiedDate": "2025-10-18T14:00:32.3288567Z",
  "ParentAccountId": 4,
  "ParentNextRenewalDate": "2025-10-18T14:00:32.3288567Z",
  "ParentTotalContractAmount": "string",
  "PrimaryChurnScoreId": 9,
  "PrimaryChurnScoreValue": "string",
  "StartDate": "2025-10-18T14:00:32.3288567Z",
  "Tags": "string",
  "TenureInDays": 18,
  "TotalContractAmount": "string",
  "UltimateParentAccountId": 18,
  "UsageFrequency": "string",
  "UserAccountId": 8,
  "PrimaryChurnScore@odata.navigationLink": "https://marketingpony.us1app.churnzero.net/public/v1/Account(5)/PrimaryChurnScore",
  "ParentAccount@odata.navigationLink": "https://marketingpony.us1app.churnzero.net/public/v1/Account(5)/ParentAccount",
  "UserAccount@odata.navigationLink": "https://marketingpony.us1app.churnzero.net/public/v1/Account(5)/UserAccount",
  "DirectParentAccount@odata.navigationLink": "https://marketingpony.us1app.churnzero.net/public/v1/Account(5)/DirectParentAccount",
  "UltimateParentAccount@odata.navigationLink": "https://marketingpony.us1app.churnzero.net/public/v1/Account(5)/UltimateParentAccount"
}

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, DirectParentAccountId, UltimateParentAccountId, Tags, ObjectCreatedDate, ObjectLastModifiedDate
↓ Show Options ↓			↑ Hide Options ↑
	$expand array[string]	Expand related entities
*, DirectParentAccount, ParentAccount, PrimaryChurnScore, UltimateParentAccount, 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

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

Contact available in ChurnZero.

Permissions

Bulk Read - Contacts

Get all Contacts

GET /Contact

Code samples

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

200 response

{
  "value": [
    {
      "Id": 8,
      "AccountId": 1,
      "CrmId": "string",
      "Email": "string",
      "ExternalId": "string",
      "FirstName": "string",
      "FullName": "string",
      "LastName": "string",
      "MarketingEmailUnsubscribed": false,
      "Name": "string",
      "ObjectCreatedDate": "2025-10-18T14:00:32.4605244Z",
      "ObjectLastModifiedDate": "2025-10-18T14:00:32.4605244Z",
      "Tags": "string",
      "Account@odata.navigationLink": "https://marketingpony.us1app.churnzero.net/public/v1/Contact(8)/Account"
    }
  ],
  "@odata.nextLink": "https://marketingpony.us1app.churnzero.net/public/v1/Contact?$skiptoken=eyJmIjpbeyJuIjoiSWQiLCJ2IjoiMTE2NTQifV0sIm8iOjR9"
}

Parameters

	Name	Description
	$filter array[string]	Filter items by property values
FirstName, LastName, FullName, Email, Name, MarketingEmailUnsubscribed, ObjectCreatedDate, ObjectLastModifiedDate, ExternalId, CrmId, AccountId, Use/SegmentId, Use/SegmentColumnSetId
↓ Show Options ↓			↑ Hide Options ↑
	$orderby array[string]	Order items by property values
Id, FirstName, LastName, FullName, Email, Name, MarketingEmailUnsubscribed, ObjectCreatedDate, ObjectLastModifiedDate
↓ 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
↓ Show Options ↓			↑ Hide Options ↑
	$expand array[string]	Expand related entities
*, Account
↓ Show Options ↓			↑ Hide Options ↑
	$top number	Show only the first n items
	$skip number	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://marketingpony.us1app.churnzero.net/public/v1/Contact(8)" \
-H "Authorization: Basic c29tZXVzZXI6c3VwM3JTM2NyMzch"

200 response

{
  "Id": 8,
  "AccountId": 1,
  "CrmId": "string",
  "Email": "string",
  "ExternalId": "string",
  "FirstName": "string",
  "FullName": "string",
  "LastName": "string",
  "MarketingEmailUnsubscribed": false,
  "Name": "string",
  "ObjectCreatedDate": "2025-10-18T14:00:32.4605244Z",
  "ObjectLastModifiedDate": "2025-10-18T14:00:32.4605244Z",
  "Tags": "string",
  "Account@odata.navigationLink": "https://marketingpony.us1app.churnzero.net/public/v1/Contact(8)/Account"
}

Parameters

	Name	Description
	Id number(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
↓ 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://marketingpony.us1app.churnzero.net/public/v1/Contact(8)/Account" \
-H "Authorization: Basic c29tZXVzZXI6c3VwM3JTM2NyMzch"

200 response

{
  "Id": 5,
  "BillingAddressCity": "string",
  "BillingAddressCountry": "string",
  "BillingAddressLine1": "string",
  "BillingAddressLine2": "string",
  "BillingAddressState": "string",
  "BillingAddressZip": "string",
  "ContactsCount": 16,
  "CrmId": "string",
  "DirectParentAccountId": 25,
  "EndDate": "2025-10-18T14:00:32.3288567Z",
  "ExternalId": "string",
  "IsActive": false,
  "LicenseCount": 20,
  "Name": "string",
  "NextRenewalDate": "2025-10-18T14:00:32.3288567Z",
  "ObjectCreatedDate": "2025-10-18T14:00:32.3288567Z",
  "ObjectLastModifiedDate": "2025-10-18T14:00:32.3288567Z",
  "ParentAccountId": 4,
  "ParentNextRenewalDate": "2025-10-18T14:00:32.3288567Z",
  "ParentTotalContractAmount": "string",
  "PrimaryChurnScoreId": 9,
  "PrimaryChurnScoreValue": "string",
  "StartDate": "2025-10-18T14:00:32.3288567Z",
  "Tags": "string",
  "TenureInDays": 18,
  "TotalContractAmount": "string",
  "UltimateParentAccountId": 18,
  "UsageFrequency": "string",
  "UserAccountId": 8,
  "PrimaryChurnScore@odata.navigationLink": "https://marketingpony.us1app.churnzero.net/public/v1/Account(5)/PrimaryChurnScore",
  "ParentAccount@odata.navigationLink": "https://marketingpony.us1app.churnzero.net/public/v1/Account(5)/ParentAccount",
  "UserAccount@odata.navigationLink": "https://marketingpony.us1app.churnzero.net/public/v1/Account(5)/UserAccount",
  "DirectParentAccount@odata.navigationLink": "https://marketingpony.us1app.churnzero.net/public/v1/Account(5)/DirectParentAccount",
  "UltimateParentAccount@odata.navigationLink": "https://marketingpony.us1app.churnzero.net/public/v1/Account(5)/UltimateParentAccount"
}

Parameters

	Name	Description
	Id number(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, DirectParentAccountId, UltimateParentAccountId, Tags, ObjectCreatedDate, ObjectLastModifiedDate
↓ Show Options ↓			↑ Hide Options ↑
	$expand array[string]	Expand related entities
*, DirectParentAccount, ParentAccount, PrimaryChurnScore, UltimateParentAccount, 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://marketingpony.us1app.churnzero.net/public/v1/Contact(8)/Contact.ExternalId" \
-H "Authorization: Basic c29tZXVzZXI6c3VwM3JTM2NyMzch"

200 response

{
  "Id": 8,
  "AccountId": 1,
  "CrmId": "string",
  "Email": "string",
  "ExternalId": "string",
  "FirstName": "string",
  "FullName": "string",
  "LastName": "string",
  "MarketingEmailUnsubscribed": false,
  "Name": "string",
  "ObjectCreatedDate": "2025-10-18T14:00:32.4605244Z",
  "ObjectLastModifiedDate": "2025-10-18T14:00:32.4605244Z",
  "Tags": "string",
  "Account@odata.navigationLink": "https://marketingpony.us1app.churnzero.net/public/v1/Contact(8)/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
↓ 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

GET/UserAccount
GET/UserAccount({Id})

User Account available in ChurnZero.

Permissions

Bulk Read - User Accounts

Get all UserAccounts

GET /UserAccount

Code samples

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

200 response

{
  "value": [
    {
      "Id": 5,
      "AvatarUrl": "string",
      "CanLogIn": true,
      "CrmId": "string",
      "Email": "string",
      "FirstName": "string",
      "HasAccounts": false,
      "IsActive": true,
      "LastName": "string",
      "MobilePhone": "string",
      "Name": "string",
      "ObjectCreatedDate": "2025-10-18T14:00:32.5926853Z",
      "ObjectLastModifiedDate": "2025-10-18T14:00:32.5926853Z",
      "OfficePhone": "string",
      "Title": "string",
      "UserName": "string"
    }
  ],
  "@odata.nextLink": "https://marketingpony.us1app.churnzero.net/public/v1/UserAccount?$skiptoken=eyJmIjpbeyJuIjoiSWQiLCJ2IjoiMjQzMjAifV0sIm8iOjR9"
}

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
↓ Show Options ↓			↑ Hide Options ↑
	$orderby array[string]	Order items by property values
Id, UserName, FirstName, LastName, Name, Email, HasAccounts, MobilePhone, OfficePhone, Title, CanLogIn, IsActive, ObjectCreatedDate, ObjectLastModifiedDate
↓ 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
↓ Show Options ↓			↑ Hide Options ↑
	$expand array[string]	Expand related entities
*
↓ Show Options ↓			↑ Hide Options ↑
	$top number	Show only the first n items
	$skip number	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://marketingpony.us1app.churnzero.net/public/v1/UserAccount(5)" \
-H "Authorization: Basic c29tZXVzZXI6c3VwM3JTM2NyMzch"

200 response

{
  "Id": 5,
  "AvatarUrl": "string",
  "CanLogIn": true,
  "CrmId": "string",
  "Email": "string",
  "FirstName": "string",
  "HasAccounts": false,
  "IsActive": true,
  "LastName": "string",
  "MobilePhone": "string",
  "Name": "string",
  "ObjectCreatedDate": "2025-10-18T14:00:32.5926853Z",
  "ObjectLastModifiedDate": "2025-10-18T14:00:32.5926853Z",
  "OfficePhone": "string",
  "Title": "string",
  "UserName": "string"
}

Parameters

	Name	Description
	Id number(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
↓ 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

GET/Event
GET/Event({Id})
GET/Event({Id})/Account
GET/Event({Id})/Contact
GET/Event({Id})/EventType

Event available in ChurnZero.

Permissions

Bulk Read - Events

Get all Events

GET /Event

Code samples

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

200 response

{
  "value": [
    {
      "Id": 9,
      "AccountId": 28,
      "ContactId": 7,
      "Description": "string",
      "EventDate": "2025-10-18T14:00:32.5927300Z",
      "EventTypeId": 12,
      "Quantity": "string",
      "Contact@odata.navigationLink": "https://marketingpony.us1app.churnzero.net/public/v1/Event(9)/Contact",
      "Account@odata.navigationLink": "https://marketingpony.us1app.churnzero.net/public/v1/Event(9)/Account",
      "EventType@odata.navigationLink": "https://marketingpony.us1app.churnzero.net/public/v1/Event(9)/EventType"
    }
  ],
  "@odata.nextLink": "https://marketingpony.us1app.churnzero.net/public/v1/Event?$skiptoken=eyJmIjpbeyJuIjoiSWQiLCJ2IjoiMTM5MjAifV0sIm8iOjR9"
}

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
Id, 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
*, Account, Contact, EventType
↓ Show Options ↓			↑ Hide Options ↑
	$top number	Show only the first n items
	$skip number	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://marketingpony.us1app.churnzero.net/public/v1/Event(9)" \
-H "Authorization: Basic c29tZXVzZXI6c3VwM3JTM2NyMzch"

200 response

{
  "Id": 9,
  "AccountId": 28,
  "ContactId": 7,
  "Description": "string",
  "EventDate": "2025-10-18T14:00:32.5927300Z",
  "EventTypeId": 12,
  "Quantity": "string",
  "Contact@odata.navigationLink": "https://marketingpony.us1app.churnzero.net/public/v1/Event(9)/Contact",
  "Account@odata.navigationLink": "https://marketingpony.us1app.churnzero.net/public/v1/Event(9)/Account",
  "EventType@odata.navigationLink": "https://marketingpony.us1app.churnzero.net/public/v1/Event(9)/EventType"
}

Parameters

	Name	Description
	Id number(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
*, Account, Contact, 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://marketingpony.us1app.churnzero.net/public/v1/Event(9)/Account" \
-H "Authorization: Basic c29tZXVzZXI6c3VwM3JTM2NyMzch"

200 response

{
  "Id": 5,
  "BillingAddressCity": "string",
  "BillingAddressCountry": "string",
  "BillingAddressLine1": "string",
  "BillingAddressLine2": "string",
  "BillingAddressState": "string",
  "BillingAddressZip": "string",
  "ContactsCount": 16,
  "CrmId": "string",
  "DirectParentAccountId": 25,
  "EndDate": "2025-10-18T14:00:32.3288567Z",
  "ExternalId": "string",
  "IsActive": false,
  "LicenseCount": 20,
  "Name": "string",
  "NextRenewalDate": "2025-10-18T14:00:32.3288567Z",
  "ObjectCreatedDate": "2025-10-18T14:00:32.3288567Z",
  "ObjectLastModifiedDate": "2025-10-18T14:00:32.3288567Z",
  "ParentAccountId": 4,
  "ParentNextRenewalDate": "2025-10-18T14:00:32.3288567Z",
  "ParentTotalContractAmount": "string",
  "PrimaryChurnScoreId": 9,
  "PrimaryChurnScoreValue": "string",
  "StartDate": "2025-10-18T14:00:32.3288567Z",
  "Tags": "string",
  "TenureInDays": 18,
  "TotalContractAmount": "string",
  "UltimateParentAccountId": 18,
  "UsageFrequency": "string",
  "UserAccountId": 8,
  "PrimaryChurnScore@odata.navigationLink": "https://marketingpony.us1app.churnzero.net/public/v1/Account(5)/PrimaryChurnScore",
  "ParentAccount@odata.navigationLink": "https://marketingpony.us1app.churnzero.net/public/v1/Account(5)/ParentAccount",
  "UserAccount@odata.navigationLink": "https://marketingpony.us1app.churnzero.net/public/v1/Account(5)/UserAccount",
  "DirectParentAccount@odata.navigationLink": "https://marketingpony.us1app.churnzero.net/public/v1/Account(5)/DirectParentAccount",
  "UltimateParentAccount@odata.navigationLink": "https://marketingpony.us1app.churnzero.net/public/v1/Account(5)/UltimateParentAccount"
}

Parameters

	Name	Description
	Id number(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, DirectParentAccountId, UltimateParentAccountId, Tags, ObjectCreatedDate, ObjectLastModifiedDate
↓ Show Options ↓			↑ Hide Options ↑
	$expand array[string]	Expand related entities
*, DirectParentAccount, ParentAccount, PrimaryChurnScore, UltimateParentAccount, 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://marketingpony.us1app.churnzero.net/public/v1/Event(9)/Contact" \
-H "Authorization: Basic c29tZXVzZXI6c3VwM3JTM2NyMzch"

200 response

{
  "Id": 8,
  "AccountId": 1,
  "CrmId": "string",
  "Email": "string",
  "ExternalId": "string",
  "FirstName": "string",
  "FullName": "string",
  "LastName": "string",
  "MarketingEmailUnsubscribed": false,
  "Name": "string",
  "ObjectCreatedDate": "2025-10-18T14:00:32.4605244Z",
  "ObjectLastModifiedDate": "2025-10-18T14:00:32.4605244Z",
  "Tags": "string",
  "Account@odata.navigationLink": "https://marketingpony.us1app.churnzero.net/public/v1/Contact(8)/Account"
}

Parameters

	Name	Description
	Id number(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
↓ 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://marketingpony.us1app.churnzero.net/public/v1/Event(9)/EventType" \
-H "Authorization: Basic c29tZXVzZXI6c3VwM3JTM2NyMzch"

200 response

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

Parameters

	Name	Description
	Id number(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

GET/EventType
GET/EventType({Id})

Event Type available in ChurnZero.

Permissions

Bulk Read - Events

Get all EventTypes

GET /EventType

Code samples

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

200 response

{
  "value": [
    {
      "Id": 5,
      "Name": "string"
    }
  ],
  "@odata.nextLink": "https://marketingpony.us1app.churnzero.net/public/v1/EventType?$skiptoken=eyJmIjpbeyJuIjoiSWQiLCJ2IjoiOTQ5MyJ9XSwibyI6NH0"
}

Parameters

	Name	Description
	$filter array[string]	Filter items by property values
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
↓ Show Options ↓			↑ Hide Options ↑
	$expand array[string]	Expand related entities
*
↓ Show Options ↓			↑ Hide Options ↑
	$top number	Show only the first n items
	$skip number	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://marketingpony.us1app.churnzero.net/public/v1/EventType(5)" \
-H "Authorization: Basic c29tZXVzZXI6c3VwM3JTM2NyMzch"

200 response

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

Parameters

	Name	Description
	Id number(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

GET/Segment
GET/Segment({Id})
GET/Segment({Id})/UserAccount

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://marketingpony.us1app.churnzero.net/public/v1/Segment" \
-H "Authorization: Basic c29tZXVzZXI6c3VwM3JTM2NyMzch"

200 response

{
  "value": [
    {
      "Id": 9,
      "Entity": "string",
      "IsGlobal": false,
      "Name": "string",
      "ObjectCreatedDate": "2025-10-18T14:00:32.5927678Z",
      "ObjectLastModifiedDate": "2025-10-18T14:00:32.5927678Z",
      "UserAccountId": 14,
      "UserAccount@odata.navigationLink": "https://marketingpony.us1app.churnzero.net/public/v1/Segment(9)/UserAccount"
    }
  ],
  "@odata.nextLink": "https://marketingpony.us1app.churnzero.net/public/v1/Segment?$skiptoken=eyJmIjpbeyJuIjoiSWQiLCJ2IjoiMjU4NTMifV0sIm8iOjR9"
}

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
Id, Name, ObjectCreatedDate, ObjectLastModifiedDate
↓ Show Options ↓			↑ Hide Options ↑
	$select array[string]	Select properties to be returned
Id, Name, Entity, IsGlobal, UserAccountId, ObjectCreatedDate, ObjectLastModifiedDate
↓ Show Options ↓			↑ Hide Options ↑
	$expand array[string]	Expand related entities
*, UserAccount
↓ Show Options ↓			↑ Hide Options ↑
	$top number	Show only the first n items
	$skip number	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://marketingpony.us1app.churnzero.net/public/v1/Segment(9)" \
-H "Authorization: Basic c29tZXVzZXI6c3VwM3JTM2NyMzch"

200 response

{
  "Id": 9,
  "Entity": "string",
  "IsGlobal": false,
  "Name": "string",
  "ObjectCreatedDate": "2025-10-18T14:00:32.5927678Z",
  "ObjectLastModifiedDate": "2025-10-18T14:00:32.5927678Z",
  "UserAccountId": 14,
  "UserAccount@odata.navigationLink": "https://marketingpony.us1app.churnzero.net/public/v1/Segment(9)/UserAccount"
}

Parameters

	Name	Description
	Id number(int64)	Id of the Segment
	$select array[string]	Select properties to be returned
Id, Name, Entity, IsGlobal, UserAccountId, ObjectCreatedDate, ObjectLastModifiedDate
↓ Show Options ↓			↑ Hide Options ↑
	$expand array[string]	Expand related entities
*, UserAccount
↓ 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

Get the UserAccount

GET /Segment({Id})/UserAccount

Code samples

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

200 response

{
  "Id": 5,
  "AvatarUrl": "string",
  "CanLogIn": true,
  "CrmId": "string",
  "Email": "string",
  "FirstName": "string",
  "HasAccounts": false,
  "IsActive": true,
  "LastName": "string",
  "MobilePhone": "string",
  "Name": "string",
  "ObjectCreatedDate": "2025-10-18T14:00:32.5926853Z",
  "ObjectLastModifiedDate": "2025-10-18T14:00:32.5926853Z",
  "OfficePhone": "string",
  "Title": "string",
  "UserName": "string"
}

Parameters

	Name	Description
	Id number(int64)	Id of the Segment
	$select array[string]	Select properties to be returned
Id, UserName, FirstName, LastName, Name, Email, HasAccounts, AvatarUrl, MobilePhone, OfficePhone, Title, CanLogIn, CrmId, IsActive, ObjectCreatedDate, ObjectLastModifiedDate
↓ 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

SegmentColumnSet

GET/SegmentColumnSet
GET/SegmentColumnSet({Id})
GET/SegmentColumnSet({Id})/UserAccount

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://marketingpony.us1app.churnzero.net/public/v1/SegmentColumnSet" \
-H "Authorization: Basic c29tZXVzZXI6c3VwM3JTM2NyMzch"

200 response

{
  "value": [
    {
      "Id": 1,
      "Entity": "string",
      "Name": "string",
      "ObjectCreatedDate": "2025-10-18T14:00:32.9369349Z",
      "ObjectLastModifiedDate": "2025-10-18T14:00:32.9369349Z",
      "ShareType": "string",
      "UserAccountId": 25,
      "UserAccount@odata.navigationLink": "https://marketingpony.us1app.churnzero.net/public/v1/SegmentColumnSet(1)/UserAccount"
    }
  ],
  "@odata.nextLink": "https://marketingpony.us1app.churnzero.net/public/v1/SegmentColumnSet?$skiptoken=eyJmIjpbeyJuIjoiSWQiLCJ2IjoiNDQyNiJ9XSwibyI6NH0"
}

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
Id, 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 number	Show only the first n items
	$skip number	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://marketingpony.us1app.churnzero.net/public/v1/SegmentColumnSet(1)" \
-H "Authorization: Basic c29tZXVzZXI6c3VwM3JTM2NyMzch"

200 response

{
  "Id": 1,
  "Entity": "string",
  "Name": "string",
  "ObjectCreatedDate": "2025-10-18T14:00:32.9369349Z",
  "ObjectLastModifiedDate": "2025-10-18T14:00:32.9369349Z",
  "ShareType": "string",
  "UserAccountId": 25,
  "UserAccount@odata.navigationLink": "https://marketingpony.us1app.churnzero.net/public/v1/SegmentColumnSet(1)/UserAccount"
}

Parameters

	Name	Description
	Id number(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://marketingpony.us1app.churnzero.net/public/v1/SegmentColumnSet(1)/UserAccount" \
-H "Authorization: Basic c29tZXVzZXI6c3VwM3JTM2NyMzch"

200 response

{
  "Id": 5,
  "AvatarUrl": "string",
  "CanLogIn": true,
  "CrmId": "string",
  "Email": "string",
  "FirstName": "string",
  "HasAccounts": false,
  "IsActive": true,
  "LastName": "string",
  "MobilePhone": "string",
  "Name": "string",
  "ObjectCreatedDate": "2025-10-18T14:00:32.5926853Z",
  "ObjectLastModifiedDate": "2025-10-18T14:00:32.5926853Z",
  "OfficePhone": "string",
  "Title": "string",
  "UserName": "string"
}

Parameters

	Name	Description
	Id number(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
↓ 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

GET/Task
GET/Task({Id})
GET/Task({Id})/Account
GET/Task({Id})/Contact
GET/Task({Id})/TaskPriority
GET/Task({Id})/TaskStatus
GET/Task({Id})/UserAccount

Task available in ChurnZero.

Permissions

Bulk Read - Tasks

Get all Tasks

GET /Task

Code samples

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

200 response

{
  "value": [
    {
      "Id": 4,
      "AccountId": 19,
      "CloseDate": "2025-10-18T14:00:33.2707887Z",
      "Comments": "string",
      "ContactId": 5,
      "CrmId": "string",
      "DueDate": "2025-10-18T14:00:33.2707887Z",
      "IsClosed": false,
      "IsHighPriority": true,
      "ObjectCreatedDate": "2025-10-18T14:00:33.2707887Z",
      "ObjectLastModifiedDate": "2025-10-18T14:00:33.2707887Z",
      "Subject": "string",
      "TaskPriorityId": 18,
      "TaskStatusId": 18,
      "TaskType": "string",
      "UserAccountId": 3,
      "Account@odata.navigationLink": "https://marketingpony.us1app.churnzero.net/public/v1/Task(4)/Account",
      "Contact@odata.navigationLink": "https://marketingpony.us1app.churnzero.net/public/v1/Task(4)/Contact",
      "UserAccount@odata.navigationLink": "https://marketingpony.us1app.churnzero.net/public/v1/Task(4)/UserAccount",
      "TaskPriority@odata.navigationLink": "https://marketingpony.us1app.churnzero.net/public/v1/Task(4)/TaskPriority",
      "TaskStatus@odata.navigationLink": "https://marketingpony.us1app.churnzero.net/public/v1/Task(4)/TaskStatus"
    }
  ],
  "@odata.nextLink": "https://marketingpony.us1app.churnzero.net/public/v1/Task?$skiptoken=eyJmIjpbeyJuIjoiSWQiLCJ2IjoiNjE3MCJ9XSwibyI6NH0"
}

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, 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
↓ 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
↓ Show Options ↓			↑ Hide Options ↑
	$expand array[string]	Expand related entities
*, Account, Contact, TaskPriority, TaskStatus, UserAccount
↓ Show Options ↓			↑ Hide Options ↑
	$top number	Show only the first n items
	$skip number	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://marketingpony.us1app.churnzero.net/public/v1/Task(4)" \
-H "Authorization: Basic c29tZXVzZXI6c3VwM3JTM2NyMzch"

200 response

{
  "Id": 4,
  "AccountId": 19,
  "CloseDate": "2025-10-18T14:00:33.2707887Z",
  "Comments": "string",
  "ContactId": 5,
  "CrmId": "string",
  "DueDate": "2025-10-18T14:00:33.2707887Z",
  "IsClosed": false,
  "IsHighPriority": true,
  "ObjectCreatedDate": "2025-10-18T14:00:33.2707887Z",
  "ObjectLastModifiedDate": "2025-10-18T14:00:33.2707887Z",
  "Subject": "string",
  "TaskPriorityId": 18,
  "TaskStatusId": 18,
  "TaskType": "string",
  "UserAccountId": 3,
  "Account@odata.navigationLink": "https://marketingpony.us1app.churnzero.net/public/v1/Task(4)/Account",
  "Contact@odata.navigationLink": "https://marketingpony.us1app.churnzero.net/public/v1/Task(4)/Contact",
  "UserAccount@odata.navigationLink": "https://marketingpony.us1app.churnzero.net/public/v1/Task(4)/UserAccount",
  "TaskPriority@odata.navigationLink": "https://marketingpony.us1app.churnzero.net/public/v1/Task(4)/TaskPriority",
  "TaskStatus@odata.navigationLink": "https://marketingpony.us1app.churnzero.net/public/v1/Task(4)/TaskStatus"
}

Parameters

	Name	Description
	Id number(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
↓ Show Options ↓			↑ Hide Options ↑
	$expand array[string]	Expand related entities
*, Account, Contact, TaskPriority, TaskStatus, UserAccount
↓ 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://marketingpony.us1app.churnzero.net/public/v1/Task(4)/Account" \
-H "Authorization: Basic c29tZXVzZXI6c3VwM3JTM2NyMzch"

200 response

{
  "Id": 5,
  "BillingAddressCity": "string",
  "BillingAddressCountry": "string",
  "BillingAddressLine1": "string",
  "BillingAddressLine2": "string",
  "BillingAddressState": "string",
  "BillingAddressZip": "string",
  "ContactsCount": 16,
  "CrmId": "string",
  "DirectParentAccountId": 25,
  "EndDate": "2025-10-18T14:00:32.3288567Z",
  "ExternalId": "string",
  "IsActive": false,
  "LicenseCount": 20,
  "Name": "string",
  "NextRenewalDate": "2025-10-18T14:00:32.3288567Z",
  "ObjectCreatedDate": "2025-10-18T14:00:32.3288567Z",
  "ObjectLastModifiedDate": "2025-10-18T14:00:32.3288567Z",
  "ParentAccountId": 4,
  "ParentNextRenewalDate": "2025-10-18T14:00:32.3288567Z",
  "ParentTotalContractAmount": "string",
  "PrimaryChurnScoreId": 9,
  "PrimaryChurnScoreValue": "string",
  "StartDate": "2025-10-18T14:00:32.3288567Z",
  "Tags": "string",
  "TenureInDays": 18,
  "TotalContractAmount": "string",
  "UltimateParentAccountId": 18,
  "UsageFrequency": "string",
  "UserAccountId": 8,
  "PrimaryChurnScore@odata.navigationLink": "https://marketingpony.us1app.churnzero.net/public/v1/Account(5)/PrimaryChurnScore",
  "ParentAccount@odata.navigationLink": "https://marketingpony.us1app.churnzero.net/public/v1/Account(5)/ParentAccount",
  "UserAccount@odata.navigationLink": "https://marketingpony.us1app.churnzero.net/public/v1/Account(5)/UserAccount",
  "DirectParentAccount@odata.navigationLink": "https://marketingpony.us1app.churnzero.net/public/v1/Account(5)/DirectParentAccount",
  "UltimateParentAccount@odata.navigationLink": "https://marketingpony.us1app.churnzero.net/public/v1/Account(5)/UltimateParentAccount"
}

Parameters

	Name	Description
	Id number(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, DirectParentAccountId, UltimateParentAccountId, Tags, ObjectCreatedDate, ObjectLastModifiedDate
↓ Show Options ↓			↑ Hide Options ↑
	$expand array[string]	Expand related entities
*, DirectParentAccount, ParentAccount, PrimaryChurnScore, UltimateParentAccount, 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://marketingpony.us1app.churnzero.net/public/v1/Task(4)/Contact" \
-H "Authorization: Basic c29tZXVzZXI6c3VwM3JTM2NyMzch"

200 response

{
  "Id": 8,
  "AccountId": 1,
  "CrmId": "string",
  "Email": "string",
  "ExternalId": "string",
  "FirstName": "string",
  "FullName": "string",
  "LastName": "string",
  "MarketingEmailUnsubscribed": false,
  "Name": "string",
  "ObjectCreatedDate": "2025-10-18T14:00:32.4605244Z",
  "ObjectLastModifiedDate": "2025-10-18T14:00:32.4605244Z",
  "Tags": "string",
  "Account@odata.navigationLink": "https://marketingpony.us1app.churnzero.net/public/v1/Contact(8)/Account"
}

Parameters

	Name	Description
	Id number(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
↓ 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://marketingpony.us1app.churnzero.net/public/v1/Task(4)/TaskPriority" \
-H "Authorization: Basic c29tZXVzZXI6c3VwM3JTM2NyMzch"

200 response

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

Parameters

	Name	Description
	Id number(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://marketingpony.us1app.churnzero.net/public/v1/Task(4)/TaskStatus" \
-H "Authorization: Basic c29tZXVzZXI6c3VwM3JTM2NyMzch"

200 response

{
  "Id": 4,
  "IsClosed": true,
  "IsDefault": false,
  "Name": "string"
}

Parameters

	Name	Description
	Id number(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://marketingpony.us1app.churnzero.net/public/v1/Task(4)/UserAccount" \
-H "Authorization: Basic c29tZXVzZXI6c3VwM3JTM2NyMzch"

200 response

{
  "Id": 5,
  "AvatarUrl": "string",
  "CanLogIn": true,
  "CrmId": "string",
  "Email": "string",
  "FirstName": "string",
  "HasAccounts": false,
  "IsActive": true,
  "LastName": "string",
  "MobilePhone": "string",
  "Name": "string",
  "ObjectCreatedDate": "2025-10-18T14:00:32.5926853Z",
  "ObjectLastModifiedDate": "2025-10-18T14:00:32.5926853Z",
  "OfficePhone": "string",
  "Title": "string",
  "UserName": "string"
}

Parameters

	Name	Description
	Id number(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
↓ 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

GET/TaskPriority
GET/TaskPriority({Id})

Task Priority available in ChurnZero.

Permissions

Bulk Read - Tasks

Get all TaskPriorities

GET /TaskPriority

Code samples

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

200 response

{
  "value": [
    {
      "Id": 3,
      "IsDefault": true,
      "IsHighPriority": false,
      "Name": "string"
    }
  ],
  "@odata.nextLink": "https://marketingpony.us1app.churnzero.net/public/v1/TaskPriority?$skiptoken=eyJmIjpbeyJuIjoiSWQiLCJ2IjoiMTI2NzQifV0sIm8iOjR9"
}

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 number	Show only the first n items
	$skip number	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://marketingpony.us1app.churnzero.net/public/v1/TaskPriority(3)" \
-H "Authorization: Basic c29tZXVzZXI6c3VwM3JTM2NyMzch"

200 response

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

Parameters

	Name	Description
	Id number(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

GET/TaskStatus
GET/TaskStatus({Id})

Task Status available in ChurnZero.

Permissions

Bulk Read - Tasks

Get all TaskStatuses

GET /TaskStatus

Code samples

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

200 response

{
  "value": [
    {
      "Id": 4,
      "IsClosed": true,
      "IsDefault": false,
      "Name": "string"
    }
  ],
  "@odata.nextLink": "https://marketingpony.us1app.churnzero.net/public/v1/TaskStatus?$skiptoken=eyJmIjpbeyJuIjoiSWQiLCJ2IjoiMjYxMTkifV0sIm8iOjR9"
}

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 number	Show only the first n items
	$skip number	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://marketingpony.us1app.churnzero.net/public/v1/TaskStatus(4)" \
-H "Authorization: Basic c29tZXVzZXI6c3VwM3JTM2NyMzch"

200 response

{
  "Id": 4,
  "IsClosed": true,
  "IsDefault": false,
  "Name": "string"
}

Parameters

	Name	Description
	Id number(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

GET/Survey
GET/Survey({Id})

Survey definition available in ChurnZero.

Permissions

Bulk Read - Surveys

Get all Surveys

GET /Survey

Code samples

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

200 response

{
  "value": [
    {
      "Id": 2,
      "CampaignStatus": "string",
      "CampaignType": "string",
      "DripOverMonths": 18,
      "FollowUpQuestions": "string",
      "IsActive": false,
      "Name": "string",
      "RecurringEveryMonths": 29,
      "SegmentIds": "string",
      "Settings@odata.navigationLink": "https://marketingpony.us1app.churnzero.net/public/v1/Survey(2)/Settings",
      "SurveyQuestion": "string",
      "SurveyType": "string"
    }
  ],
  "@odata.nextLink": "https://marketingpony.us1app.churnzero.net/public/v1/Survey?$skiptoken=eyJmIjpbeyJuIjoiSWQiLCJ2IjoiMTU0NDgifV0sIm8iOjR9"
}

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 number	Show only the first n items
	$skip number	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://marketingpony.us1app.churnzero.net/public/v1/Survey(2)" \
-H "Authorization: Basic c29tZXVzZXI6c3VwM3JTM2NyMzch"

200 response

{
  "Id": 2,
  "CampaignStatus": "string",
  "CampaignType": "string",
  "DripOverMonths": 18,
  "FollowUpQuestions": "string",
  "IsActive": false,
  "Name": "string",
  "RecurringEveryMonths": 29,
  "SegmentIds": "string",
  "Settings@odata.navigationLink": "https://marketingpony.us1app.churnzero.net/public/v1/Survey(2)/Settings",
  "SurveyQuestion": "string",
  "SurveyType": "string"
}

Parameters

	Name	Description
	Id number(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

GET/SurveyResponse
GET/SurveyResponse({Id})
GET/SurveyResponse({Id})/Account
GET/SurveyResponse({Id})/Contact
GET/SurveyResponse({Id})/Survey

Survey response collected in ChurnZero for a Survey.

Permissions

Bulk Read - Surveys

Get all SurveyResponses

GET /SurveyResponse

Code samples

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

200 response

{
  "value": [
    {
      "Id": 3,
      "AccountId": 5,
      "Comment": "string",
      "ContactId": 1,
      "FollowUpAnswerType": "string",
      "FollowUpQuestion": "string",
      "FollowUpResponse": "string",
      "NextReminderDate": "2025-10-18T14:00:33.2709092Z",
      "ResponseDate": "2025-10-18T14:00:33.2709092Z",
      "ResponseSource": "string",
      "Score": 13,
      "SurveyId": 29,
      "Account@odata.navigationLink": "https://marketingpony.us1app.churnzero.net/public/v1/SurveyResponse(3)/Account",
      "Contact@odata.navigationLink": "https://marketingpony.us1app.churnzero.net/public/v1/SurveyResponse(3)/Contact",
      "Survey@odata.navigationLink": "https://marketingpony.us1app.churnzero.net/public/v1/SurveyResponse(3)/Survey"
    }
  ],
  "@odata.nextLink": "https://marketingpony.us1app.churnzero.net/public/v1/SurveyResponse?$skiptoken=eyJmIjpbeyJuIjoiSWQiLCJ2IjoiMjYzMjEifV0sIm8iOjR9"
}

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 number	Show only the first n items
	$skip number	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://marketingpony.us1app.churnzero.net/public/v1/SurveyResponse(3)" \
-H "Authorization: Basic c29tZXVzZXI6c3VwM3JTM2NyMzch"

200 response

{
  "Id": 3,
  "AccountId": 5,
  "Comment": "string",
  "ContactId": 1,
  "FollowUpAnswerType": "string",
  "FollowUpQuestion": "string",
  "FollowUpResponse": "string",
  "NextReminderDate": "2025-10-18T14:00:33.2709092Z",
  "ResponseDate": "2025-10-18T14:00:33.2709092Z",
  "ResponseSource": "string",
  "Score": 13,
  "SurveyId": 29,
  "Account@odata.navigationLink": "https://marketingpony.us1app.churnzero.net/public/v1/SurveyResponse(3)/Account",
  "Contact@odata.navigationLink": "https://marketingpony.us1app.churnzero.net/public/v1/SurveyResponse(3)/Contact",
  "Survey@odata.navigationLink": "https://marketingpony.us1app.churnzero.net/public/v1/SurveyResponse(3)/Survey"
}

Parameters

	Name	Description
	Id number(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://marketingpony.us1app.churnzero.net/public/v1/SurveyResponse(3)/Account" \
-H "Authorization: Basic c29tZXVzZXI6c3VwM3JTM2NyMzch"

200 response

{
  "Id": 5,
  "BillingAddressCity": "string",
  "BillingAddressCountry": "string",
  "BillingAddressLine1": "string",
  "BillingAddressLine2": "string",
  "BillingAddressState": "string",
  "BillingAddressZip": "string",
  "ContactsCount": 16,
  "CrmId": "string",
  "DirectParentAccountId": 25,
  "EndDate": "2025-10-18T14:00:32.3288567Z",
  "ExternalId": "string",
  "IsActive": false,
  "LicenseCount": 20,
  "Name": "string",
  "NextRenewalDate": "2025-10-18T14:00:32.3288567Z",
  "ObjectCreatedDate": "2025-10-18T14:00:32.3288567Z",
  "ObjectLastModifiedDate": "2025-10-18T14:00:32.3288567Z",
  "ParentAccountId": 4,
  "ParentNextRenewalDate": "2025-10-18T14:00:32.3288567Z",
  "ParentTotalContractAmount": "string",
  "PrimaryChurnScoreId": 9,
  "PrimaryChurnScoreValue": "string",
  "StartDate": "2025-10-18T14:00:32.3288567Z",
  "Tags": "string",
  "TenureInDays": 18,
  "TotalContractAmount": "string",
  "UltimateParentAccountId": 18,
  "UsageFrequency": "string",
  "UserAccountId": 8,
  "PrimaryChurnScore@odata.navigationLink": "https://marketingpony.us1app.churnzero.net/public/v1/Account(5)/PrimaryChurnScore",
  "ParentAccount@odata.navigationLink": "https://marketingpony.us1app.churnzero.net/public/v1/Account(5)/ParentAccount",
  "UserAccount@odata.navigationLink": "https://marketingpony.us1app.churnzero.net/public/v1/Account(5)/UserAccount",
  "DirectParentAccount@odata.navigationLink": "https://marketingpony.us1app.churnzero.net/public/v1/Account(5)/DirectParentAccount",
  "UltimateParentAccount@odata.navigationLink": "https://marketingpony.us1app.churnzero.net/public/v1/Account(5)/UltimateParentAccount"
}

Parameters

	Name	Description
	Id number(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, DirectParentAccountId, UltimateParentAccountId, Tags, ObjectCreatedDate, ObjectLastModifiedDate
↓ Show Options ↓			↑ Hide Options ↑
	$expand array[string]	Expand related entities
*, DirectParentAccount, ParentAccount, PrimaryChurnScore, UltimateParentAccount, 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://marketingpony.us1app.churnzero.net/public/v1/SurveyResponse(3)/Contact" \
-H "Authorization: Basic c29tZXVzZXI6c3VwM3JTM2NyMzch"

200 response

{
  "Id": 8,
  "AccountId": 1,
  "CrmId": "string",
  "Email": "string",
  "ExternalId": "string",
  "FirstName": "string",
  "FullName": "string",
  "LastName": "string",
  "MarketingEmailUnsubscribed": false,
  "Name": "string",
  "ObjectCreatedDate": "2025-10-18T14:00:32.4605244Z",
  "ObjectLastModifiedDate": "2025-10-18T14:00:32.4605244Z",
  "Tags": "string",
  "Account@odata.navigationLink": "https://marketingpony.us1app.churnzero.net/public/v1/Contact(8)/Account"
}

Parameters

	Name	Description
	Id number(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
↓ 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://marketingpony.us1app.churnzero.net/public/v1/SurveyResponse(3)/Survey" \
-H "Authorization: Basic c29tZXVzZXI6c3VwM3JTM2NyMzch"

200 response

{
  "Id": 2,
  "CampaignStatus": "string",
  "CampaignType": "string",
  "DripOverMonths": 18,
  "FollowUpQuestions": "string",
  "IsActive": false,
  "Name": "string",
  "RecurringEveryMonths": 29,
  "SegmentIds": "string",
  "Settings@odata.navigationLink": "https://marketingpony.us1app.churnzero.net/public/v1/Survey(2)/Settings",
  "SurveyQuestion": "string",
  "SurveyType": "string"
}

Parameters

	Name	Description
	Id number(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

GET/ChurnScore
GET/ChurnScore({Id})

Churn Score available in ChurnZero.

Permissions

Bulk Read - Churn Scores

Get all ChurnScores

GET /ChurnScore

Code samples

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

200 response

{
  "value": [
    {
      "Id": 6,
      "GradingBottom": "string",
      "GradingTop": "string",
      "Name": "string"
    }
  ],
  "@odata.nextLink": "https://marketingpony.us1app.churnzero.net/public/v1/ChurnScore?$skiptoken=eyJmIjpbeyJuIjoiSWQiLCJ2IjoiMjY4NzIifV0sIm8iOjR9"
}

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
Id, 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 number	Show only the first n items
	$skip number	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://marketingpony.us1app.churnzero.net/public/v1/ChurnScore(6)" \
-H "Authorization: Basic c29tZXVzZXI6c3VwM3JTM2NyMzch"

200 response

{
  "Id": 6,
  "GradingBottom": "string",
  "GradingTop": "string",
  "Name": "string"
}

Parameters

	Name	Description
	Id number(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

GET/ChurnScoreFactor
GET/ChurnScoreFactor({Id})
GET/ChurnScoreFactor({Id})/ChurnScore
GET/ChurnScoreFactor({Id})/Journey

Churn Score Factor available in ChurnZero.

Permissions

Bulk Read - Churn Scores

Get all ChurnScoreFactors

GET /ChurnScoreFactor

Code samples

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

200 response

{
  "value": [
    {
      "Id": 4,
      "ChurnScoreFactorType": "string",
      "ChurnScoreId": 6,
      "Name": "string",
      "Journey@odata.navigationLink": "https://marketingpony.us1app.churnzero.net/public/v1/ChurnScoreFactor(4)/Journey",
      "ChurnScore@odata.navigationLink": "https://marketingpony.us1app.churnzero.net/public/v1/ChurnScoreFactor(4)/ChurnScore"
    }
  ],
  "@odata.nextLink": "https://marketingpony.us1app.churnzero.net/public/v1/ChurnScoreFactor?$skiptoken=eyJmIjpbeyJuIjoiSWQiLCJ2IjoiMTQ0MjkifV0sIm8iOjR9"
}

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
Id, 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, Journey
↓ Show Options ↓			↑ Hide Options ↑
	$top number	Show only the first n items
	$skip number	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://marketingpony.us1app.churnzero.net/public/v1/ChurnScoreFactor(4)" \
-H "Authorization: Basic c29tZXVzZXI6c3VwM3JTM2NyMzch"

200 response

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

Parameters

	Name	Description
	Id number(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, Journey
↓ 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://marketingpony.us1app.churnzero.net/public/v1/ChurnScoreFactor(4)/ChurnScore" \
-H "Authorization: Basic c29tZXVzZXI6c3VwM3JTM2NyMzch"

200 response

{
  "Id": 6,
  "GradingBottom": "string",
  "GradingTop": "string",
  "Name": "string"
}

Parameters

	Name	Description
	Id number(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

Get the Journey

GET /ChurnScoreFactor({Id})/Journey

Code samples

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

200 response

{
  "Id": 9,
  "Description": "string",
  "ExpectedDuration": 13,
  "IsActive": false,
  "IsSharedExternally": true,
  "Name": "string",
  "ObjectCreatedDate": "2025-10-18T14:00:33.2710428Z",
  "ObjectLastModifiedDate": "2025-10-18T14:00:33.2710428Z",
  "ProgressBottom": 12,
  "ProgressTop": 9,
  "Status": "string"
}

Parameters

	Name	Description
	Id number(int64)	Id of the ChurnScoreFactor
	$select array[string]	Select properties to be returned
Id, Name, Description, IsActive, Status, ObjectCreatedDate, ObjectLastModifiedDate, IsSharedExternally, ExpectedDuration, ProgressTop, ProgressBottom
↓ Show Options ↓			↑ Hide Options ↑
	$expand array[string]	Expand related entities
*
↓ Show Options ↓			↑ Hide Options ↑

Responses

	Status	Description
	200 Journey	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

GET/ChurnScoreCalculation
GET/ChurnScoreCalculation({Id})
GET/ChurnScoreCalculation({Id})/Account
GET/ChurnScoreCalculation({Id})/ChurnScore

Churn Score Calculation available in ChurnZero.

Permissions

Bulk Read - Churn Scores

Get all ChurnScoreCalculations

GET /ChurnScoreCalculation

Code samples

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

200 response

{
  "value": [
    {
      "Id": 7,
      "AccountId": 22,
      "CalculationDay": "2025-10-18",
      "ChurnScoreId": 2,
      "IsActive": false,
      "IsPrimary": true,
      "Score": "string",
      "Account@odata.navigationLink": "https://marketingpony.us1app.churnzero.net/public/v1/ChurnScoreCalculation(7)/Account",
      "ChurnScore@odata.navigationLink": "https://marketingpony.us1app.churnzero.net/public/v1/ChurnScoreCalculation(7)/ChurnScore"
    }
  ],
  "@odata.nextLink": "https://marketingpony.us1app.churnzero.net/public/v1/ChurnScoreCalculation?$skiptoken=eyJmIjpbeyJuIjoiSWQiLCJ2IjoiNTk0NCJ9XSwibyI6NH0"
}

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
Id, 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 number	Show only the first n items
	$skip number	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://marketingpony.us1app.churnzero.net/public/v1/ChurnScoreCalculation(7)" \
-H "Authorization: Basic c29tZXVzZXI6c3VwM3JTM2NyMzch"

200 response

{
  "Id": 7,
  "AccountId": 22,
  "CalculationDay": "2025-10-18",
  "ChurnScoreId": 2,
  "IsActive": false,
  "IsPrimary": true,
  "Score": "string",
  "Account@odata.navigationLink": "https://marketingpony.us1app.churnzero.net/public/v1/ChurnScoreCalculation(7)/Account",
  "ChurnScore@odata.navigationLink": "https://marketingpony.us1app.churnzero.net/public/v1/ChurnScoreCalculation(7)/ChurnScore"
}

Parameters

	Name	Description
	Id number(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://marketingpony.us1app.churnzero.net/public/v1/ChurnScoreCalculation(7)/Account" \
-H "Authorization: Basic c29tZXVzZXI6c3VwM3JTM2NyMzch"

200 response

{
  "Id": 5,
  "BillingAddressCity": "string",
  "BillingAddressCountry": "string",
  "BillingAddressLine1": "string",
  "BillingAddressLine2": "string",
  "BillingAddressState": "string",
  "BillingAddressZip": "string",
  "ContactsCount": 16,
  "CrmId": "string",
  "DirectParentAccountId": 25,
  "EndDate": "2025-10-18T14:00:32.3288567Z",
  "ExternalId": "string",
  "IsActive": false,
  "LicenseCount": 20,
  "Name": "string",
  "NextRenewalDate": "2025-10-18T14:00:32.3288567Z",
  "ObjectCreatedDate": "2025-10-18T14:00:32.3288567Z",
  "ObjectLastModifiedDate": "2025-10-18T14:00:32.3288567Z",
  "ParentAccountId": 4,
  "ParentNextRenewalDate": "2025-10-18T14:00:32.3288567Z",
  "ParentTotalContractAmount": "string",
  "PrimaryChurnScoreId": 9,
  "PrimaryChurnScoreValue": "string",
  "StartDate": "2025-10-18T14:00:32.3288567Z",
  "Tags": "string",
  "TenureInDays": 18,
  "TotalContractAmount": "string",
  "UltimateParentAccountId": 18,
  "UsageFrequency": "string",
  "UserAccountId": 8,
  "PrimaryChurnScore@odata.navigationLink": "https://marketingpony.us1app.churnzero.net/public/v1/Account(5)/PrimaryChurnScore",
  "ParentAccount@odata.navigationLink": "https://marketingpony.us1app.churnzero.net/public/v1/Account(5)/ParentAccount",
  "UserAccount@odata.navigationLink": "https://marketingpony.us1app.churnzero.net/public/v1/Account(5)/UserAccount",
  "DirectParentAccount@odata.navigationLink": "https://marketingpony.us1app.churnzero.net/public/v1/Account(5)/DirectParentAccount",
  "UltimateParentAccount@odata.navigationLink": "https://marketingpony.us1app.churnzero.net/public/v1/Account(5)/UltimateParentAccount"
}

Parameters

	Name	Description
	Id number(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, DirectParentAccountId, UltimateParentAccountId, Tags, ObjectCreatedDate, ObjectLastModifiedDate
↓ Show Options ↓			↑ Hide Options ↑
	$expand array[string]	Expand related entities
*, DirectParentAccount, ParentAccount, PrimaryChurnScore, UltimateParentAccount, 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://marketingpony.us1app.churnzero.net/public/v1/ChurnScoreCalculation(7)/ChurnScore" \
-H "Authorization: Basic c29tZXVzZXI6c3VwM3JTM2NyMzch"

200 response

{
  "Id": 6,
  "GradingBottom": "string",
  "GradingTop": "string",
  "Name": "string"
}

Parameters

	Name	Description
	Id number(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

GET/ChurnScoreFactorCalculation
GET/ChurnScoreFactorCalculation({Id})
GET/ChurnScoreFactorCalculation({Id})/Account
GET/ChurnScoreFactorCalculation({Id})/ChurnScore
GET/ChurnScoreFactorCalculation({Id})/ChurnScoreFactor

Churn Score Factor Calculation available in ChurnZero.

Permissions

Bulk Read - Churn Scores

Get all ChurnScoreFactorCalculations

GET /ChurnScoreFactorCalculation

Code samples

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

200 response

{
  "value": [
    {
      "Id": 1,
      "AccountId": 19,
      "CalculationDay": "2025-10-18",
      "ChurnScoreFactorId": 9,
      "ChurnScoreId": 27,
      "Score": "string",
      "Account@odata.navigationLink": "https://marketingpony.us1app.churnzero.net/public/v1/ChurnScoreFactorCalculation(1)/Account",
      "ChurnScore@odata.navigationLink": "https://marketingpony.us1app.churnzero.net/public/v1/ChurnScoreFactorCalculation(1)/ChurnScore",
      "ChurnScoreFactor@odata.navigationLink": "https://marketingpony.us1app.churnzero.net/public/v1/ChurnScoreFactorCalculation(1)/ChurnScoreFactor"
    }
  ],
  "@odata.nextLink": "https://marketingpony.us1app.churnzero.net/public/v1/ChurnScoreFactorCalculation?$skiptoken=eyJmIjpbeyJuIjoiSWQiLCJ2IjoiODYxMSJ9XSwibyI6NH0"
}

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
Id, 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 number	Show only the first n items
	$skip number	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://marketingpony.us1app.churnzero.net/public/v1/ChurnScoreFactorCalculation(1)" \
-H "Authorization: Basic c29tZXVzZXI6c3VwM3JTM2NyMzch"

200 response

{
  "Id": 1,
  "AccountId": 19,
  "CalculationDay": "2025-10-18",
  "ChurnScoreFactorId": 9,
  "ChurnScoreId": 27,
  "Score": "string",
  "Account@odata.navigationLink": "https://marketingpony.us1app.churnzero.net/public/v1/ChurnScoreFactorCalculation(1)/Account",
  "ChurnScore@odata.navigationLink": "https://marketingpony.us1app.churnzero.net/public/v1/ChurnScoreFactorCalculation(1)/ChurnScore",
  "ChurnScoreFactor@odata.navigationLink": "https://marketingpony.us1app.churnzero.net/public/v1/ChurnScoreFactorCalculation(1)/ChurnScoreFactor"
}

Parameters

	Name	Description
	Id number(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://marketingpony.us1app.churnzero.net/public/v1/ChurnScoreFactorCalculation(1)/Account" \
-H "Authorization: Basic c29tZXVzZXI6c3VwM3JTM2NyMzch"

200 response

{
  "Id": 5,
  "BillingAddressCity": "string",
  "BillingAddressCountry": "string",
  "BillingAddressLine1": "string",
  "BillingAddressLine2": "string",
  "BillingAddressState": "string",
  "BillingAddressZip": "string",
  "ContactsCount": 16,
  "CrmId": "string",
  "DirectParentAccountId": 25,
  "EndDate": "2025-10-18T14:00:32.3288567Z",
  "ExternalId": "string",
  "IsActive": false,
  "LicenseCount": 20,
  "Name": "string",
  "NextRenewalDate": "2025-10-18T14:00:32.3288567Z",
  "ObjectCreatedDate": "2025-10-18T14:00:32.3288567Z",
  "ObjectLastModifiedDate": "2025-10-18T14:00:32.3288567Z",
  "ParentAccountId": 4,
  "ParentNextRenewalDate": "2025-10-18T14:00:32.3288567Z",
  "ParentTotalContractAmount": "string",
  "PrimaryChurnScoreId": 9,
  "PrimaryChurnScoreValue": "string",
  "StartDate": "2025-10-18T14:00:32.3288567Z",
  "Tags": "string",
  "TenureInDays": 18,
  "TotalContractAmount": "string",
  "UltimateParentAccountId": 18,
  "UsageFrequency": "string",
  "UserAccountId": 8,
  "PrimaryChurnScore@odata.navigationLink": "https://marketingpony.us1app.churnzero.net/public/v1/Account(5)/PrimaryChurnScore",
  "ParentAccount@odata.navigationLink": "https://marketingpony.us1app.churnzero.net/public/v1/Account(5)/ParentAccount",
  "UserAccount@odata.navigationLink": "https://marketingpony.us1app.churnzero.net/public/v1/Account(5)/UserAccount",
  "DirectParentAccount@odata.navigationLink": "https://marketingpony.us1app.churnzero.net/public/v1/Account(5)/DirectParentAccount",
  "UltimateParentAccount@odata.navigationLink": "https://marketingpony.us1app.churnzero.net/public/v1/Account(5)/UltimateParentAccount"
}

Parameters

	Name	Description
	Id number(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, DirectParentAccountId, UltimateParentAccountId, Tags, ObjectCreatedDate, ObjectLastModifiedDate
↓ Show Options ↓			↑ Hide Options ↑
	$expand array[string]	Expand related entities
*, DirectParentAccount, ParentAccount, PrimaryChurnScore, UltimateParentAccount, 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://marketingpony.us1app.churnzero.net/public/v1/ChurnScoreFactorCalculation(1)/ChurnScore" \
-H "Authorization: Basic c29tZXVzZXI6c3VwM3JTM2NyMzch"

200 response

{
  "Id": 6,
  "GradingBottom": "string",
  "GradingTop": "string",
  "Name": "string"
}

Parameters

	Name	Description
	Id number(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://marketingpony.us1app.churnzero.net/public/v1/ChurnScoreFactorCalculation(1)/ChurnScoreFactor" \
-H "Authorization: Basic c29tZXVzZXI6c3VwM3JTM2NyMzch"

200 response

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

Parameters

	Name	Description
	Id number(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, Journey
↓ 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

Journey

GET/Journey
GET/Journey({Id})

Journey definition available in ChurnZero.

Permissions

Bulk Read - Journeys

Get all Journeys

GET /Journey

Code samples

curl -X GET "https://marketingpony.us1app.churnzero.net/public/v1/Journey" \
-H "Authorization: Basic c29tZXVzZXI6c3VwM3JTM2NyMzch"

200 response

{
  "value": [
    {
      "Id": 9,
      "Description": "string",
      "ExpectedDuration": 13,
      "IsActive": false,
      "IsSharedExternally": true,
      "Name": "string",
      "ObjectCreatedDate": "2025-10-18T14:00:33.2710428Z",
      "ObjectLastModifiedDate": "2025-10-18T14:00:33.2710428Z",
      "ProgressBottom": 12,
      "ProgressTop": 9,
      "Status": "string"
    }
  ],
  "@odata.nextLink": "https://marketingpony.us1app.churnzero.net/public/v1/Journey?$skiptoken=eyJmIjpbeyJuIjoiSWQiLCJ2IjoiMjk2OTMifV0sIm8iOjR9"
}

Parameters

	Name	Description
	$filter array[string]	Filter items by property values
Id, Name, IsActive, ObjectCreatedDate, ObjectLastModifiedDate, IsSharedExternally
↓ Show Options ↓			↑ Hide Options ↑
	$orderby array[string]	Order items by property values
Id, Name, ObjectCreatedDate, ObjectLastModifiedDate
↓ Show Options ↓			↑ Hide Options ↑
	$select array[string]	Select properties to be returned
Id, Name, Description, IsActive, Status, ObjectCreatedDate, ObjectLastModifiedDate, IsSharedExternally, ExpectedDuration, ProgressTop, ProgressBottom
↓ Show Options ↓			↑ Hide Options ↑
	$expand array[string]	Expand related entities
*
↓ Show Options ↓			↑ Hide Options ↑
	$top number	Show only the first n items
	$skip number	Skip the first n items
	$count boolean	Include count of items

Responses

	Status	Description
	200 array[Journey]	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 Journey

GET /Journey({Id})

Code samples

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

200 response

{
  "Id": 9,
  "Description": "string",
  "ExpectedDuration": 13,
  "IsActive": false,
  "IsSharedExternally": true,
  "Name": "string",
  "ObjectCreatedDate": "2025-10-18T14:00:33.2710428Z",
  "ObjectLastModifiedDate": "2025-10-18T14:00:33.2710428Z",
  "ProgressBottom": 12,
  "ProgressTop": 9,
  "Status": "string"
}

Parameters

	Name	Description
	Id number(int64)	Id of the Journey
	$select array[string]	Select properties to be returned
Id, Name, Description, IsActive, Status, ObjectCreatedDate, ObjectLastModifiedDate, IsSharedExternally, ExpectedDuration, ProgressTop, ProgressBottom
↓ Show Options ↓			↑ Hide Options ↑
	$expand array[string]	Expand related entities
*
↓ Show Options ↓			↑ Hide Options ↑

Responses

	Status	Description
	200 Journey	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

JourneyMilestone

GET/JourneyMilestone
GET/JourneyMilestone({Id})
GET/JourneyMilestone({Id})/Journey

JourneyMilestone definition available in ChurnZero.

Permissions

Bulk Read - Journeys

Get all JourneyMilestones

GET /JourneyMilestone

Code samples

curl -X GET "https://marketingpony.us1app.churnzero.net/public/v1/JourneyMilestone" \
-H "Authorization: Basic c29tZXVzZXI6c3VwM3JTM2NyMzch"

200 response

{
  "value": [
    {
      "Id": 4,
      "Description": "string",
      "ExpectedDuration": 15,
      "JourneyId": 29,
      "Name": "string",
      "ObjectCreatedDate": "2025-10-18T14:00:33.2710605Z",
      "ObjectLastModifiedDate": "2025-10-18T14:00:33.2710605Z",
      "ProgressBottom": 7,
      "ProgressTop": 16,
      "Journey@odata.navigationLink": "https://marketingpony.us1app.churnzero.net/public/v1/JourneyMilestone(4)/Journey"
    }
  ],
  "@odata.nextLink": "https://marketingpony.us1app.churnzero.net/public/v1/JourneyMilestone?$skiptoken=eyJmIjpbeyJuIjoiSWQiLCJ2IjoiMTY1OTQifV0sIm8iOjR9"
}

Parameters

	Name	Description
	$filter array[string]	Filter items by property values
Id, Name, JourneyId, ObjectCreatedDate, ObjectLastModifiedDate
↓ Show Options ↓			↑ Hide Options ↑
	$orderby array[string]	Order items by property values
Id, Name, ObjectCreatedDate, ObjectLastModifiedDate
↓ Show Options ↓			↑ Hide Options ↑
	$select array[string]	Select properties to be returned
Id, Name, Description, JourneyId, ExpectedDuration, ProgressTop, ProgressBottom, ObjectCreatedDate, ObjectLastModifiedDate
↓ Show Options ↓			↑ Hide Options ↑
	$expand array[string]	Expand related entities
*, Journey
↓ Show Options ↓			↑ Hide Options ↑
	$top number	Show only the first n items
	$skip number	Skip the first n items
	$count boolean	Include count of items

Responses

	Status	Description
	200 array[JourneyMilestone]	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 JourneyMilestone

GET /JourneyMilestone({Id})

Code samples

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

200 response

{
  "Id": 4,
  "Description": "string",
  "ExpectedDuration": 15,
  "JourneyId": 29,
  "Name": "string",
  "ObjectCreatedDate": "2025-10-18T14:00:33.2710605Z",
  "ObjectLastModifiedDate": "2025-10-18T14:00:33.2710605Z",
  "ProgressBottom": 7,
  "ProgressTop": 16,
  "Journey@odata.navigationLink": "https://marketingpony.us1app.churnzero.net/public/v1/JourneyMilestone(4)/Journey"
}

Parameters

	Name	Description
	Id number(int64)	Id of the JourneyMilestone
	$select array[string]	Select properties to be returned
Id, Name, Description, JourneyId, ExpectedDuration, ProgressTop, ProgressBottom, ObjectCreatedDate, ObjectLastModifiedDate
↓ Show Options ↓			↑ Hide Options ↑
	$expand array[string]	Expand related entities
*, Journey
↓ Show Options ↓			↑ Hide Options ↑

Responses

	Status	Description
	200 JourneyMilestone	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 Journey

GET /JourneyMilestone({Id})/Journey

Code samples

curl -X GET "https://marketingpony.us1app.churnzero.net/public/v1/JourneyMilestone(4)/Journey" \
-H "Authorization: Basic c29tZXVzZXI6c3VwM3JTM2NyMzch"

200 response

{
  "Id": 9,
  "Description": "string",
  "ExpectedDuration": 13,
  "IsActive": false,
  "IsSharedExternally": true,
  "Name": "string",
  "ObjectCreatedDate": "2025-10-18T14:00:33.2710428Z",
  "ObjectLastModifiedDate": "2025-10-18T14:00:33.2710428Z",
  "ProgressBottom": 12,
  "ProgressTop": 9,
  "Status": "string"
}

Parameters

	Name	Description
	Id number(int64)	Id of the JourneyMilestone
	$select array[string]	Select properties to be returned
Id, Name, Description, IsActive, Status, ObjectCreatedDate, ObjectLastModifiedDate, IsSharedExternally, ExpectedDuration, ProgressTop, ProgressBottom
↓ Show Options ↓			↑ Hide Options ↑
	$expand array[string]	Expand related entities
*
↓ Show Options ↓			↑ Hide Options ↑

Responses

	Status	Description
	200 Journey	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

JourneyMilestoneAchievement

GET/JourneyMilestoneAchievement
GET/JourneyMilestoneAchievement({Id})
GET/JourneyMilestoneAchievement({Id})/JourneyMilestone

JourneyMilestoneAchievement definition available in ChurnZero. This is the template that is used to create an Achievement instance for Accounts that enter the JourneyMilestone.

Permissions

Bulk Read - Journeys

Get all JourneyMilestoneAchievements

GET /JourneyMilestoneAchievement

Code samples

curl -X GET "https://marketingpony.us1app.churnzero.net/public/v1/JourneyMilestoneAchievement" \
-H "Authorization: Basic c29tZXVzZXI6c3VwM3JTM2NyMzch"

200 response

{
  "value": [
    {
      "Id": 5,
      "IsConditional": true,
      "IsExternallyVisible": false,
      "IsOptional": true,
      "JourneyMilestoneId": 8,
      "Name": "string",
      "ObjectCreatedDate": "2025-10-18T14:00:33.2710781Z",
      "ObjectLastModifiedDate": "2025-10-18T14:00:33.2710781Z",
      "JourneyMilestone@odata.navigationLink": "https://marketingpony.us1app.churnzero.net/public/v1/JourneyMilestoneAchievement(5)/JourneyMilestone"
    }
  ],
  "@odata.nextLink": "https://marketingpony.us1app.churnzero.net/public/v1/JourneyMilestoneAchievement?$skiptoken=eyJmIjpbeyJuIjoiSWQiLCJ2IjoiMjY5NzUifV0sIm8iOjR9"
}

Parameters

	Name	Description
	$filter array[string]	Filter items by property values
Id, Name, JourneyMilestoneId, IsOptional, IsExternallyVisible, IsConditional, ObjectCreatedDate, ObjectLastModifiedDate
↓ Show Options ↓			↑ Hide Options ↑
	$orderby array[string]	Order items by property values
Id, Name, ObjectCreatedDate, ObjectLastModifiedDate
↓ Show Options ↓			↑ Hide Options ↑
	$select array[string]	Select properties to be returned
Id, Name, IsOptional, IsConditional, IsExternallyVisible, JourneyMilestoneId, ObjectCreatedDate, ObjectLastModifiedDate
↓ Show Options ↓			↑ Hide Options ↑
	$expand array[string]	Expand related entities
*, JourneyMilestone
↓ Show Options ↓			↑ Hide Options ↑
	$top number	Show only the first n items
	$skip number	Skip the first n items
	$count boolean	Include count of items

Responses

	Status	Description
	200 array[JourneyMilestoneAchievement]	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 JourneyMilestoneAchievement

GET /JourneyMilestoneAchievement({Id})

Code samples

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

200 response

{
  "Id": 5,
  "IsConditional": true,
  "IsExternallyVisible": false,
  "IsOptional": true,
  "JourneyMilestoneId": 8,
  "Name": "string",
  "ObjectCreatedDate": "2025-10-18T14:00:33.2710781Z",
  "ObjectLastModifiedDate": "2025-10-18T14:00:33.2710781Z",
  "JourneyMilestone@odata.navigationLink": "https://marketingpony.us1app.churnzero.net/public/v1/JourneyMilestoneAchievement(5)/JourneyMilestone"
}

Parameters

	Name	Description
	Id number(int64)	Id of the JourneyMilestoneAchievement
	$select array[string]	Select properties to be returned
Id, Name, IsOptional, IsConditional, IsExternallyVisible, JourneyMilestoneId, ObjectCreatedDate, ObjectLastModifiedDate
↓ Show Options ↓			↑ Hide Options ↑
	$expand array[string]	Expand related entities
*, JourneyMilestone
↓ Show Options ↓			↑ Hide Options ↑

Responses

	Status	Description
	200 JourneyMilestoneAchievement	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 JourneyMilestone

GET /JourneyMilestoneAchievement({Id})/JourneyMilestone

Code samples

curl -X GET "https://marketingpony.us1app.churnzero.net/public/v1/JourneyMilestoneAchievement(5)/JourneyMilestone" \
-H "Authorization: Basic c29tZXVzZXI6c3VwM3JTM2NyMzch"

200 response

{
  "Id": 4,
  "Description": "string",
  "ExpectedDuration": 15,
  "JourneyId": 29,
  "Name": "string",
  "ObjectCreatedDate": "2025-10-18T14:00:33.2710605Z",
  "ObjectLastModifiedDate": "2025-10-18T14:00:33.2710605Z",
  "ProgressBottom": 7,
  "ProgressTop": 16,
  "Journey@odata.navigationLink": "https://marketingpony.us1app.churnzero.net/public/v1/JourneyMilestone(4)/Journey"
}

Parameters

	Name	Description
	Id number(int64)	Id of the JourneyMilestoneAchievement
	$select array[string]	Select properties to be returned
Id, Name, Description, JourneyId, ExpectedDuration, ProgressTop, ProgressBottom, ObjectCreatedDate, ObjectLastModifiedDate
↓ Show Options ↓			↑ Hide Options ↑
	$expand array[string]	Expand related entities
*, Journey
↓ Show Options ↓			↑ Hide Options ↑

Responses

	Status	Description
	200 JourneyMilestone	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

JourneyMilestoneTask

GET/JourneyMilestoneTask
GET/JourneyMilestoneTask({Id})
GET/JourneyMilestoneTask({Id})/JourneyMilestone

JourneyMilestoneTask definition available in ChurnZero. This is the template that is used to create a Task instance for Accounts that enter the JourneyMilestone.

Permissions

Bulk Read - Journeys

Get all JourneyMilestoneTasks

GET /JourneyMilestoneTask

Code samples

curl -X GET "https://marketingpony.us1app.churnzero.net/public/v1/JourneyMilestoneTask" \
-H "Authorization: Basic c29tZXVzZXI6c3VwM3JTM2NyMzch"

200 response

{
  "value": [
    {
      "Id": 3,
      "IsConditional": false,
      "IsExternallyVisible": false,
      "IsOptional": false,
      "JourneyMilestoneId": 28,
      "ObjectCreatedDate": "2025-10-18T14:00:33.2710947Z",
      "ObjectLastModifiedDate": "2025-10-18T14:00:33.2710947Z",
      "Subject": "string",
      "JourneyMilestone@odata.navigationLink": "https://marketingpony.us1app.churnzero.net/public/v1/JourneyMilestoneTask(3)/JourneyMilestone"
    }
  ],
  "@odata.nextLink": "https://marketingpony.us1app.churnzero.net/public/v1/JourneyMilestoneTask?$skiptoken=eyJmIjpbeyJuIjoiSWQiLCJ2IjoiMTUxMzMifV0sIm8iOjR9"
}

Parameters

	Name	Description
	$filter array[string]	Filter items by property values
Id, Subject, JourneyMilestoneId, IsOptional, IsConditional, IsExternallyVisible, ObjectCreatedDate, ObjectLastModifiedDate
↓ Show Options ↓			↑ Hide Options ↑
	$orderby array[string]	Order items by property values
Id, Subject, ObjectCreatedDate, ObjectLastModifiedDate
↓ Show Options ↓			↑ Hide Options ↑
	$select array[string]	Select properties to be returned
Id, Subject, JourneyMilestoneId, IsOptional, IsConditional, IsExternallyVisible, ObjectCreatedDate, ObjectLastModifiedDate
↓ Show Options ↓			↑ Hide Options ↑
	$expand array[string]	Expand related entities
*, JourneyMilestone
↓ Show Options ↓			↑ Hide Options ↑
	$top number	Show only the first n items
	$skip number	Skip the first n items
	$count boolean	Include count of items

Responses

	Status	Description
	200 array[JourneyMilestoneTask]	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 JourneyMilestoneTask

GET /JourneyMilestoneTask({Id})

Code samples

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

200 response

{
  "Id": 3,
  "IsConditional": false,
  "IsExternallyVisible": false,
  "IsOptional": false,
  "JourneyMilestoneId": 28,
  "ObjectCreatedDate": "2025-10-18T14:00:33.2710947Z",
  "ObjectLastModifiedDate": "2025-10-18T14:00:33.2710947Z",
  "Subject": "string",
  "JourneyMilestone@odata.navigationLink": "https://marketingpony.us1app.churnzero.net/public/v1/JourneyMilestoneTask(3)/JourneyMilestone"
}

Parameters

	Name	Description
	Id number(int64)	Id of the JourneyMilestoneTask
	$select array[string]	Select properties to be returned
Id, Subject, JourneyMilestoneId, IsOptional, IsConditional, IsExternallyVisible, ObjectCreatedDate, ObjectLastModifiedDate
↓ Show Options ↓			↑ Hide Options ↑
	$expand array[string]	Expand related entities
*, JourneyMilestone
↓ Show Options ↓			↑ Hide Options ↑

Responses

	Status	Description
	200 JourneyMilestoneTask	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 JourneyMilestone

GET /JourneyMilestoneTask({Id})/JourneyMilestone

Code samples

curl -X GET "https://marketingpony.us1app.churnzero.net/public/v1/JourneyMilestoneTask(3)/JourneyMilestone" \
-H "Authorization: Basic c29tZXVzZXI6c3VwM3JTM2NyMzch"

200 response

{
  "Id": 4,
  "Description": "string",
  "ExpectedDuration": 15,
  "JourneyId": 29,
  "Name": "string",
  "ObjectCreatedDate": "2025-10-18T14:00:33.2710605Z",
  "ObjectLastModifiedDate": "2025-10-18T14:00:33.2710605Z",
  "ProgressBottom": 7,
  "ProgressTop": 16,
  "Journey@odata.navigationLink": "https://marketingpony.us1app.churnzero.net/public/v1/JourneyMilestone(4)/Journey"
}

Parameters

	Name	Description
	Id number(int64)	Id of the JourneyMilestoneTask
	$select array[string]	Select properties to be returned
Id, Name, Description, JourneyId, ExpectedDuration, ProgressTop, ProgressBottom, ObjectCreatedDate, ObjectLastModifiedDate
↓ Show Options ↓			↑ Hide Options ↑
	$expand array[string]	Expand related entities
*, Journey
↓ Show Options ↓			↑ Hide Options ↑

Responses

	Status	Description
	200 JourneyMilestone	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

JourneyInstance

GET/JourneyInstance
GET/JourneyInstance({Id})
GET/JourneyInstance({Id})/Account
GET/JourneyInstance({Id})/Journey

The JourneyInstance in ChurnZero represents a single progression of an Account through a Journey. On re-entry, the Account will be associated with a new JourneyInstance.

Permissions

Bulk Read - Journeys

Get all JourneyInstances

GET /JourneyInstance

Code samples

curl -X GET "https://marketingpony.us1app.churnzero.net/public/v1/JourneyInstance" \
-H "Authorization: Basic c29tZXVzZXI6c3VwM3JTM2NyMzch"

200 response

{
  "value": [
    {
      "Id": 6,
      "AccountId": 16,
      "JourneyId": 26,
      "StartDate": "2025-10-18T14:00:33.2711112Z",
      "Account@odata.navigationLink": "https://marketingpony.us1app.churnzero.net/public/v1/JourneyInstance(6)/Account",
      "Journey@odata.navigationLink": "https://marketingpony.us1app.churnzero.net/public/v1/JourneyInstance(6)/Journey"
    }
  ],
  "@odata.nextLink": "https://marketingpony.us1app.churnzero.net/public/v1/JourneyInstance?$skiptoken=eyJmIjpbeyJuIjoiSWQiLCJ2IjoiNzg1MCJ9XSwibyI6NH0"
}

Parameters

	Name	Description
	$filter array[string]	Filter items by property values
Id, JourneyId, AccountId, StartDate
↓ Show Options ↓			↑ Hide Options ↑
	$orderby array[string]	Order items by property values
Id, StartDate
↓ Show Options ↓			↑ Hide Options ↑
	$select array[string]	Select properties to be returned
Id, JourneyId, AccountId, StartDate
↓ Show Options ↓			↑ Hide Options ↑
	$expand array[string]	Expand related entities
*, Account, Journey
↓ Show Options ↓			↑ Hide Options ↑
	$top number	Show only the first n items
	$skip number	Skip the first n items
	$count boolean	Include count of items

Responses

	Status	Description
	200 array[JourneyInstance]	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 JourneyInstance

GET /JourneyInstance({Id})

Code samples

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

200 response

{
  "Id": 6,
  "AccountId": 16,
  "JourneyId": 26,
  "StartDate": "2025-10-18T14:00:33.2711112Z",
  "Account@odata.navigationLink": "https://marketingpony.us1app.churnzero.net/public/v1/JourneyInstance(6)/Account",
  "Journey@odata.navigationLink": "https://marketingpony.us1app.churnzero.net/public/v1/JourneyInstance(6)/Journey"
}

Parameters

	Name	Description
	Id number(int64)	Id of the JourneyInstance
	$select array[string]	Select properties to be returned
Id, JourneyId, AccountId, StartDate
↓ Show Options ↓			↑ Hide Options ↑
	$expand array[string]	Expand related entities
*, Account, Journey
↓ Show Options ↓			↑ Hide Options ↑

Responses

	Status	Description
	200 JourneyInstance	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 /JourneyInstance({Id})/Account

Code samples

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

200 response

{
  "Id": 5,
  "BillingAddressCity": "string",
  "BillingAddressCountry": "string",
  "BillingAddressLine1": "string",
  "BillingAddressLine2": "string",
  "BillingAddressState": "string",
  "BillingAddressZip": "string",
  "ContactsCount": 16,
  "CrmId": "string",
  "DirectParentAccountId": 25,
  "EndDate": "2025-10-18T14:00:32.3288567Z",
  "ExternalId": "string",
  "IsActive": false,
  "LicenseCount": 20,
  "Name": "string",
  "NextRenewalDate": "2025-10-18T14:00:32.3288567Z",
  "ObjectCreatedDate": "2025-10-18T14:00:32.3288567Z",
  "ObjectLastModifiedDate": "2025-10-18T14:00:32.3288567Z",
  "ParentAccountId": 4,
  "ParentNextRenewalDate": "2025-10-18T14:00:32.3288567Z",
  "ParentTotalContractAmount": "string",
  "PrimaryChurnScoreId": 9,
  "PrimaryChurnScoreValue": "string",
  "StartDate": "2025-10-18T14:00:32.3288567Z",
  "Tags": "string",
  "TenureInDays": 18,
  "TotalContractAmount": "string",
  "UltimateParentAccountId": 18,
  "UsageFrequency": "string",
  "UserAccountId": 8,
  "PrimaryChurnScore@odata.navigationLink": "https://marketingpony.us1app.churnzero.net/public/v1/Account(5)/PrimaryChurnScore",
  "ParentAccount@odata.navigationLink": "https://marketingpony.us1app.churnzero.net/public/v1/Account(5)/ParentAccount",
  "UserAccount@odata.navigationLink": "https://marketingpony.us1app.churnzero.net/public/v1/Account(5)/UserAccount",
  "DirectParentAccount@odata.navigationLink": "https://marketingpony.us1app.churnzero.net/public/v1/Account(5)/DirectParentAccount",
  "UltimateParentAccount@odata.navigationLink": "https://marketingpony.us1app.churnzero.net/public/v1/Account(5)/UltimateParentAccount"
}

Parameters

	Name	Description
	Id number(int64)	Id of the JourneyInstance
	$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, DirectParentAccountId, UltimateParentAccountId, Tags, ObjectCreatedDate, ObjectLastModifiedDate
↓ Show Options ↓			↑ Hide Options ↑
	$expand array[string]	Expand related entities
*, DirectParentAccount, ParentAccount, PrimaryChurnScore, UltimateParentAccount, 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 Journey

GET /JourneyInstance({Id})/Journey

Code samples

curl -X GET "https://marketingpony.us1app.churnzero.net/public/v1/JourneyInstance(6)/Journey" \
-H "Authorization: Basic c29tZXVzZXI6c3VwM3JTM2NyMzch"

200 response

{
  "Id": 9,
  "Description": "string",
  "ExpectedDuration": 13,
  "IsActive": false,
  "IsSharedExternally": true,
  "Name": "string",
  "ObjectCreatedDate": "2025-10-18T14:00:33.2710428Z",
  "ObjectLastModifiedDate": "2025-10-18T14:00:33.2710428Z",
  "ProgressBottom": 12,
  "ProgressTop": 9,
  "Status": "string"
}

Parameters

	Name	Description
	Id number(int64)	Id of the JourneyInstance
	$select array[string]	Select properties to be returned
Id, Name, Description, IsActive, Status, ObjectCreatedDate, ObjectLastModifiedDate, IsSharedExternally, ExpectedDuration, ProgressTop, ProgressBottom
↓ Show Options ↓			↑ Hide Options ↑
	$expand array[string]	Expand related entities
*
↓ Show Options ↓			↑ Hide Options ↑

Responses

	Status	Description
	200 Journey	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

JourneyProgress

GET/JourneyProgress
GET/JourneyProgress({Id})
GET/JourneyProgress({Id})/Account
GET/JourneyProgress({Id})/Journey
GET/JourneyProgress({Id})/JourneyInstance

Journey progress of Accounts.

Permissions

Bulk Read - Journeys

Get all JourneyProgresses

GET /JourneyProgress

Code samples

curl -X GET "https://marketingpony.us1app.churnzero.net/public/v1/JourneyProgress" \
-H "Authorization: Basic c29tZXVzZXI6c3VwM3JTM2NyMzch"

200 response

{
  "value": [
    {
      "Id": 8,
      "AccountId": 25,
      "BeginDate": "2025-10-18T14:00:33.2711271Z",
      "DaysIn": 26,
      "DaysLeft": 1,
      "DaysOver": 21,
      "EndDate": "2025-10-18T14:00:33.2711271Z",
      "EvaluationDay": "2025-10-18",
      "FailureComments": "string",
      "FailureReasons": "string",
      "IsCompleted": true,
      "IsFailed": true,
      "JourneyId": 23,
      "JourneyInstanceId": 5,
      "ObjectCreatedDate": "2025-10-18T14:00:33.2711271Z",
      "ObjectLastModifiedDate": "2025-10-18T14:00:33.2711271Z",
      "Status": "string",
      "Account@odata.navigationLink": "https://marketingpony.us1app.churnzero.net/public/v1/JourneyProgress(8)/Account",
      "Journey@odata.navigationLink": "https://marketingpony.us1app.churnzero.net/public/v1/JourneyProgress(8)/Journey",
      "JourneyInstance@odata.navigationLink": "https://marketingpony.us1app.churnzero.net/public/v1/JourneyProgress(8)/JourneyInstance"
    }
  ],
  "@odata.nextLink": "https://marketingpony.us1app.churnzero.net/public/v1/JourneyProgress?$skiptoken=eyJmIjpbeyJuIjoiSWQiLCJ2IjoiMjk1NTIifV0sIm8iOjR9"
}

Parameters

	Name	Description
	$filter array[string]	Filter items by property values
Id, AccountId, JourneyId, JourneyInstanceId, ObjectCreatedDate, ObjectLastModifiedDate
↓ Show Options ↓			↑ Hide Options ↑
	$orderby array[string]	Order items by property values
Id, ObjectCreatedDate, ObjectLastModifiedDate
↓ Show Options ↓			↑ Hide Options ↑
	$select array[string]	Select properties to be returned
Id, AccountId, JourneyId, JourneyInstanceId, IsCompleted, IsFailed, Status, BeginDate, EndDate, DaysIn, DaysLeft, DaysOver, FailureReasons, FailureComments, EvaluationDay, ObjectCreatedDate, ObjectLastModifiedDate
↓ Show Options ↓			↑ Hide Options ↑
	$expand array[string]	Expand related entities
*, Account, Journey, JourneyInstance
↓ Show Options ↓			↑ Hide Options ↑
	$top number	Show only the first n items
	$skip number	Skip the first n items
	$count boolean	Include count of items

Responses

	Status	Description
	200 array[JourneyProgress]	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 JourneyProgress

GET /JourneyProgress({Id})

Code samples

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

200 response

{
  "Id": 8,
  "AccountId": 25,
  "BeginDate": "2025-10-18T14:00:33.2711271Z",
  "DaysIn": 26,
  "DaysLeft": 1,
  "DaysOver": 21,
  "EndDate": "2025-10-18T14:00:33.2711271Z",
  "EvaluationDay": "2025-10-18",
  "FailureComments": "string",
  "FailureReasons": "string",
  "IsCompleted": true,
  "IsFailed": true,
  "JourneyId": 23,
  "JourneyInstanceId": 5,
  "ObjectCreatedDate": "2025-10-18T14:00:33.2711271Z",
  "ObjectLastModifiedDate": "2025-10-18T14:00:33.2711271Z",
  "Status": "string",
  "Account@odata.navigationLink": "https://marketingpony.us1app.churnzero.net/public/v1/JourneyProgress(8)/Account",
  "Journey@odata.navigationLink": "https://marketingpony.us1app.churnzero.net/public/v1/JourneyProgress(8)/Journey",
  "JourneyInstance@odata.navigationLink": "https://marketingpony.us1app.churnzero.net/public/v1/JourneyProgress(8)/JourneyInstance"
}

Parameters

	Name	Description
	Id number(int64)	Id of the JourneyProgress
	$select array[string]	Select properties to be returned
Id, AccountId, JourneyId, JourneyInstanceId, IsCompleted, IsFailed, Status, BeginDate, EndDate, DaysIn, DaysLeft, DaysOver, FailureReasons, FailureComments, EvaluationDay, ObjectCreatedDate, ObjectLastModifiedDate
↓ Show Options ↓			↑ Hide Options ↑
	$expand array[string]	Expand related entities
*, Account, Journey, JourneyInstance
↓ Show Options ↓			↑ Hide Options ↑

Responses

	Status	Description
	200 JourneyProgress	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 /JourneyProgress({Id})/Account

Code samples

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

200 response

{
  "Id": 5,
  "BillingAddressCity": "string",
  "BillingAddressCountry": "string",
  "BillingAddressLine1": "string",
  "BillingAddressLine2": "string",
  "BillingAddressState": "string",
  "BillingAddressZip": "string",
  "ContactsCount": 16,
  "CrmId": "string",
  "DirectParentAccountId": 25,
  "EndDate": "2025-10-18T14:00:32.3288567Z",
  "ExternalId": "string",
  "IsActive": false,
  "LicenseCount": 20,
  "Name": "string",
  "NextRenewalDate": "2025-10-18T14:00:32.3288567Z",
  "ObjectCreatedDate": "2025-10-18T14:00:32.3288567Z",
  "ObjectLastModifiedDate": "2025-10-18T14:00:32.3288567Z",
  "ParentAccountId": 4,
  "ParentNextRenewalDate": "2025-10-18T14:00:32.3288567Z",
  "ParentTotalContractAmount": "string",
  "PrimaryChurnScoreId": 9,
  "PrimaryChurnScoreValue": "string",
  "StartDate": "2025-10-18T14:00:32.3288567Z",
  "Tags": "string",
  "TenureInDays": 18,
  "TotalContractAmount": "string",
  "UltimateParentAccountId": 18,
  "UsageFrequency": "string",
  "UserAccountId": 8,
  "PrimaryChurnScore@odata.navigationLink": "https://marketingpony.us1app.churnzero.net/public/v1/Account(5)/PrimaryChurnScore",
  "ParentAccount@odata.navigationLink": "https://marketingpony.us1app.churnzero.net/public/v1/Account(5)/ParentAccount",
  "UserAccount@odata.navigationLink": "https://marketingpony.us1app.churnzero.net/public/v1/Account(5)/UserAccount",
  "DirectParentAccount@odata.navigationLink": "https://marketingpony.us1app.churnzero.net/public/v1/Account(5)/DirectParentAccount",
  "UltimateParentAccount@odata.navigationLink": "https://marketingpony.us1app.churnzero.net/public/v1/Account(5)/UltimateParentAccount"
}

Parameters

	Name	Description
	Id number(int64)	Id of the JourneyProgress
	$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, DirectParentAccountId, UltimateParentAccountId, Tags, ObjectCreatedDate, ObjectLastModifiedDate
↓ Show Options ↓			↑ Hide Options ↑
	$expand array[string]	Expand related entities
*, DirectParentAccount, ParentAccount, PrimaryChurnScore, UltimateParentAccount, 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 Journey

GET /JourneyProgress({Id})/Journey

Code samples

curl -X GET "https://marketingpony.us1app.churnzero.net/public/v1/JourneyProgress(8)/Journey" \
-H "Authorization: Basic c29tZXVzZXI6c3VwM3JTM2NyMzch"

200 response

{
  "Id": 9,
  "Description": "string",
  "ExpectedDuration": 13,
  "IsActive": false,
  "IsSharedExternally": true,
  "Name": "string",
  "ObjectCreatedDate": "2025-10-18T14:00:33.2710428Z",
  "ObjectLastModifiedDate": "2025-10-18T14:00:33.2710428Z",
  "ProgressBottom": 12,
  "ProgressTop": 9,
  "Status": "string"
}

Parameters

	Name	Description
	Id number(int64)	Id of the JourneyProgress
	$select array[string]	Select properties to be returned
Id, Name, Description, IsActive, Status, ObjectCreatedDate, ObjectLastModifiedDate, IsSharedExternally, ExpectedDuration, ProgressTop, ProgressBottom
↓ Show Options ↓			↑ Hide Options ↑
	$expand array[string]	Expand related entities
*
↓ Show Options ↓			↑ Hide Options ↑

Responses

	Status	Description
	200 Journey	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 JourneyInstance

GET /JourneyProgress({Id})/JourneyInstance

Code samples

curl -X GET "https://marketingpony.us1app.churnzero.net/public/v1/JourneyProgress(8)/JourneyInstance" \
-H "Authorization: Basic c29tZXVzZXI6c3VwM3JTM2NyMzch"

200 response

{
  "Id": 6,
  "AccountId": 16,
  "JourneyId": 26,
  "StartDate": "2025-10-18T14:00:33.2711112Z",
  "Account@odata.navigationLink": "https://marketingpony.us1app.churnzero.net/public/v1/JourneyInstance(6)/Account",
  "Journey@odata.navigationLink": "https://marketingpony.us1app.churnzero.net/public/v1/JourneyInstance(6)/Journey"
}

Parameters

	Name	Description
	Id number(int64)	Id of the JourneyProgress
	$select array[string]	Select properties to be returned
Id, JourneyId, AccountId, StartDate
↓ Show Options ↓			↑ Hide Options ↑
	$expand array[string]	Expand related entities
*, Account, Journey
↓ Show Options ↓			↑ Hide Options ↑

Responses

	Status	Description
	200 JourneyInstance	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

JourneyMilestoneProgress

GET/JourneyMilestoneProgress
GET/JourneyMilestoneProgress({Id})
GET/JourneyMilestoneProgress({Id})/Account
GET/JourneyMilestoneProgress({Id})/Journey
GET/JourneyMilestoneProgress({Id})/JourneyInstance
GET/JourneyMilestoneProgress({Id})/JourneyMilestone

Journey Milestone progress of Accounts.

Permissions

Bulk Read - Journeys

Get all JourneyMilestoneProgresses

GET /JourneyMilestoneProgress

Code samples

curl -X GET "https://marketingpony.us1app.churnzero.net/public/v1/JourneyMilestoneProgress" \
-H "Authorization: Basic c29tZXVzZXI6c3VwM3JTM2NyMzch"

200 response

{
  "value": [
    {
      "Id": 6,
      "AccountId": 8,
      "BeginDate": "2025-10-18T14:00:33.2711598Z",
      "DaysIn": 5,
      "DaysLeft": 21,
      "DaysOver": 5,
      "EndDate": "2025-10-18T14:00:33.2711598Z",
      "EvaluationDay": "2025-10-18",
      "IsCompleted": false,
      "IsFailed": true,
      "JourneyId": 19,
      "JourneyInstanceId": 27,
      "JourneyMilestoneId": 1,
      "ObjectCreatedDate": "2025-10-18T14:00:33.2711598Z",
      "ObjectLastModifiedDate": "2025-10-18T14:00:33.2711598Z",
      "Status": "string",
      "Account@odata.navigationLink": "https://marketingpony.us1app.churnzero.net/public/v1/JourneyMilestoneProgress(6)/Account",
      "Journey@odata.navigationLink": "https://marketingpony.us1app.churnzero.net/public/v1/JourneyMilestoneProgress(6)/Journey",
      "JourneyMilestone@odata.navigationLink": "https://marketingpony.us1app.churnzero.net/public/v1/JourneyMilestoneProgress(6)/JourneyMilestone",
      "JourneyInstance@odata.navigationLink": "https://marketingpony.us1app.churnzero.net/public/v1/JourneyMilestoneProgress(6)/JourneyInstance"
    }
  ],
  "@odata.nextLink": "https://marketingpony.us1app.churnzero.net/public/v1/JourneyMilestoneProgress?$skiptoken=eyJmIjpbeyJuIjoiSWQiLCJ2IjoiMjg3MDYifV0sIm8iOjR9"
}

Parameters

	Name	Description
	$filter array[string]	Filter items by property values
Id, AccountId, JourneyId, JourneyMilestoneId, ObjectCreatedDate, ObjectLastModifiedDate
↓ Show Options ↓			↑ Hide Options ↑
	$orderby array[string]	Order items by property values
Id, BeginDate, EndDate, EvaluationDay, ObjectCreatedDate, ObjectLastModifiedDate
↓ Show Options ↓			↑ Hide Options ↑
	$select array[string]	Select properties to be returned
Id, AccountId, JourneyId, JourneyMilestoneId, JourneyInstanceId, IsCompleted, IsFailed, Status, BeginDate, EndDate, DaysIn, DaysLeft, DaysOver, EvaluationDay, ObjectCreatedDate, ObjectLastModifiedDate
↓ Show Options ↓			↑ Hide Options ↑
	$expand array[string]	Expand related entities
*, Account, Journey, JourneyInstance, JourneyMilestone
↓ Show Options ↓			↑ Hide Options ↑
	$top number	Show only the first n items
	$skip number	Skip the first n items
	$count boolean	Include count of items

Responses

	Status	Description
	200 array[JourneyMilestoneProgress]	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 JourneyMilestoneProgress

GET /JourneyMilestoneProgress({Id})

Code samples

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

200 response

{
  "Id": 6,
  "AccountId": 8,
  "BeginDate": "2025-10-18T14:00:33.2711598Z",
  "DaysIn": 5,
  "DaysLeft": 21,
  "DaysOver": 5,
  "EndDate": "2025-10-18T14:00:33.2711598Z",
  "EvaluationDay": "2025-10-18",
  "IsCompleted": false,
  "IsFailed": true,
  "JourneyId": 19,
  "JourneyInstanceId": 27,
  "JourneyMilestoneId": 1,
  "ObjectCreatedDate": "2025-10-18T14:00:33.2711598Z",
  "ObjectLastModifiedDate": "2025-10-18T14:00:33.2711598Z",
  "Status": "string",
  "Account@odata.navigationLink": "https://marketingpony.us1app.churnzero.net/public/v1/JourneyMilestoneProgress(6)/Account",
  "Journey@odata.navigationLink": "https://marketingpony.us1app.churnzero.net/public/v1/JourneyMilestoneProgress(6)/Journey",
  "JourneyMilestone@odata.navigationLink": "https://marketingpony.us1app.churnzero.net/public/v1/JourneyMilestoneProgress(6)/JourneyMilestone",
  "JourneyInstance@odata.navigationLink": "https://marketingpony.us1app.churnzero.net/public/v1/JourneyMilestoneProgress(6)/JourneyInstance"
}

Parameters

	Name	Description
	Id number(int64)	Id of the JourneyMilestoneProgress
	$select array[string]	Select properties to be returned
Id, AccountId, JourneyId, JourneyMilestoneId, JourneyInstanceId, IsCompleted, IsFailed, Status, BeginDate, EndDate, DaysIn, DaysLeft, DaysOver, EvaluationDay, ObjectCreatedDate, ObjectLastModifiedDate
↓ Show Options ↓			↑ Hide Options ↑
	$expand array[string]	Expand related entities
*, Account, Journey, JourneyInstance, JourneyMilestone
↓ Show Options ↓			↑ Hide Options ↑

Responses

	Status	Description
	200 JourneyMilestoneProgress	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 /JourneyMilestoneProgress({Id})/Account

Code samples

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

200 response

{
  "Id": 5,
  "BillingAddressCity": "string",
  "BillingAddressCountry": "string",
  "BillingAddressLine1": "string",
  "BillingAddressLine2": "string",
  "BillingAddressState": "string",
  "BillingAddressZip": "string",
  "ContactsCount": 16,
  "CrmId": "string",
  "DirectParentAccountId": 25,
  "EndDate": "2025-10-18T14:00:32.3288567Z",
  "ExternalId": "string",
  "IsActive": false,
  "LicenseCount": 20,
  "Name": "string",
  "NextRenewalDate": "2025-10-18T14:00:32.3288567Z",
  "ObjectCreatedDate": "2025-10-18T14:00:32.3288567Z",
  "ObjectLastModifiedDate": "2025-10-18T14:00:32.3288567Z",
  "ParentAccountId": 4,
  "ParentNextRenewalDate": "2025-10-18T14:00:32.3288567Z",
  "ParentTotalContractAmount": "string",
  "PrimaryChurnScoreId": 9,
  "PrimaryChurnScoreValue": "string",
  "StartDate": "2025-10-18T14:00:32.3288567Z",
  "Tags": "string",
  "TenureInDays": 18,
  "TotalContractAmount": "string",
  "UltimateParentAccountId": 18,
  "UsageFrequency": "string",
  "UserAccountId": 8,
  "PrimaryChurnScore@odata.navigationLink": "https://marketingpony.us1app.churnzero.net/public/v1/Account(5)/PrimaryChurnScore",
  "ParentAccount@odata.navigationLink": "https://marketingpony.us1app.churnzero.net/public/v1/Account(5)/ParentAccount",
  "UserAccount@odata.navigationLink": "https://marketingpony.us1app.churnzero.net/public/v1/Account(5)/UserAccount",
  "DirectParentAccount@odata.navigationLink": "https://marketingpony.us1app.churnzero.net/public/v1/Account(5)/DirectParentAccount",
  "UltimateParentAccount@odata.navigationLink": "https://marketingpony.us1app.churnzero.net/public/v1/Account(5)/UltimateParentAccount"
}

Parameters

	Name	Description
	Id number(int64)	Id of the JourneyMilestoneProgress
	$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, DirectParentAccountId, UltimateParentAccountId, Tags, ObjectCreatedDate, ObjectLastModifiedDate
↓ Show Options ↓			↑ Hide Options ↑
	$expand array[string]	Expand related entities
*, DirectParentAccount, ParentAccount, PrimaryChurnScore, UltimateParentAccount, 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 Journey

GET /JourneyMilestoneProgress({Id})/Journey

Code samples

curl -X GET "https://marketingpony.us1app.churnzero.net/public/v1/JourneyMilestoneProgress(6)/Journey" \
-H "Authorization: Basic c29tZXVzZXI6c3VwM3JTM2NyMzch"

200 response

{
  "Id": 9,
  "Description": "string",
  "ExpectedDuration": 13,
  "IsActive": false,
  "IsSharedExternally": true,
  "Name": "string",
  "ObjectCreatedDate": "2025-10-18T14:00:33.2710428Z",
  "ObjectLastModifiedDate": "2025-10-18T14:00:33.2710428Z",
  "ProgressBottom": 12,
  "ProgressTop": 9,
  "Status": "string"
}

Parameters

	Name	Description
	Id number(int64)	Id of the JourneyMilestoneProgress
	$select array[string]	Select properties to be returned
Id, Name, Description, IsActive, Status, ObjectCreatedDate, ObjectLastModifiedDate, IsSharedExternally, ExpectedDuration, ProgressTop, ProgressBottom
↓ Show Options ↓			↑ Hide Options ↑
	$expand array[string]	Expand related entities
*
↓ Show Options ↓			↑ Hide Options ↑

Responses

	Status	Description
	200 Journey	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 JourneyInstance

GET /JourneyMilestoneProgress({Id})/JourneyInstance

Code samples

curl -X GET "https://marketingpony.us1app.churnzero.net/public/v1/JourneyMilestoneProgress(6)/JourneyInstance" \
-H "Authorization: Basic c29tZXVzZXI6c3VwM3JTM2NyMzch"

200 response

{
  "Id": 6,
  "AccountId": 16,
  "JourneyId": 26,
  "StartDate": "2025-10-18T14:00:33.2711112Z",
  "Account@odata.navigationLink": "https://marketingpony.us1app.churnzero.net/public/v1/JourneyInstance(6)/Account",
  "Journey@odata.navigationLink": "https://marketingpony.us1app.churnzero.net/public/v1/JourneyInstance(6)/Journey"
}

Parameters

	Name	Description
	Id number(int64)	Id of the JourneyMilestoneProgress
	$select array[string]	Select properties to be returned
Id, JourneyId, AccountId, StartDate
↓ Show Options ↓			↑ Hide Options ↑
	$expand array[string]	Expand related entities
*, Account, Journey
↓ Show Options ↓			↑ Hide Options ↑

Responses

	Status	Description
	200 JourneyInstance	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 JourneyMilestone

GET /JourneyMilestoneProgress({Id})/JourneyMilestone

Code samples

curl -X GET "https://marketingpony.us1app.churnzero.net/public/v1/JourneyMilestoneProgress(6)/JourneyMilestone" \
-H "Authorization: Basic c29tZXVzZXI6c3VwM3JTM2NyMzch"

200 response

{
  "Id": 4,
  "Description": "string",
  "ExpectedDuration": 15,
  "JourneyId": 29,
  "Name": "string",
  "ObjectCreatedDate": "2025-10-18T14:00:33.2710605Z",
  "ObjectLastModifiedDate": "2025-10-18T14:00:33.2710605Z",
  "ProgressBottom": 7,
  "ProgressTop": 16,
  "Journey@odata.navigationLink": "https://marketingpony.us1app.churnzero.net/public/v1/JourneyMilestone(4)/Journey"
}

Parameters

	Name	Description
	Id number(int64)	Id of the JourneyMilestoneProgress
	$select array[string]	Select properties to be returned
Id, Name, Description, JourneyId, ExpectedDuration, ProgressTop, ProgressBottom, ObjectCreatedDate, ObjectLastModifiedDate
↓ Show Options ↓			↑ Hide Options ↑
	$expand array[string]	Expand related entities
*, Journey
↓ Show Options ↓			↑ Hide Options ↑

Responses

	Status	Description
	200 JourneyMilestone	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

JourneyMilestoneStepProgress

GET/JourneyMilestoneStepProgress
GET/JourneyMilestoneStepProgress({Id})
GET/JourneyMilestoneStepProgress({Id})/Account
GET/JourneyMilestoneStepProgress({Id})/Journey
GET/JourneyMilestoneStepProgress({Id})/JourneyInstance
GET/JourneyMilestoneStepProgress({Id})/JourneyMilestone
GET/JourneyMilestoneStepProgress({Id})/JourneyMilestoneAchievement
GET/JourneyMilestoneStepProgress({Id})/JourneyMilestoneTask
GET/JourneyMilestoneStepProgress({Id})/Task
GET/JourneyMilestoneStepProgress({Id})/TaskStatus

Journey Milestone Step progress of Accounts. This represents the progress of the associated Task or Achievement from the perspective of the Journey.

Permissions

Bulk Read - Journeys

Get all JourneyMilestoneStepProgresses

GET /JourneyMilestoneStepProgress

Code samples

curl -X GET "https://marketingpony.us1app.churnzero.net/public/v1/JourneyMilestoneStepProgress" \
-H "Authorization: Basic c29tZXVzZXI6c3VwM3JTM2NyMzch"

200 response

{
  "value": [
    {
      "Id": 4,
      "AccountId": 25,
      "IsCompleted": false,
      "JourneyId": 2,
      "JourneyInstanceId": 17,
      "JourneyMilestoneAchievementId": 5,
      "JourneyMilestoneId": 10,
      "JourneyMilestoneTaskId": 7,
      "ObjectCreatedDate": "2025-10-18T14:00:33.2711939Z",
      "ObjectLastModifiedDate": "2025-10-18T14:00:33.2711939Z",
      "TaskId": 27,
      "TaskStatusId": 23,
      "Account@odata.navigationLink": "https://marketingpony.us1app.churnzero.net/public/v1/JourneyMilestoneStepProgress(4)/Account",
      "Journey@odata.navigationLink": "https://marketingpony.us1app.churnzero.net/public/v1/JourneyMilestoneStepProgress(4)/Journey",
      "JourneyMilestone@odata.navigationLink": "https://marketingpony.us1app.churnzero.net/public/v1/JourneyMilestoneStepProgress(4)/JourneyMilestone",
      "JourneyInstance@odata.navigationLink": "https://marketingpony.us1app.churnzero.net/public/v1/JourneyMilestoneStepProgress(4)/JourneyInstance",
      "JourneyMilestoneAchievement@odata.navigationLink": "https://marketingpony.us1app.churnzero.net/public/v1/JourneyMilestoneStepProgress(4)/JourneyMilestoneAchievement",
      "JourneyMilestoneTask@odata.navigationLink": "https://marketingpony.us1app.churnzero.net/public/v1/JourneyMilestoneStepProgress(4)/JourneyMilestoneTask",
      "Task@odata.navigationLink": "https://marketingpony.us1app.churnzero.net/public/v1/JourneyMilestoneStepProgress(4)/Task",
      "TaskStatus@odata.navigationLink": "https://marketingpony.us1app.churnzero.net/public/v1/JourneyMilestoneStepProgress(4)/TaskStatus"
    }
  ],
  "@odata.nextLink": "https://marketingpony.us1app.churnzero.net/public/v1/JourneyMilestoneStepProgress?$skiptoken=eyJmIjpbeyJuIjoiSWQiLCJ2IjoiMTgxMTAifV0sIm8iOjR9"
}

Parameters

	Name	Description
	$filter array[string]	Filter items by property values
Id, AccountId, JourneyId, JourneyMilestoneId, JourneyMilestoneAchievementId, JourneyMilestoneTaskId, JourneyInstanceId, TaskStatusId, TaskId, ObjectCreatedDate, ObjectLastModifiedDate
↓ Show Options ↓			↑ Hide Options ↑
	$orderby array[string]	Order items by property values
Id, ObjectCreatedDate, ObjectLastModifiedDate
↓ Show Options ↓			↑ Hide Options ↑
	$select array[string]	Select properties to be returned
Id, AccountId, JourneyId, JourneyMilestoneId, JourneyMilestoneAchievementId, JourneyMilestoneTaskId, JourneyInstanceId, TaskId, TaskStatusId, IsCompleted, ObjectCreatedDate, ObjectLastModifiedDate
↓ Show Options ↓			↑ Hide Options ↑
	$expand array[string]	Expand related entities
*, Account, Journey, JourneyInstance, JourneyMilestone, JourneyMilestoneAchievement, JourneyMilestoneTask, Task, TaskStatus
↓ Show Options ↓			↑ Hide Options ↑
	$top number	Show only the first n items
	$skip number	Skip the first n items
	$count boolean	Include count of items

Responses

	Status	Description
	200 array[JourneyMilestoneStepProgress]	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 JourneyMilestoneStepProgress

GET /JourneyMilestoneStepProgress({Id})

Code samples

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

200 response

{
  "Id": 4,
  "AccountId": 25,
  "IsCompleted": false,
  "JourneyId": 2,
  "JourneyInstanceId": 17,
  "JourneyMilestoneAchievementId": 5,
  "JourneyMilestoneId": 10,
  "JourneyMilestoneTaskId": 7,
  "ObjectCreatedDate": "2025-10-18T14:00:33.2711939Z",
  "ObjectLastModifiedDate": "2025-10-18T14:00:33.2711939Z",
  "TaskId": 27,
  "TaskStatusId": 23,
  "Account@odata.navigationLink": "https://marketingpony.us1app.churnzero.net/public/v1/JourneyMilestoneStepProgress(4)/Account",
  "Journey@odata.navigationLink": "https://marketingpony.us1app.churnzero.net/public/v1/JourneyMilestoneStepProgress(4)/Journey",
  "JourneyMilestone@odata.navigationLink": "https://marketingpony.us1app.churnzero.net/public/v1/JourneyMilestoneStepProgress(4)/JourneyMilestone",
  "JourneyInstance@odata.navigationLink": "https://marketingpony.us1app.churnzero.net/public/v1/JourneyMilestoneStepProgress(4)/JourneyInstance",
  "JourneyMilestoneAchievement@odata.navigationLink": "https://marketingpony.us1app.churnzero.net/public/v1/JourneyMilestoneStepProgress(4)/JourneyMilestoneAchievement",
  "JourneyMilestoneTask@odata.navigationLink": "https://marketingpony.us1app.churnzero.net/public/v1/JourneyMilestoneStepProgress(4)/JourneyMilestoneTask",
  "Task@odata.navigationLink": "https://marketingpony.us1app.churnzero.net/public/v1/JourneyMilestoneStepProgress(4)/Task",
  "TaskStatus@odata.navigationLink": "https://marketingpony.us1app.churnzero.net/public/v1/JourneyMilestoneStepProgress(4)/TaskStatus"
}

Parameters

	Name	Description
	Id number(int64)	Id of the JourneyMilestoneStepProgress
	$select array[string]	Select properties to be returned
Id, AccountId, JourneyId, JourneyMilestoneId, JourneyMilestoneAchievementId, JourneyMilestoneTaskId, JourneyInstanceId, TaskId, TaskStatusId, IsCompleted, ObjectCreatedDate, ObjectLastModifiedDate
↓ Show Options ↓			↑ Hide Options ↑
	$expand array[string]	Expand related entities
*, Account, Journey, JourneyInstance, JourneyMilestone, JourneyMilestoneAchievement, JourneyMilestoneTask, Task, TaskStatus
↓ Show Options ↓			↑ Hide Options ↑

Responses

	Status	Description
	200 JourneyMilestoneStepProgress	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 /JourneyMilestoneStepProgress({Id})/Account

Code samples

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

200 response

{
  "Id": 5,
  "BillingAddressCity": "string",
  "BillingAddressCountry": "string",
  "BillingAddressLine1": "string",
  "BillingAddressLine2": "string",
  "BillingAddressState": "string",
  "BillingAddressZip": "string",
  "ContactsCount": 16,
  "CrmId": "string",
  "DirectParentAccountId": 25,
  "EndDate": "2025-10-18T14:00:32.3288567Z",
  "ExternalId": "string",
  "IsActive": false,
  "LicenseCount": 20,
  "Name": "string",
  "NextRenewalDate": "2025-10-18T14:00:32.3288567Z",
  "ObjectCreatedDate": "2025-10-18T14:00:32.3288567Z",
  "ObjectLastModifiedDate": "2025-10-18T14:00:32.3288567Z",
  "ParentAccountId": 4,
  "ParentNextRenewalDate": "2025-10-18T14:00:32.3288567Z",
  "ParentTotalContractAmount": "string",
  "PrimaryChurnScoreId": 9,
  "PrimaryChurnScoreValue": "string",
  "StartDate": "2025-10-18T14:00:32.3288567Z",
  "Tags": "string",
  "TenureInDays": 18,
  "TotalContractAmount": "string",
  "UltimateParentAccountId": 18,
  "UsageFrequency": "string",
  "UserAccountId": 8,
  "PrimaryChurnScore@odata.navigationLink": "https://marketingpony.us1app.churnzero.net/public/v1/Account(5)/PrimaryChurnScore",
  "ParentAccount@odata.navigationLink": "https://marketingpony.us1app.churnzero.net/public/v1/Account(5)/ParentAccount",
  "UserAccount@odata.navigationLink": "https://marketingpony.us1app.churnzero.net/public/v1/Account(5)/UserAccount",
  "DirectParentAccount@odata.navigationLink": "https://marketingpony.us1app.churnzero.net/public/v1/Account(5)/DirectParentAccount",
  "UltimateParentAccount@odata.navigationLink": "https://marketingpony.us1app.churnzero.net/public/v1/Account(5)/UltimateParentAccount"
}

Parameters

	Name	Description
	Id number(int64)	Id of the JourneyMilestoneStepProgress
	$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, DirectParentAccountId, UltimateParentAccountId, Tags, ObjectCreatedDate, ObjectLastModifiedDate
↓ Show Options ↓			↑ Hide Options ↑
	$expand array[string]	Expand related entities
*, DirectParentAccount, ParentAccount, PrimaryChurnScore, UltimateParentAccount, 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 Journey

GET /JourneyMilestoneStepProgress({Id})/Journey

Code samples

curl -X GET "https://marketingpony.us1app.churnzero.net/public/v1/JourneyMilestoneStepProgress(4)/Journey" \
-H "Authorization: Basic c29tZXVzZXI6c3VwM3JTM2NyMzch"

200 response

{
  "Id": 9,
  "Description": "string",
  "ExpectedDuration": 13,
  "IsActive": false,
  "IsSharedExternally": true,
  "Name": "string",
  "ObjectCreatedDate": "2025-10-18T14:00:33.2710428Z",
  "ObjectLastModifiedDate": "2025-10-18T14:00:33.2710428Z",
  "ProgressBottom": 12,
  "ProgressTop": 9,
  "Status": "string"
}

Parameters

	Name	Description
	Id number(int64)	Id of the JourneyMilestoneStepProgress
	$select array[string]	Select properties to be returned
Id, Name, Description, IsActive, Status, ObjectCreatedDate, ObjectLastModifiedDate, IsSharedExternally, ExpectedDuration, ProgressTop, ProgressBottom
↓ Show Options ↓			↑ Hide Options ↑
	$expand array[string]	Expand related entities
*
↓ Show Options ↓			↑ Hide Options ↑

Responses

	Status	Description
	200 Journey	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 JourneyInstance

GET /JourneyMilestoneStepProgress({Id})/JourneyInstance

Code samples

curl -X GET "https://marketingpony.us1app.churnzero.net/public/v1/JourneyMilestoneStepProgress(4)/JourneyInstance" \
-H "Authorization: Basic c29tZXVzZXI6c3VwM3JTM2NyMzch"

200 response

{
  "Id": 6,
  "AccountId": 16,
  "JourneyId": 26,
  "StartDate": "2025-10-18T14:00:33.2711112Z",
  "Account@odata.navigationLink": "https://marketingpony.us1app.churnzero.net/public/v1/JourneyInstance(6)/Account",
  "Journey@odata.navigationLink": "https://marketingpony.us1app.churnzero.net/public/v1/JourneyInstance(6)/Journey"
}

Parameters

	Name	Description
	Id number(int64)	Id of the JourneyMilestoneStepProgress
	$select array[string]	Select properties to be returned
Id, JourneyId, AccountId, StartDate
↓ Show Options ↓			↑ Hide Options ↑
	$expand array[string]	Expand related entities
*, Account, Journey
↓ Show Options ↓			↑ Hide Options ↑

Responses

	Status	Description
	200 JourneyInstance	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 JourneyMilestone

GET /JourneyMilestoneStepProgress({Id})/JourneyMilestone

Code samples

curl -X GET "https://marketingpony.us1app.churnzero.net/public/v1/JourneyMilestoneStepProgress(4)/JourneyMilestone" \
-H "Authorization: Basic c29tZXVzZXI6c3VwM3JTM2NyMzch"

200 response

{
  "Id": 4,
  "Description": "string",
  "ExpectedDuration": 15,
  "JourneyId": 29,
  "Name": "string",
  "ObjectCreatedDate": "2025-10-18T14:00:33.2710605Z",
  "ObjectLastModifiedDate": "2025-10-18T14:00:33.2710605Z",
  "ProgressBottom": 7,
  "ProgressTop": 16,
  "Journey@odata.navigationLink": "https://marketingpony.us1app.churnzero.net/public/v1/JourneyMilestone(4)/Journey"
}

Parameters

	Name	Description
	Id number(int64)	Id of the JourneyMilestoneStepProgress
	$select array[string]	Select properties to be returned
Id, Name, Description, JourneyId, ExpectedDuration, ProgressTop, ProgressBottom, ObjectCreatedDate, ObjectLastModifiedDate
↓ Show Options ↓			↑ Hide Options ↑
	$expand array[string]	Expand related entities
*, Journey
↓ Show Options ↓			↑ Hide Options ↑

Responses

	Status	Description
	200 JourneyMilestone	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 JourneyMilestoneAchievement

GET /JourneyMilestoneStepProgress({Id})/JourneyMilestoneAchievement

Code samples

curl -X GET "https://marketingpony.us1app.churnzero.net/public/v1/JourneyMilestoneStepProgress(4)/JourneyMilestoneAchievement" \
-H "Authorization: Basic c29tZXVzZXI6c3VwM3JTM2NyMzch"

200 response

{
  "Id": 5,
  "IsConditional": true,
  "IsExternallyVisible": false,
  "IsOptional": true,
  "JourneyMilestoneId": 8,
  "Name": "string",
  "ObjectCreatedDate": "2025-10-18T14:00:33.2710781Z",
  "ObjectLastModifiedDate": "2025-10-18T14:00:33.2710781Z",
  "JourneyMilestone@odata.navigationLink": "https://marketingpony.us1app.churnzero.net/public/v1/JourneyMilestoneAchievement(5)/JourneyMilestone"
}

Parameters

	Name	Description
	Id number(int64)	Id of the JourneyMilestoneStepProgress
	$select array[string]	Select properties to be returned
Id, Name, IsOptional, IsConditional, IsExternallyVisible, JourneyMilestoneId, ObjectCreatedDate, ObjectLastModifiedDate
↓ Show Options ↓			↑ Hide Options ↑
	$expand array[string]	Expand related entities
*, JourneyMilestone
↓ Show Options ↓			↑ Hide Options ↑

Responses

	Status	Description
	200 JourneyMilestoneAchievement	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 JourneyMilestoneTask

GET /JourneyMilestoneStepProgress({Id})/JourneyMilestoneTask

Code samples

curl -X GET "https://marketingpony.us1app.churnzero.net/public/v1/JourneyMilestoneStepProgress(4)/JourneyMilestoneTask" \
-H "Authorization: Basic c29tZXVzZXI6c3VwM3JTM2NyMzch"

200 response

{
  "Id": 3,
  "IsConditional": false,
  "IsExternallyVisible": false,
  "IsOptional": false,
  "JourneyMilestoneId": 28,
  "ObjectCreatedDate": "2025-10-18T14:00:33.2710947Z",
  "ObjectLastModifiedDate": "2025-10-18T14:00:33.2710947Z",
  "Subject": "string",
  "JourneyMilestone@odata.navigationLink": "https://marketingpony.us1app.churnzero.net/public/v1/JourneyMilestoneTask(3)/JourneyMilestone"
}

Parameters

	Name	Description
	Id number(int64)	Id of the JourneyMilestoneStepProgress
	$select array[string]	Select properties to be returned
Id, Subject, JourneyMilestoneId, IsOptional, IsConditional, IsExternallyVisible, ObjectCreatedDate, ObjectLastModifiedDate
↓ Show Options ↓			↑ Hide Options ↑
	$expand array[string]	Expand related entities
*, JourneyMilestone
↓ Show Options ↓			↑ Hide Options ↑

Responses

	Status	Description
	200 JourneyMilestoneTask	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 Task

GET /JourneyMilestoneStepProgress({Id})/Task

Code samples

curl -X GET "https://marketingpony.us1app.churnzero.net/public/v1/JourneyMilestoneStepProgress(4)/Task" \
-H "Authorization: Basic c29tZXVzZXI6c3VwM3JTM2NyMzch"

200 response

{
  "Id": 4,
  "AccountId": 19,
  "CloseDate": "2025-10-18T14:00:33.2707887Z",
  "Comments": "string",
  "ContactId": 5,
  "CrmId": "string",
  "DueDate": "2025-10-18T14:00:33.2707887Z",
  "IsClosed": false,
  "IsHighPriority": true,
  "ObjectCreatedDate": "2025-10-18T14:00:33.2707887Z",
  "ObjectLastModifiedDate": "2025-10-18T14:00:33.2707887Z",
  "Subject": "string",
  "TaskPriorityId": 18,
  "TaskStatusId": 18,
  "TaskType": "string",
  "UserAccountId": 3,
  "Account@odata.navigationLink": "https://marketingpony.us1app.churnzero.net/public/v1/Task(4)/Account",
  "Contact@odata.navigationLink": "https://marketingpony.us1app.churnzero.net/public/v1/Task(4)/Contact",
  "UserAccount@odata.navigationLink": "https://marketingpony.us1app.churnzero.net/public/v1/Task(4)/UserAccount",
  "TaskPriority@odata.navigationLink": "https://marketingpony.us1app.churnzero.net/public/v1/Task(4)/TaskPriority",
  "TaskStatus@odata.navigationLink": "https://marketingpony.us1app.churnzero.net/public/v1/Task(4)/TaskStatus"
}

Parameters

	Name	Description
	Id number(int64)	Id of the JourneyMilestoneStepProgress
	$select array[string]	Select properties to be returned
Id, AccountId, ContactId, UserAccountId, TaskPriorityId, TaskStatusId, Subject, DueDate, CloseDate, IsClosed, IsHighPriority, Comments, CrmId, TaskType, ObjectCreatedDate, ObjectLastModifiedDate
↓ Show Options ↓			↑ Hide Options ↑
	$expand array[string]	Expand related entities
*, Account, Contact, TaskPriority, TaskStatus, UserAccount
↓ Show Options ↓			↑ Hide Options ↑

Responses

	Status	Description
	200 Task	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 /JourneyMilestoneStepProgress({Id})/TaskStatus

Code samples

curl -X GET "https://marketingpony.us1app.churnzero.net/public/v1/JourneyMilestoneStepProgress(4)/TaskStatus" \
-H "Authorization: Basic c29tZXVzZXI6c3VwM3JTM2NyMzch"

200 response

{
  "Id": 4,
  "IsClosed": true,
  "IsDefault": false,
  "Name": "string"
}

Parameters

	Name	Description
	Id number(int64)	Id of the JourneyMilestoneStepProgress
	$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

Schemas

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

Account

Account available in ChurnZero.

{
  "Id": 5,
  "BillingAddressCity": "string",
  "BillingAddressCountry": "string",
  "BillingAddressLine1": "string",
  "BillingAddressLine2": "string",
  "BillingAddressState": "string",
  "BillingAddressZip": "string",
  "ContactsCount": 16,
  "CrmId": "string",
  "DirectParentAccountId": 25,
  "EndDate": "2025-10-18T14:00:32.3288567Z",
  "ExternalId": "string",
  "IsActive": false,
  "LicenseCount": 20,
  "Name": "string",
  "NextRenewalDate": "2025-10-18T14:00:32.3288567Z",
  "ObjectCreatedDate": "2025-10-18T14:00:32.3288567Z",
  "ObjectLastModifiedDate": "2025-10-18T14:00:32.3288567Z",
  "ParentAccountId": 4,
  "ParentNextRenewalDate": "2025-10-18T14:00:32.3288567Z",
  "ParentTotalContractAmount": "string",
  "PrimaryChurnScoreId": 9,
  "PrimaryChurnScoreValue": "string",
  "StartDate": "2025-10-18T14:00:32.3288567Z",
  "Tags": "string",
  "TenureInDays": 18,
  "TotalContractAmount": "string",
  "UltimateParentAccountId": 18,
  "UsageFrequency": "string",
  "UserAccountId": 8,
  "PrimaryChurnScore@odata.navigationLink": "https://marketingpony.us1app.churnzero.net/public/v1/Account(5)/PrimaryChurnScore",
  "ParentAccount@odata.navigationLink": "https://marketingpony.us1app.churnzero.net/public/v1/Account(5)/ParentAccount",
  "UserAccount@odata.navigationLink": "https://marketingpony.us1app.churnzero.net/public/v1/Account(5)/UserAccount",
  "DirectParentAccount@odata.navigationLink": "https://marketingpony.us1app.churnzero.net/public/v1/Account(5)/DirectParentAccount",
  "UltimateParentAccount@odata.navigationLink": "https://marketingpony.us1app.churnzero.net/public/v1/Account(5)/UltimateParentAccount"
}

Properties

	Name	Description
	Id number(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.
	ContactsCount number(int32)	The number of Contacts associated with this Account.
	CrmId string	The ID that this Account is linked to in an external source.
	DirectParentAccountId number(int64)	The Id of the Direct Parent Account.
	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 number(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 number(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 number(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 number(int32)	The number of days since this Account's start date.
	TotalContractAmount number	The Total Contract Amount of this Account.
	UltimateParentAccountId number(int64)	The Id of the Ultimate Parent Account.
	UsageFrequency string
	UserAccountId number(int64)	The Account owner's Id.
	PrimaryChurnScore object	References the ChurnScore object.
	ParentAccount object	References the Account object.
	UserAccount object	References the UserAccount object.
	DirectParentAccount object	References the Account object.
	UltimateParentAccount object	References the Account object.

ChurnScore

Churn Score available in ChurnZero.

{
  "Id": 6,
  "GradingBottom": "string",
  "GradingTop": "string",
  "Name": "string"
}

Properties

	Name	Description
	Id number(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": 7,
  "AccountId": 22,
  "CalculationDay": "2025-10-18",
  "ChurnScoreId": 2,
  "IsActive": false,
  "IsPrimary": true,
  "Score": "string",
  "Account@odata.navigationLink": "https://marketingpony.us1app.churnzero.net/public/v1/ChurnScoreCalculation(7)/Account",
  "ChurnScore@odata.navigationLink": "https://marketingpony.us1app.churnzero.net/public/v1/ChurnScoreCalculation(7)/ChurnScore"
}

Properties

	Name	Description
	Id number(int64)	Internal identifier for ChurnZero.
	AccountId number(int64)	The ID of the Account associated with this calculation.
	CalculationDay string(date)	The day the calculation was perfromed.
	ChurnScoreId number(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 object	References the Account object.
	ChurnScore object	References the ChurnScore object.

ChurnScoreFactor

Churn Score Factor available in ChurnZero.

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

Properties

	Name	Description
	Id number(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, SuccessInsights, NumberOfNotes, MostRecentNoteDaysFromToday
↓ Show Values ↓			↑ Hide Values ↑
	ChurnScoreId number(int64)	The Id of the Churn Score associated with this Churn Score Factor.
	Name string	The name of the Churn Score Factor.
	Journey object	References the Journey object.
	ChurnScore object	References the ChurnScore object.

ChurnScoreFactorCalculation

Churn Score Factor Calculation available in ChurnZero.

{
  "Id": 1,
  "AccountId": 19,
  "CalculationDay": "2025-10-18",
  "ChurnScoreFactorId": 9,
  "ChurnScoreId": 27,
  "Score": "string",
  "Account@odata.navigationLink": "https://marketingpony.us1app.churnzero.net/public/v1/ChurnScoreFactorCalculation(1)/Account",
  "ChurnScore@odata.navigationLink": "https://marketingpony.us1app.churnzero.net/public/v1/ChurnScoreFactorCalculation(1)/ChurnScore",
  "ChurnScoreFactor@odata.navigationLink": "https://marketingpony.us1app.churnzero.net/public/v1/ChurnScoreFactorCalculation(1)/ChurnScoreFactor"
}

Properties

	Name	Description
	Id number(int64)	Internal identifier for ChurnZero.
	AccountId number(int64)	The ID of the Account associated with this calculation.
	CalculationDay string(date)	The day the calculation was perfromed.
	ChurnScoreFactorId number(int64)	The ID of the Churn Score Factor associated with this calculation.
	ChurnScoreId number(int64)	The ID of the Churn Score associated with this calculation.
	Score number	The calculated Churn Score Factor value.
	Account object	References the Account object.
	ChurnScore object	References the ChurnScore object.
	ChurnScoreFactor object	References the ChurnScoreFactor object.

Contact

Contact available in ChurnZero.

{
  "Id": 8,
  "AccountId": 1,
  "CrmId": "string",
  "Email": "string",
  "ExternalId": "string",
  "FirstName": "string",
  "FullName": "string",
  "LastName": "string",
  "MarketingEmailUnsubscribed": false,
  "Name": "string",
  "ObjectCreatedDate": "2025-10-18T14:00:32.4605244Z",
  "ObjectLastModifiedDate": "2025-10-18T14:00:32.4605244Z",
  "Tags": "string",
  "Account@odata.navigationLink": "https://marketingpony.us1app.churnzero.net/public/v1/Contact(8)/Account"
}

Properties

	Name	Description
	Id number(int64)	Internal identifier for ChurnZero.
	AccountId number(int64)	The Id of the Account associated with this Contact.
	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 object	References 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": 9,
  "AccountId": 28,
  "ContactId": 7,
  "Description": "string",
  "EventDate": "2025-10-18T14:00:32.5927300Z",
  "EventTypeId": 12,
  "Quantity": "string",
  "Contact@odata.navigationLink": "https://marketingpony.us1app.churnzero.net/public/v1/Event(9)/Contact",
  "Account@odata.navigationLink": "https://marketingpony.us1app.churnzero.net/public/v1/Event(9)/Account",
  "EventType@odata.navigationLink": "https://marketingpony.us1app.churnzero.net/public/v1/Event(9)/EventType"
}

Properties

	Name	Description
	Id number(int64)	Internal identifier for ChurnZero.
	AccountId number(int64)	The Id of the Account associated with this Event.
	ContactId number(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 number(int64)	The Id of the type of Event.
	Quantity number(decimal)	The number of times the Event occurred.
	Contact object	References the Contact object.
	Account object	References the Account object.
	EventType object	References the EventType object.

EventType

Event Type available in ChurnZero.

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

Properties

	Name	Description
	Id number(int64)	Internal identifier for ChurnZero.
	Name string	The name of the Event Type.

FollowUpQuestion

Follow up question that can be associated with a survey.

null

Properties

	Name	Description
	Question string	The text of the question.
	AnswerType string	The type of answer associated with the question.

Journey

Journey definition available in ChurnZero.

{
  "Id": 9,
  "Description": "string",
  "ExpectedDuration": 13,
  "IsActive": false,
  "IsSharedExternally": true,
  "Name": "string",
  "ObjectCreatedDate": "2025-10-18T14:00:33.2710428Z",
  "ObjectLastModifiedDate": "2025-10-18T14:00:33.2710428Z",
  "ProgressBottom": 12,
  "ProgressTop": 9,
  "Status": "string"
}

Properties

	Name	Description
	Id number(int64)	Internal identifier for ChurnZero.
	Description string	The description for the Journey.
	ExpectedDuration number(int32)	The number of days an Account is expected to be in the Journey
	IsActive boolean	True if the journey is active.
	IsSharedExternally boolean	True if this Journey is configured for sharing
	Name string	The name of the journey.
	ObjectCreatedDate string(date-time)	The date/time the Journey record was created. ISO 8601 formatted string.
	ObjectLastModifiedDate string(date-time)	The date/time the Journey record was last modified. ISO 8601 formatted string.
	ProgressBottom number(int32)	The number of days beyond which the Account is considered Behind
	ProgressTop number(int32)	The number of days beyond which the Account is considered Stuck
	Status string	The status of the Journey.

JourneyInstance

The JourneyInstance in ChurnZero represents a single progression of an Account through a Journey. On re-entry, the Account will be associated with a new JourneyInstance.

{
  "Id": 6,
  "AccountId": 16,
  "JourneyId": 26,
  "StartDate": "2025-10-18T14:00:33.2711112Z",
  "Account@odata.navigationLink": "https://marketingpony.us1app.churnzero.net/public/v1/JourneyInstance(6)/Account",
  "Journey@odata.navigationLink": "https://marketingpony.us1app.churnzero.net/public/v1/JourneyInstance(6)/Journey"
}

Properties

	Name	Description
	Id number(int64)	Internal identifier for ChurnZero.
	AccountId number(int64)	The Account that this JourneyInstance belongs too.
	JourneyId number(int64)	The Journey that this JourneyInstance belongs too.
	StartDate string(date-time)	The start date of this JourneyInstance ISO 8601 formatted string.
	Account object	References the Account object.
	Journey object	References the Journey object.

JourneyMilestone

JourneyMilestone definition available in ChurnZero.

{
  "Id": 4,
  "Description": "string",
  "ExpectedDuration": 15,
  "JourneyId": 29,
  "Name": "string",
  "ObjectCreatedDate": "2025-10-18T14:00:33.2710605Z",
  "ObjectLastModifiedDate": "2025-10-18T14:00:33.2710605Z",
  "ProgressBottom": 7,
  "ProgressTop": 16,
  "Journey@odata.navigationLink": "https://marketingpony.us1app.churnzero.net/public/v1/JourneyMilestone(4)/Journey"
}

Properties

	Name	Description
	Id number(int64)	Internal identifier for ChurnZero.
	Description string	The description for the JourneyMilestone.
	ExpectedDuration number(int32)	The number of days an Account is expected to be in the JourneyMilestone
	JourneyId number(int64)	The Journey that this JourneyMilestone belongs too.
	Name string	The name of the JourneyMilestone.
	ObjectCreatedDate string(date-time)	The date/time the JourneyMilestone record was created. ISO 8601 formatted string.
	ObjectLastModifiedDate string(date-time)	The date/time the JourneyMilestone record was last modified. ISO 8601 formatted string.
	ProgressBottom number(int32)	The number of days beyond which the Account is considered Behind
	ProgressTop number(int32)	The number of days beyond which the Account is considered Stuck
	Journey object	References the Journey object.

JourneyMilestoneAchievement

JourneyMilestoneAchievement definition available in ChurnZero. This is the template that is used to create an Achievement instance for Accounts that enter the JourneyMilestone.

{
  "Id": 5,
  "IsConditional": true,
  "IsExternallyVisible": false,
  "IsOptional": true,
  "JourneyMilestoneId": 8,
  "Name": "string",
  "ObjectCreatedDate": "2025-10-18T14:00:33.2710781Z",
  "ObjectLastModifiedDate": "2025-10-18T14:00:33.2710781Z",
  "JourneyMilestone@odata.navigationLink": "https://marketingpony.us1app.churnzero.net/public/v1/JourneyMilestoneAchievement(5)/JourneyMilestone"
}

Properties

	Name	Description
	Id number(int64)	Internal identifier for ChurnZero.
	IsConditional boolean	True if this Achievement is conditional.
	IsExternallyVisible boolean	True if this Achievement is externally visible.
	IsOptional boolean	True if this Achievement is optional.
	JourneyMilestoneId number(int64)	The JourneyMilestone that this JourneyMilestoneAchievement belongs too.
	Name string	The name of the JourneyMilestoneAchievement.
	ObjectCreatedDate string(date-time)	The date/time the JourneyMilestoneAchievement record was created. ISO 8601 formatted string.
	ObjectLastModifiedDate string(date-time)	The date/time the JourneyMilestoneAchievement record was last modified. ISO 8601 formatted string.
	JourneyMilestone object	References the JourneyMilestone object.

JourneyMilestoneProgress

Journey Milestone progress of Accounts.

{
  "Id": 6,
  "AccountId": 8,
  "BeginDate": "2025-10-18T14:00:33.2711598Z",
  "DaysIn": 5,
  "DaysLeft": 21,
  "DaysOver": 5,
  "EndDate": "2025-10-18T14:00:33.2711598Z",
  "EvaluationDay": "2025-10-18",
  "IsCompleted": false,
  "IsFailed": true,
  "JourneyId": 19,
  "JourneyInstanceId": 27,
  "JourneyMilestoneId": 1,
  "ObjectCreatedDate": "2025-10-18T14:00:33.2711598Z",
  "ObjectLastModifiedDate": "2025-10-18T14:00:33.2711598Z",
  "Status": "string",
  "Account@odata.navigationLink": "https://marketingpony.us1app.churnzero.net/public/v1/JourneyMilestoneProgress(6)/Account",
  "Journey@odata.navigationLink": "https://marketingpony.us1app.churnzero.net/public/v1/JourneyMilestoneProgress(6)/Journey",
  "JourneyMilestone@odata.navigationLink": "https://marketingpony.us1app.churnzero.net/public/v1/JourneyMilestoneProgress(6)/JourneyMilestone",
  "JourneyInstance@odata.navigationLink": "https://marketingpony.us1app.churnzero.net/public/v1/JourneyMilestoneProgress(6)/JourneyInstance"
}

Properties

	Name	Description
	Id number(int64)	Internal identifier for ChurnZero.
	AccountId number(int64)	The Account associated with this progress.
	BeginDate string(date-time)	The date the Account entered the JourneyMilestone. ISO 8601 formatted string.
	DaysIn number(int32)	The number of days this Account has been in the JourneyMilestone.
	DaysLeft number(int32)	The number of days this Account has left for the JourneyMilestone according to the epectation.
	DaysOver number(int32)	The number of days this Account is over the expectation for the JourneyMilestone.
	EndDate string(date-time)	The date the Account ended the JourneyMilestone. ISO 8601 formatted string.
	EvaluationDay string(date)	The day this JourneyMilestone was evaluated for the Account.
	IsCompleted boolean	True if the Account has completed the JourneyMilestone.
	IsFailed boolean	True if the Account has failed the JourneyMilestone.
	JourneyId number(int64)	The Journey associated with this progress.
	JourneyInstanceId number(int64)	The JourneyInstance assocated with this progress
	JourneyMilestoneId number(int64)	The JourneyMilestone associated with this progress.
	ObjectCreatedDate string(date-time)	The date/time the JourneyMilestoneProgress record was created. ISO 8601 formatted string.
	ObjectLastModifiedDate string(date-time)	The date/time the JourneyMilestoneProgress record was last modified. ISO 8601 formatted string.
	Status string	The Account's status in the JourneyMilestone.
	Account object	References the Account object.
	Journey object	References the Journey object.
	JourneyMilestone object	References the JourneyMilestone object.
	JourneyInstance object	References the JourneyInstance object.

JourneyMilestoneStepProgress

Journey Milestone Step progress of Accounts. This represents the progress of the associated Task or Achievement from the perspective of the Journey.

{
  "Id": 4,
  "AccountId": 25,
  "IsCompleted": false,
  "JourneyId": 2,
  "JourneyInstanceId": 17,
  "JourneyMilestoneAchievementId": 5,
  "JourneyMilestoneId": 10,
  "JourneyMilestoneTaskId": 7,
  "ObjectCreatedDate": "2025-10-18T14:00:33.2711939Z",
  "ObjectLastModifiedDate": "2025-10-18T14:00:33.2711939Z",
  "TaskId": 27,
  "TaskStatusId": 23,
  "Account@odata.navigationLink": "https://marketingpony.us1app.churnzero.net/public/v1/JourneyMilestoneStepProgress(4)/Account",
  "Journey@odata.navigationLink": "https://marketingpony.us1app.churnzero.net/public/v1/JourneyMilestoneStepProgress(4)/Journey",
  "JourneyMilestone@odata.navigationLink": "https://marketingpony.us1app.churnzero.net/public/v1/JourneyMilestoneStepProgress(4)/JourneyMilestone",
  "JourneyInstance@odata.navigationLink": "https://marketingpony.us1app.churnzero.net/public/v1/JourneyMilestoneStepProgress(4)/JourneyInstance",
  "JourneyMilestoneAchievement@odata.navigationLink": "https://marketingpony.us1app.churnzero.net/public/v1/JourneyMilestoneStepProgress(4)/JourneyMilestoneAchievement",
  "JourneyMilestoneTask@odata.navigationLink": "https://marketingpony.us1app.churnzero.net/public/v1/JourneyMilestoneStepProgress(4)/JourneyMilestoneTask",
  "Task@odata.navigationLink": "https://marketingpony.us1app.churnzero.net/public/v1/JourneyMilestoneStepProgress(4)/Task",
  "TaskStatus@odata.navigationLink": "https://marketingpony.us1app.churnzero.net/public/v1/JourneyMilestoneStepProgress(4)/TaskStatus"
}

Properties

	Name	Description
	Id number(int64)	Internal identifier for ChurnZero.
	AccountId number(int64)	The Account associated with this progress.
	IsCompleted boolean	True if the Account has completed the JourneyMilestone.
	JourneyId number(int64)	The Journey associated with this progress.
	JourneyInstanceId number(int64)	The JourneyInstance assocated with this progress.
	JourneyMilestoneAchievementId number(int64)	The JourneyMilestoneAchievement associated with this progress. This may be null and is mutually exclusive with JourneyMilestoneTaskId.
	JourneyMilestoneId number(int64)	The JourneyMilestone associated with this progress.
	JourneyMilestoneTaskId number(int64)	The JourneyMilestoneTask associated with this progress. This may be null and is mutually exclusive with JourneyMilestoneAchievementId.
	ObjectCreatedDate string(date-time)	The date/time the JourneyMilestoneStepProgress record was created. ISO 8601 formatted string.
	ObjectLastModifiedDate string(date-time)	The date/time the JourneyMilestoneStepProgress record was last modified. ISO 8601 formatted string.
	TaskId number(int64)	The Task associated with this progress.
	TaskStatusId number(int64)	The overall status associated with the Task or Achievement represented by this progress.
	Account object	References the Account object.
	Journey object	References the Journey object.
	JourneyMilestone object	References the JourneyMilestone object.
	JourneyInstance object	References the JourneyInstance object.
	JourneyMilestoneAchievement object	References the JourneyMilestoneAchievement object.
	JourneyMilestoneTask object	References the JourneyMilestoneTask object.
	Task object	References the Task object.
	TaskStatus object	References the TaskStatus object.

JourneyMilestoneTask

JourneyMilestoneTask definition available in ChurnZero. This is the template that is used to create a Task instance for Accounts that enter the JourneyMilestone.

{
  "Id": 3,
  "IsConditional": false,
  "IsExternallyVisible": false,
  "IsOptional": false,
  "JourneyMilestoneId": 28,
  "ObjectCreatedDate": "2025-10-18T14:00:33.2710947Z",
  "ObjectLastModifiedDate": "2025-10-18T14:00:33.2710947Z",
  "Subject": "string",
  "JourneyMilestone@odata.navigationLink": "https://marketingpony.us1app.churnzero.net/public/v1/JourneyMilestoneTask(3)/JourneyMilestone"
}

Properties

	Name	Description
	Id number(int64)	Internal identifier for ChurnZero.
	IsConditional boolean	True if this Task is conditional.
	IsExternallyVisible boolean	True if this Task is externally visible.
	IsOptional boolean	True if this Task is optional.
	JourneyMilestoneId number(int64)	The JourneyMilestone that this JourneyMilestoneTask belongs too.
	ObjectCreatedDate string(date-time)	The date/time the JourneyMilestoneTask record was created. ISO 8601 formatted string.
	ObjectLastModifiedDate string(date-time)	The date/time the JourneyMilestoneTask record was last modified. ISO 8601 formatted string.
	Subject string	The subject of the JourneyMilestoneTask.
	JourneyMilestone object	References the JourneyMilestone object.

JourneyProgress

Journey progress of Accounts.

{
  "Id": 8,
  "AccountId": 25,
  "BeginDate": "2025-10-18T14:00:33.2711271Z",
  "DaysIn": 26,
  "DaysLeft": 1,
  "DaysOver": 21,
  "EndDate": "2025-10-18T14:00:33.2711271Z",
  "EvaluationDay": "2025-10-18",
  "FailureComments": "string",
  "FailureReasons": "string",
  "IsCompleted": true,
  "IsFailed": true,
  "JourneyId": 23,
  "JourneyInstanceId": 5,
  "ObjectCreatedDate": "2025-10-18T14:00:33.2711271Z",
  "ObjectLastModifiedDate": "2025-10-18T14:00:33.2711271Z",
  "Status": "string",
  "Account@odata.navigationLink": "https://marketingpony.us1app.churnzero.net/public/v1/JourneyProgress(8)/Account",
  "Journey@odata.navigationLink": "https://marketingpony.us1app.churnzero.net/public/v1/JourneyProgress(8)/Journey",
  "JourneyInstance@odata.navigationLink": "https://marketingpony.us1app.churnzero.net/public/v1/JourneyProgress(8)/JourneyInstance"
}

Properties

	Name	Description
	Id number(int64)	Internal identifier for ChurnZero.
	AccountId number(int64)	The Account associated with this progress.
	BeginDate string(date-time)	The date the Account entered the Journey. ISO 8601 formatted string.
	DaysIn number(int32)	The number of days this Account has been in the Journey.
	DaysLeft number(int32)	The number of days this Account has left for the Journey according to the epectation.
	DaysOver number(int32)	The number of days this Account is over the expectation for the Journey.
	EndDate string(date-time)	The date the Account ended the Journey. ISO 8601 formatted string.
	EvaluationDay string(date)	The day this Journey was evaluated for the Account.
	FailureComments string	Free form comments associated with the Account failing the Journey.
	FailureReasons string	The set of predefined reasons for failing the Journey.
	IsCompleted boolean	True if the Account has completed the Journey.
	IsFailed boolean	True if the Account has failed the Journey.
	JourneyId number(int64)	The Journey associated with this progress.
	JourneyInstanceId number(int64)	The JourneyInstance assocated with this progress
	ObjectCreatedDate string(date-time)	The date/time the JourneyProgress record was created. ISO 8601 formatted string.
	ObjectLastModifiedDate string(date-time)	The date/time the JourneyProgress record was last modified. ISO 8601 formatted string.
	Status string	The Account's status in the Journey.
	Account object	References the Account object.
	Journey object	References the Journey object.
	JourneyInstance object	References the JourneyInstance object.

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 number(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 object	References the RelatedAccountChurnScore object.
	CalculationDay string(date)	The day the calculation was perfromed.
	IsPrimary boolean	True if the Churn Score is primary.
	Score number	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 number(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 number(int32)	The number of days the Account has been in the journey.
	DaysOver number(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 number(int64)	Internal identifier for ChurnZero.
	Name string	The name of the Account Role.
	UserAccount object	References 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 number(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 number	The NPS survey score for the Account.
	CSAT number	The CSAT survey score for the Account.
	CES number	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 object.
	Events array[object]	References the object.
	AggrgegateDuration string	The Duration used for the aggregate.
	ActiveDays number(int32)	The calculated number of Active Days.
	ActiveContacts number(int32)	The calculated number of Active Contacts.
	LicenseUtilization number(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 object.
	RoleManagers array[object]	References the object.
	ChurnScores array[object]	References the object.
	Journeys array[object]	References the object.
	ChurnScoreHistory array[object]	References the object.
	MostRecentSurveyResponses object	References 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 number(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 object	References the RelatedContactSurveyResponse object.
	CSAT object	References the RelatedContactSurveyResponse object.
	CES object	References 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 object	References the RelatedEventType object.
	TotalEvents number(int32)	The number of Total Events for the Event Type.
	DistinctContacts number(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 number(int32)	The sum of Events for the Event Type.
	EventMostRecentQuantity number(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 number(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 number(int32)

Segment

Segment available in ChurnZero.

{
  "Id": 9,
  "Entity": "string",
  "IsGlobal": false,
  "Name": "string",
  "ObjectCreatedDate": "2025-10-18T14:00:32.5927678Z",
  "ObjectLastModifiedDate": "2025-10-18T14:00:32.5927678Z",
  "UserAccountId": 14,
  "UserAccount@odata.navigationLink": "https://marketingpony.us1app.churnzero.net/public/v1/Segment(9)/UserAccount"
}

Properties

	Name	Description
	Id number(int64)	Internal identifier for ChurnZero.
	Entity string	The Entity associated with this Segment.
Account, Contact, Event, Task, CustomListOpportunities, CustomListExpansionUpsellTracking, CustomListProductsPurchased, CustomListTicket, CustomListExecutiveBusinessReviewGoals, CustomListProductFeedback, CustomListCourseCompletions, CustomListQuizCompletion, CustomListHigherLogicVanillaActivity, CustomListSalesToCSHandoff, CustomListCustomerSuccessStory, CustomListCommitments, CustomListCourseActivity, CustomListSuccessPlan, CustomListStrategicInitiatives, CustomListGG, CustomListFinancialData, CustomListRelationships, CustomListProcesscounttable, CustomListCampaigns
↓ 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.
	UserAccountId number(int64)	The Segment owner's Id.
	UserAccount object	References the UserAccount object.

SegmentColumnSet

SegmentColumnSet available in ChurnZero.

{
  "Id": 1,
  "Entity": "string",
  "Name": "string",
  "ObjectCreatedDate": "2025-10-18T14:00:32.9369349Z",
  "ObjectLastModifiedDate": "2025-10-18T14:00:32.9369349Z",
  "ShareType": "string",
  "UserAccountId": 25,
  "UserAccount@odata.navigationLink": "https://marketingpony.us1app.churnzero.net/public/v1/SegmentColumnSet(1)/UserAccount"
}

Properties

	Name	Description
	Id number(int64)	Internal identifier for ChurnZero.
	Entity string	The entity associated with this SegmentColumnSet.
Account, Contact, Event, Task, CustomListOpportunities, CustomListExpansionUpsellTracking, CustomListProductsPurchased, CustomListTicket, CustomListExecutiveBusinessReviewGoals, CustomListProductFeedback, CustomListCourseCompletions, CustomListQuizCompletion, CustomListHigherLogicVanillaActivity, CustomListSalesToCSHandoff, CustomListCustomerSuccessStory, CustomListCommitments, CustomListCourseActivity, CustomListSuccessPlan, CustomListStrategicInitiatives, CustomListGG, CustomListFinancialData, CustomListRelationships, CustomListProcesscounttable, CustomListCampaigns
↓ 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 number(int64)	The SegmentColumnSet owner's Id.
	UserAccount object	References the UserAccount object.

Survey

Survey definition available in ChurnZero.

{
  "Id": 2,
  "CampaignStatus": "string",
  "CampaignType": "string",
  "DripOverMonths": 18,
  "FollowUpQuestions": "string",
  "IsActive": false,
  "Name": "string",
  "RecurringEveryMonths": 29,
  "SegmentIds": "string",
  "Settings@odata.navigationLink": "https://marketingpony.us1app.churnzero.net/public/v1/Survey(2)/Settings",
  "SurveyQuestion": "string",
  "SurveyType": "string"
}

Properties

	Name	Description
	Id number(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 number(int32)	The drip rate of the survey.
	FollowUpQuestions array[object]	References the object.
	IsActive boolean	If the survey is active.
	Name string	The name of the survey.
	RecurringEveryMonths number(int32)	The number of months until the survey reoccurs.
	SegmentIds array[number]	References the object.
	Settings object	References 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": 3,
  "AccountId": 5,
  "Comment": "string",
  "ContactId": 1,
  "FollowUpAnswerType": "string",
  "FollowUpQuestion": "string",
  "FollowUpResponse": "string",
  "NextReminderDate": "2025-10-18T14:00:33.2709092Z",
  "ResponseDate": "2025-10-18T14:00:33.2709092Z",
  "ResponseSource": "string",
  "Score": 13,
  "SurveyId": 29,
  "Account@odata.navigationLink": "https://marketingpony.us1app.churnzero.net/public/v1/SurveyResponse(3)/Account",
  "Contact@odata.navigationLink": "https://marketingpony.us1app.churnzero.net/public/v1/SurveyResponse(3)/Contact",
  "Survey@odata.navigationLink": "https://marketingpony.us1app.churnzero.net/public/v1/SurveyResponse(3)/Survey"
}

Properties

	Name	Description
	Id number(int64)	Internal identifier for ChurnZero.
	AccountId number(int64)	The ID of the Account associated with this survey response.
	Comment string	The comment that was given for the survey response.
	ContactId number(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 number(int32)	The score that was given for the survey response.
	SurveyId number(int64)	The ID of the Survey associated with this survey response.
	Account object	References the Account object.
	Contact object	References the Contact object.
	Survey object	References the Survey object.

SurveySettings

Additional settings on a survey.

null

Properties

	Name	Description
	ChoiceCount number(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": 4,
  "AccountId": 19,
  "CloseDate": "2025-10-18T14:00:33.2707887Z",
  "Comments": "string",
  "ContactId": 5,
  "CrmId": "string",
  "DueDate": "2025-10-18T14:00:33.2707887Z",
  "IsClosed": false,
  "IsHighPriority": true,
  "ObjectCreatedDate": "2025-10-18T14:00:33.2707887Z",
  "ObjectLastModifiedDate": "2025-10-18T14:00:33.2707887Z",
  "Subject": "string",
  "TaskPriorityId": 18,
  "TaskStatusId": 18,
  "TaskType": "string",
  "UserAccountId": 3,
  "Account@odata.navigationLink": "https://marketingpony.us1app.churnzero.net/public/v1/Task(4)/Account",
  "Contact@odata.navigationLink": "https://marketingpony.us1app.churnzero.net/public/v1/Task(4)/Contact",
  "UserAccount@odata.navigationLink": "https://marketingpony.us1app.churnzero.net/public/v1/Task(4)/UserAccount",
  "TaskPriority@odata.navigationLink": "https://marketingpony.us1app.churnzero.net/public/v1/Task(4)/TaskPriority",
  "TaskStatus@odata.navigationLink": "https://marketingpony.us1app.churnzero.net/public/v1/Task(4)/TaskStatus"
}

Properties

	Name	Description
	Id number(int64)	Internal identifier for ChurnZero.
	AccountId number(int64)	The Id of the Account associated with this Task.
	CloseDate string(date-time)	The close date of the Task. ISO 8601 formatted string.
	Comments string	Comments related to the task.
	ContactId number(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 number(int64)	The Id of the Task's Priority.
	TaskStatusId number(int64)	The Id of the Task's Status.
	TaskType string	The type of the Task.
	UserAccountId number(int64)	The Task owner's Id.
	Account object	References the Account object.
	Contact object	References the Contact object.
	UserAccount object	References the UserAccount object.
	TaskPriority object	References the TaskPriority object.
	TaskStatus object	References the TaskStatus object.

TaskPriority

Task Priority available in ChurnZero.

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

Properties

	Name	Description
	Id number(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": 4,
  "IsClosed": true,
  "IsDefault": false,
  "Name": "string"
}

Properties

	Name	Description
	Id number(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": 5,
  "AvatarUrl": "string",
  "CanLogIn": true,
  "CrmId": "string",
  "Email": "string",
  "FirstName": "string",
  "HasAccounts": false,
  "IsActive": true,
  "LastName": "string",
  "MobilePhone": "string",
  "Name": "string",
  "ObjectCreatedDate": "2025-10-18T14:00:32.5926853Z",
  "ObjectLastModifiedDate": "2025-10-18T14:00:32.5926853Z",
  "OfficePhone": "string",
  "Title": "string",
  "UserName": "string"
}

Properties

	Name	Description
	Id number(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.
	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.