Skip to main content
GET
/
contacts
/
search
/
v1
/
external
/
lifecyclestages
Get Lifecycle Stage metrics for Contacts
curl --request GET \
  --url https://api.hubapi.com/contacts/search/v1/external/lifecyclestages
"[ { \"lifecycleStage\": \"hs_lifecyclestage_lead_date\", \"count\": 34657 }, { \"lifecycleStage\": \"hs_lifecyclestage_opportunity_date\", \"count\": 1 }, { \"lifecycleStage\": \"hs_lifecyclestage_marketingqualifiedlead_date\", \"count\": 3 }, { \"lifecycleStage\": \"hs_lifecyclestage_salesqualifiedlead_date\", \"count\": 0 }, { \"lifecycleStage\": \"hs_lifecyclestage_evangelist_date\", \"count\": 0 }, { \"lifecycleStage\": \"hs_lifecyclestage_customer_date\", \"count\": 242 }, { \"lifecycleStage\": \"hs_lifecyclestage_subscriber_date\", \"count\": 39 }, { \"lifecycleStage\": \"hs_lifecyclestage_other_date\", \"count\": 0 } ] Example with aggregation using hs_analytics_source:  [ { \"lifecycleStage\": \"hs_lifecyclestage_lead_date\", \"count\": 34657, \"aggregation\": { \"count\": 34657, \"aggregations\": { \"hs_analytics_source\": [ { \"key\": \"DIRECT_TRAFFIC\", \"count\": 30794 }, { \"key\": \"OFFLINE\", \"count\": 3822 }, { \"key\": \"PAID_SOCIAL\", \"count\": 18 } ] } } }, { \"lifecycleStage\": \"hs_lifecyclestage_opportunity_date\", \"count\": 1, \"aggregation\": { \"count\": 1, \"aggregations\": { \"hs_analytics_source\": [ { \"key\": \"OFFLINE\", \"count\": 1 } ] } } }, { \"lifecycleStage\": \"hs_lifecyclestage_marketingqualifiedlead_date\", \"count\": 3, \"aggregation\": { \"count\": 3, \"aggregations\": { \"hs_analytics_source\": [ { \"key\": \"DIRECT_TRAFFIC\", \"count\": 2 }, { \"key\": \"OFFLINE\", \"count\": 1 } ] } } }, { \"lifecycleStage\": \"hs_lifecyclestage_salesqualifiedlead_date\", \"count\": 0, \"aggregation\": { \"count\": 0, \"aggregations\": { \"hs_analytics_source\": [] } } }, { \"lifecycleStage\": \"hs_lifecyclestage_evangelist_date\", \"count\": 0, \"aggregation\": { \"count\": 0, \"aggregations\": { \"hs_analytics_source\": [] } } }, { \"lifecycleStage\": \"hs_lifecyclestage_customer_date\", \"count\": 242, \"aggregation\": { \"count\": 242, \"aggregations\": { \"hs_analytics_source\": [ { \"key\": \"OFFLINE\", \"count\": 169 }, { \"key\": \"DIRECT_TRAFFIC\", \"count\": 73 } ] } } }, { \"lifecycleStage\": \"hs_lifecyclestage_subscriber_date\", \"count\": 39, \"aggregation\": { \"count\": 39, \"aggregations\": { \"hs_analytics_source\": [ { \"key\": \"DIRECT_TRAFFIC\", \"count\": 26 }, { \"key\": \"OFFLINE\", \"count\": 13 } ] } } }, { \"lifecycleStage\": \"hs_lifecyclestage_other_date\", \"count\": 0, \"aggregation\": { \"count\": 0, \"aggregations\": { \"hs_analytics_source\": [] } } } ]"

​
Required Scopes

This API requires one of the following scopes:
  • crm.objects.contacts.read
  • content
  • crm.objects.contacts.write

Query Parameters

​
includeTotalContacts
string

A boolean to determine if the number of total contacts should be included in the response.

​
includeLastNewContactAt
string

A boolean to determine if the time stamp of the last contact created should be included in the response.

Response

200 - application/json

Successful response - Returns the total number of contacts in the account and the date of the last contact add

The response is of type object.