APIs & Integrations

TUser7
Member

Can you get contact lifecycle stage defaults via an API?

SOLVE

You can add custom lifecycle stages to a Contact record as well as setting default stages that will be used automatically in certain scenarios as shown in the attached image:

 

Screen Shot 2022-07-20 at 3.41.25 PM.png

 

Is there any API endpoint to access these default values? I can get all the lifecycle stages via this endpoint, https://api.hubapi.com/crm/v3/properties/contacts/lifecyclestage, but I'd like to also get these default values.

0 Upvotes
1 Accepted solution
TUser7
Solution
Member

Can you get contact lifecycle stage defaults via an API?

SOLVE

Hi Jaycee, thank you for your quick reply! However, this wasn't exactly the information I was looking for. The v3 enpoint I posted in my question returns the same information as the v1 endpoint you used.

 

Just to close the loop, I sopke with a HubSpot rep who told me the default lifecycle data is not available via an API at this time.

View solution in original post

0 Upvotes
2 Replies 2
Jaycee_Lewis
Community Manager
Community Manager

Can you get contact lifecycle stage defaults via an API?

SOLVE

Hey, @TUser7 👋 Have you tried using this endpoint — Get a contact property

 

I set up a quick test in postman

GET https://api.hubapi.com/properties/v1/contacts/properties/named/lifecyclestage

Which returned

{
    "name": "lifecyclestage",
    "label": "Lifecycle Stage",
    "description": "The qualification of contacts to sales readiness. It can be set through imports, forms, workflows, and manually on a per contact basis.",
    "groupName": "contactinformation",
    "type": "enumeration",
    "fieldType": "radio",
    "fieldLevelPermission": null,
    "hidden": false,
    "options": [
        {
            "hidden": false,
            "label": "Subscriber",
            "displayOrder": 0,
            "doubleData": null,
            "readOnly": null,
            "value": "subscriber",
            "description": null
        },
        {
            "hidden": false,
            "label": "Lead",
            "displayOrder": 1,
            "doubleData": null,
            "readOnly": null,
            "value": "lead",
            "description": null
        },
        {
            "hidden": false,
            "label": "Marketing Qualified Lead",
            "displayOrder": 2,
            "doubleData": null,
            "readOnly": null,
            "value": "marketingqualifiedlead",
            "description": null
        },
        {
            "hidden": false,
            "label": "Sales Qualified Lead",
            "displayOrder": 3,
            "doubleData": null,
            "readOnly": null,
            "value": "salesqualifiedlead",
            "description": null
        },
        {
            "hidden": false,
            "label": "Opportunity",
            "displayOrder": 4,
            "doubleData": null,
            "readOnly": null,
            "value": "opportunity",
            "description": null
        },
        {
            "hidden": false,
            "label": "Customer",
            "displayOrder": 5,
            "doubleData": null,
            "readOnly": null,
            "value": "customer",
            "description": null
        },
        {
            "hidden": false,
            "label": "Evangelist",
            "displayOrder": 6,
            "doubleData": null,
            "readOnly": null,
            "value": "evangelist",
            "description": null
        },
        {
            "hidden": false,
            "label": "Other",
            "displayOrder": 7,
            "doubleData": null,
            "readOnly": null,
            "value": "other",
            "description": null
        }
    ],
    "readOnlyDefinition": true,
    "formField": true,
    "displayOrder": 15,
    "readOnlyValue": false,
    "mutableDefinitionNotDeletable": false,
    "favorited": false,
    "favoritedOrder": -1,
    "calculated": false,
    "externalOptions": false,
    "displayMode": "current_value",
    "showCurrencySymbol": null,
    "hubspotDefined": true,
    "referencedObjectType": null,
    "externalOptionsReferenceType": null,
    "optionSortStrategy": null,
    "createdUserId": null,
    "searchableInGlobalSearch": false,
    "hasUniqueValue": false,
    "numberDisplayHint": null,
    "textDisplayHint": null,
    "optionsAreMutable": null,
    "searchTextAnalysisMode": null,
    "isCustomizedDefault": false,
    "updatedUserId": null,
    "deleted": null,
    "updatedAt": 1653690692655,
    "createdAt": 1565059269102,
    "currencyPropertyName": null
}

and lists the internal values you are after 

CleanShot 2022-07-21 at 12.14.43.png

 

Best,

Jaycee





loop


Loop Marketing is a new four-stage approach that combines AI efficiency and human authenticity to drive growth.

Learn More




0 Upvotes
TUser7
Solution
Member

Can you get contact lifecycle stage defaults via an API?

SOLVE

Hi Jaycee, thank you for your quick reply! However, this wasn't exactly the information I was looking for. The v3 enpoint I posted in my question returns the same information as the v1 endpoint you used.

 

Just to close the loop, I sopke with a HubSpot rep who told me the default lifecycle data is not available via an API at this time.

0 Upvotes