ESHOPMANESHOPMAN Logo
Our Blog

Unlock User Data: Accessing Phone Numbers via HubSpot API

Ever found yourself needing to programmatically access user or owner phone numbers within HubSpot? It's a common requirement for integrations, custom reporting, and automating certain sales or marketing workflows. A user in the HubSpot Community recently ran into this exact issue and asked for help.

The Question: Accessing User Phone Numbers via API

The original poster was looking for a way to retrieve user/owner phone numbers using the HubSpot API. They needed to access this information to integrate it with another system.

The Solution: CRM Objects API to the Rescue

After some digging, the original poster discovered the answer themselves! The key is using the CRM Objects API, specifically the endpoint for users:

/crm/v3/objects/users

By making a request to this endpoint and specifying the hs_main_phone property, you can retrieve the phone numbers associated with users in your HubSpot account.

Here's a breakdown of the steps:

  1. Authenticate: Ensure you have the necessary API key or OAuth token to access the HubSpot API.
  2. Make the Request: Send a GET request to the /crm/v3/objects/users endpoint.
  3. Specify Properties: Include hs_main_phone in the properties query parameter to retrieve the phone number. For example: 
    /crm/v3/objects/users?properties=hs_main_phone
  4. Parse the Response: The API will return a JSON response containing user objects. Each object will include the hs_main_phone property if a phone number is associated with that user.

Here's an example of what the API response might look like:


{
  "results": [
    {
      "id": "12345",
      "properties": {
        "hs_main_phone": "555-123-4567"
      },
      "createdAt": "2023-10-26T10:00:00.000Z",
      "updatedAt": "2023-10-27T12:00:00.000Z",
      "archived": false
    },
    {
      "id": "67890",
      "properties": {
        "hs_main_phone": "555-987-6543"
      },
      "createdAt": "2023-11-15T08:00:00.000Z",
      "updatedAt": "2023-11-16T14:00:00.000Z",
      "archived": false
    }
  ]
}

Remember to handle pagination if you have a large number of users. The API will return a limited number of results per page, so you'll need to use the after parameter to retrieve subsequent pages.

Important Considerations

  • Permissions: Ensure your API key or OAuth token has the necessary permissions to access the CRM Objects API and user data.
  • Rate Limits: Be mindful of HubSpot's API rate limits to avoid being throttled.
  • Data Privacy: Always handle user data responsibly and in compliance with privacy regulations.

For those looking for an easy web store builder that integrates seamlessly with HubSpot, consider exploring options that offer built-in API integrations to streamline data access and management.

ESHOPMAN Team Comment

This community thread highlights a common need for HubSpot users: accessing specific data points via the API. The CRM Objects API is a powerful tool, and the discovery of the hs_main_phone property is a valuable shortcut. We recommend thoroughly exploring the API documentation to uncover other useful properties and endpoints that can enhance your HubSpot integrations. Understanding how to leverage these APIs is crucial for building custom solutions that meet your specific business needs.

By understanding how to access user phone numbers, you can build more robust integrations and automations within your HubSpot ecosystem.

Share: