Upcoming Sunset: v2 Owners API

In version 2 there was an attribute called “type” that use to returned “PERSON” or “QUEUE” values. In version 3 this attribute does not longer exists. How can I differenciate now which type of owner I’m receiving?

Hi @VIntegrations, I apologize for missing this comment! I have reached out to our engineering team about adding the “type” property. We are aiming to incorporate this into the new v3 Owners API. I expect to receive more feedback from our engineering team by next week. Thank you!

@VIntegrations—Good news! Our engineering staff was able to include the type field in the result. Feel free to try it out, and please let me know if there are any issues! The API documentation for the v3 Owners API will soon reflect this new type.

V2 returned the “signature” property for owner (if it exists). V3 does not. Can this be added? If not is there anyway to get this property with the API?

Hi @JSincavage - Hello! Thank you for your question and for inquiring about this prop.

Initially, we thought this would be a straightforward addition. However, we must coordinate with another team to evaluate the feasibility. In the meantime, we are reviewing your request in more detail and will let you know as soon as we have more information. Thank you for your patience and understanding!

Hi @hseligson,
With regards to the upcoming sunset, I have a requirement of fetching users who are active (isActive field in v2 version set to true). How do I identify such users in v3 API, as its returning active and inactive users in the response and there is no field to distinguish the same.
P.S The archived field is false for 2 users. However, one user is active and the other one is inactive (as seen in the Hubspot UI


Inactive user as seen on Hubspot UI

Both active and inactive users returned in the v4 response

@PranavRD - Thank you for sharing this use case! I shared this with one of our engineers, who pointed out that the user (userId: 64483100) shared on the screenshot above seems active based on the User API. The Owners API returns the same result as the Users API, indicating that the user is active, so the userId field is populated, archived, and set to false. Can you clarify what filter/spec you used to indicate that the user is inactive - was this only the UI, and did you deactivate or remove the user when it prompted you to review?
We ask because it’s best to follow the instructions in the v3 Owners API doc to distinguish whether a user is active. If you request all inactive users to a specific portal using the archived=true in your query param, it returns inactive users. For example, if you leverage: crm/v3/owners?portalId={portalId}&archived=true the response will look something like this:

{
 "results":[
 {
 "id":"643062423",
 "email":"user@example.com",
 "firstName":"conflict",
 "lastName":"user",
 "userId":null,
 "userIdIncludingInactive":62387149,
 "createdAt":"2023-12-10T07:54:25.141Z",
 "updatedAt":"2024-08-26T07:46:37.609Z",
 "archived":true
 }
 ]
}

@hseligson Thank you for the quick response!
In Hubspot UI, as attached in the above screenshot, there is an Inactive Users section which redirected me to the page showing 1 record whose last active was more than 6 months old. I am also attaching the filter/spec that is being shown in the UI.


Filter/spec applied on clicking review users under Inactive Users option
I am also little curious to know on how a user is considered as inactive in Hubspot.
1. Is it when they have not logged in last 90 days as shown in the UI?

2. Is it when the user is deactivated?, or

3. Is it when the user is deactivated and deleted from Hubspot?

Hi @PranavRD, Of course! HubSpot users are considered inactive based on their last login activity. However, the exact criteria for determining inactive users may vary depending on how HubSpot has been configured by your organization.
To add your specific questions:

  • In many cases, an inactive user is classified as someone who has not logged into HubSpot within a certain period of time, such as 90 days. This is a common threshold used in many systems to identify inactive users.
  • Inactive users can also include those who have been deactivated by an administrator. Deactivating a user typically means that they are no longer able to access the system or perform any actions within it.
  • If a user is both deactivated and deleted from HubSpot, they would likely be considered permanently removed from the system and no longer counted as an active user.
  • The criteria for identifying inactive users can be customized in HubSpot, so it’s always a good idea to check with your system administrator or refer to your organization’s specific policies to better understand how inactive users are managed within your HubSpot instance.

I hope this information helps!

Hi,

How much time should we expect to dedicate to this project?

Hi @SHinojosa3, Thank you for your question! Unfortunately, we can’t estimate this. If you’re a developer, the changelog and the v3 Owners API documentation should have the technical details to identify the steps needed to update your integration.
However, if you need a developer or developer resources, I suggest you contact your CSM (Customer Success Manager) or browse our solution partners to help you make the necessary changes!