Batch

Read a batch of users by internal ID, or unique property values

Changed on Oct 13, 2026

Retrieve records by record ID or include the idProperty parameter to retrieve records by a custom unique value property.

post/crm/objects/2026-09/users/batch/read

Request

Base URL
https://api.hubapi.com
URL
https://api.hubapi.com/crm/objects/2026-09/users/batch/read
Auth
- OAuth 2
  Authorization code: https://app.hubspot.com/oauth/authorize
  Token URL: https://api.hubapi.com/oauth/v1/token scopes: crm.objects.deals.read
- or OAuth 2
  Authorization code: https://app.hubspot.com/oauth/authorize
  Token URL: https://api.hubapi.com/oauth/v1/token scopes: crm.objects.subscriptions.read
- or OAuth 2
  Authorization code: https://app.hubspot.com/oauth/authorize
  Token URL: https://api.hubapi.com/oauth/v1/token scopes: crm.objects.services.read
- or OAuth 2
  Authorization code: https://app.hubspot.com/oauth/authorize
  Token URL: https://api.hubapi.com/oauth/v1/token scopes: crm.objects.tickets.sensitive.read
- or OAuth 2
  Authorization code: https://app.hubspot.com/oauth/authorize
  Token URL: https://api.hubapi.com/oauth/v1/token scopes: crm.objects.orders.read
- or OAuth 2
  Authorization code: https://app.hubspot.com/oauth/authorize
  Token URL: https://api.hubapi.com/oauth/v1/token scopes: crm.objects.listings.write
- or OAuth 2
  Authorization code: https://app.hubspot.com/oauth/authorize
  Token URL: https://api.hubapi.com/oauth/v1/token scopes: crm.objects.custom.read
- or OAuth 2
  Authorization code: https://app.hubspot.com/oauth/authorize
  Token URL: https://api.hubapi.com/oauth/v1/token scopes: crm.objects.companies.write
- or OAuth 2
  Authorization code: https://app.hubspot.com/oauth/authorize
  Token URL: https://api.hubapi.com/oauth/v1/token scopes: crm.objects.tasks.read
- or OAuth 2
  Authorization code: https://app.hubspot.com/oauth/authorize
  Token URL: https://api.hubapi.com/oauth/v1/token scopes: crm.objects.custom.sensitive.write.v2
- or OAuth 2
  Authorization code: https://app.hubspot.com/oauth/authorize
  Token URL: https://api.hubapi.com/oauth/v1/token scopes: crm.objects.custom.highly_sensitive.write.v2
- or OAuth 2
  Authorization code: https://app.hubspot.com/oauth/authorize
  Token URL: https://api.hubapi.com/oauth/v1/token scopes: crm.objects.companies.read
- or OAuth 2
  Authorization code: https://app.hubspot.com/oauth/authorize
  Token URL: https://api.hubapi.com/oauth/v1/token scopes: crm.objects.appointments.sensitive.read.v2
- or OAuth 2
  Authorization code: https://app.hubspot.com/oauth/authorize
  Token URL: https://api.hubapi.com/oauth/v1/token scopes: crm.objects.contacts.highly_sensitive.read.v2
- or OAuth 2
  Authorization code: https://app.hubspot.com/oauth/authorize
  Token URL: https://api.hubapi.com/oauth/v1/token scopes: crm.objects.tickets.highly_sensitive.read
- or OAuth 2
  Authorization code: https://app.hubspot.com/oauth/authorize
  Token URL: https://api.hubapi.com/oauth/v1/token scopes: crm.objects.companies.sensitive.read.v2
- or OAuth 2
  Authorization code: https://app.hubspot.com/oauth/authorize
  Token URL: https://api.hubapi.com/oauth/v1/token scopes: crm.objects.tickets.sensitive.write
- or OAuth 2
  Authorization code: https://app.hubspot.com/oauth/authorize
  Token URL: https://api.hubapi.com/oauth/v1/token scopes: media_bridge.read
- or OAuth 2
  Authorization code: https://app.hubspot.com/oauth/authorize
  Token URL: https://api.hubapi.com/oauth/v1/token scopes: crm.objects.deals.highly_sensitive.read.v2
- or OAuth 2
  Authorization code: https://app.hubspot.com/oauth/authorize
  Token URL: https://api.hubapi.com/oauth/v1/token scopes: crm.objects.contacts.highly_sensitive.write.v2
- or OAuth 2
  Authorization code: https://app.hubspot.com/oauth/authorize
  Token URL: https://api.hubapi.com/oauth/v1/token scopes: crm.objects.companies.highly_sensitive.read.v2
- or OAuth 2
  Authorization code: https://app.hubspot.com/oauth/authorize
  Token URL: https://api.hubapi.com/oauth/v1/token scopes: crm.objects.commercepayments.write
- or OAuth 2
  Authorization code: https://app.hubspot.com/oauth/authorize
  Token URL: https://api.hubapi.com/oauth/v1/token scopes: crm.objects.invoices.write
- or OAuth 2
  Authorization code: https://app.hubspot.com/oauth/authorize
  Token URL: https://api.hubapi.com/oauth/v1/token scopes: crm.objects.contacts.sensitive.write.v2
- or OAuth 2
  Authorization code: https://app.hubspot.com/oauth/authorize
  Token URL: https://api.hubapi.com/oauth/v1/token scopes: crm.objects.calls.read
- or OAuth 2
  Authorization code: https://app.hubspot.com/oauth/authorize
  Token URL: https://api.hubapi.com/oauth/v1/token scopes: crm.objects.users.write
- or OAuth 2
  Authorization code: https://app.hubspot.com/oauth/authorize
  Token URL: https://api.hubapi.com/oauth/v1/token scopes: crm.objects.meetings.read
- or OAuth 2
  Authorization code: https://app.hubspot.com/oauth/authorize
  Token URL: https://api.hubapi.com/oauth/v1/token scopes: crm.objects.custom.sensitive.read.v2
- or OAuth 2
  Authorization code: https://app.hubspot.com/oauth/authorize
  Token URL: https://api.hubapi.com/oauth/v1/token scopes: crm.objects.users.read
- or OAuth 2
  Authorization code: https://app.hubspot.com/oauth/authorize
  Token URL: https://api.hubapi.com/oauth/v1/token scopes: crm.objects.partner-services.read
- or OAuth 2
  Authorization code: https://app.hubspot.com/oauth/authorize
  Token URL: https://api.hubapi.com/oauth/v1/token scopes: crm.objects.orders.write
- or OAuth 2
  Authorization code: https://app.hubspot.com/oauth/authorize
  Token URL: https://api.hubapi.com/oauth/v1/token scopes: crm.objects.partner-services.write
- or OAuth 2
  Authorization code: https://app.hubspot.com/oauth/authorize
  Token URL: https://api.hubapi.com/oauth/v1/token scopes: crm.objects.appointments.write
- or OAuth 2
  Authorization code: https://app.hubspot.com/oauth/authorize
  Token URL: https://api.hubapi.com/oauth/v1/token scopes: crm.objects.projects.highly_sensitive.write
- or OAuth 2
  Authorization code: https://app.hubspot.com/oauth/authorize
  Token URL: https://api.hubapi.com/oauth/v1/token scopes: crm.objects.carts.write
- or OAuth 2
  Authorization code: https://app.hubspot.com/oauth/authorize
  Token URL: https://api.hubapi.com/oauth/v1/token scopes: crm.objects.tickets.highly_sensitive.write
- or OAuth 2
  Authorization code: https://app.hubspot.com/oauth/authorize
  Token URL: https://api.hubapi.com/oauth/v1/token scopes: crm.objects.commercepayments.read
- or OAuth 2
  Authorization code: https://app.hubspot.com/oauth/authorize
  Token URL: https://api.hubapi.com/oauth/v1/token scopes: crm.objects.products.write
- or OAuth 2
  Authorization code: https://app.hubspot.com/oauth/authorize
  Token URL: https://api.hubapi.com/oauth/v1/token scopes: crm.objects.feedback_submissions.read
- or OAuth 2
  Authorization code: https://app.hubspot.com/oauth/authorize
  Token URL: https://api.hubapi.com/oauth/v1/token scopes: crm.objects.services.write
- or OAuth 2
  Authorization code: https://app.hubspot.com/oauth/authorize
  Token URL: https://api.hubapi.com/oauth/v1/token scopes: crm.objects.subscriptions.write
- or OAuth 2
  Authorization code: https://app.hubspot.com/oauth/authorize
  Token URL: https://api.hubapi.com/oauth/v1/token scopes: crm.objects.deals.sensitive.write.v2
- or OAuth 2
  Authorization code: https://app.hubspot.com/oauth/authorize
  Token URL: https://api.hubapi.com/oauth/v1/token scopes: crm.objects.contacts.read
- or OAuth 2
  Authorization code: https://app.hubspot.com/oauth/authorize
  Token URL: https://api.hubapi.com/oauth/v1/token scopes: crm.objects.appointments.sensitive.write.v2
- or OAuth 2
  Authorization code: https://app.hubspot.com/oauth/authorize
  Token URL: https://api.hubapi.com/oauth/v1/token scopes: crm.objects.projects.highly_sensitive.read
- or OAuth 2
  Authorization code: https://app.hubspot.com/oauth/authorize
  Token URL: https://api.hubapi.com/oauth/v1/token scopes: crm.objects.invoices.read
- or OAuth 2
  Authorization code: https://app.hubspot.com/oauth/authorize
  Token URL: https://api.hubapi.com/oauth/v1/token scopes: crm.objects.custom.write
- or OAuth 2
  Authorization code: https://app.hubspot.com/oauth/authorize
  Token URL: https://api.hubapi.com/oauth/v1/token scopes: tickets.sensitive.v2
- or OAuth 2
  Authorization code: https://app.hubspot.com/oauth/authorize
  Token URL: https://api.hubapi.com/oauth/v1/token scopes: crm.objects.deals.write
- or OAuth 2
  Authorization code: https://app.hubspot.com/oauth/authorize
  Token URL: https://api.hubapi.com/oauth/v1/token scopes: e-commerce
- or OAuth 2
  Authorization code: https://app.hubspot.com/oauth/authorize
  Token URL: https://api.hubapi.com/oauth/v1/token scopes: crm.objects.appointments.read
- or OAuth 2
  Authorization code: https://app.hubspot.com/oauth/authorize
  Token URL: https://api.hubapi.com/oauth/v1/token scopes: crm.objects.projects.read
- or OAuth 2
  Authorization code: https://app.hubspot.com/oauth/authorize
  Token URL: https://api.hubapi.com/oauth/v1/token scopes: crm.objects.companies.sensitive.write.v2
- or OAuth 2
  Authorization code: https://app.hubspot.com/oauth/authorize
  Token URL: https://api.hubapi.com/oauth/v1/token scopes: crm.objects.companies.highly_sensitive.write.v2
- or OAuth 2
  Authorization code: https://app.hubspot.com/oauth/authorize
  Token URL: https://api.hubapi.com/oauth/v1/token scopes: crm.objects.deals.highly_sensitive.write.v2
- or OAuth 2
  Authorization code: https://app.hubspot.com/oauth/authorize
  Token URL: https://api.hubapi.com/oauth/v1/token scopes: crm.objects.custom.highly_sensitive.read.v2
- or OAuth 2
  Authorization code: https://app.hubspot.com/oauth/authorize
  Token URL: https://api.hubapi.com/oauth/v1/token scopes: crm.objects.goals.write
- or OAuth 2
  Authorization code: https://app.hubspot.com/oauth/authorize
  Token URL: https://api.hubapi.com/oauth/v1/token scopes: crm.objects.projects.sensitive.read
- or OAuth 2
  Authorization code: https://app.hubspot.com/oauth/authorize
  Token URL: https://api.hubapi.com/oauth/v1/token scopes: crm.objects.line_items.write
- or OAuth 2
  Authorization code: https://app.hubspot.com/oauth/authorize
  Token URL: https://api.hubapi.com/oauth/v1/token scopes: crm.objects.contacts.write
- or OAuth 2
  Authorization code: https://app.hubspot.com/oauth/authorize
  Token URL: https://api.hubapi.com/oauth/v1/token scopes: crm.objects.goals.read
- or OAuth 2
  Authorization code: https://app.hubspot.com/oauth/authorize
  Token URL: https://api.hubapi.com/oauth/v1/token scopes: crm.objects.line_items.read
- or OAuth 2
  Authorization code: https://app.hubspot.com/oauth/authorize
  Token URL: https://api.hubapi.com/oauth/v1/token scopes: crm.objects.partner-clients.write
- or OAuth 2
  Authorization code: https://app.hubspot.com/oauth/authorize
  Token URL: https://api.hubapi.com/oauth/v1/token scopes: crm.objects.projects.write
- or OAuth 2
  Authorization code: https://app.hubspot.com/oauth/authorize
  Token URL: https://api.hubapi.com/oauth/v1/token scopes: crm.objects.projects.sensitive.write
- or OAuth 2
  Authorization code: https://app.hubspot.com/oauth/authorize
  Token URL: https://api.hubapi.com/oauth/v1/token scopes: crm.objects.deals.sensitive.read.v2
- or OAuth 2
  Authorization code: https://app.hubspot.com/oauth/authorize
  Token URL: https://api.hubapi.com/oauth/v1/token scopes: crm.objects.quotes.write
- or OAuth 2
  Authorization code: https://app.hubspot.com/oauth/authorize
  Token URL: https://api.hubapi.com/oauth/v1/token scopes: tickets.highly_sensitive.v2
- or OAuth 2
  Authorization code: https://app.hubspot.com/oauth/authorize
  Token URL: https://api.hubapi.com/oauth/v1/token scopes: crm.objects.leads.read
- or OAuth 2
  Authorization code: https://app.hubspot.com/oauth/authorize
  Token URL: https://api.hubapi.com/oauth/v1/token scopes: crm.objects.leads.write
- or OAuth 2
  Authorization code: https://app.hubspot.com/oauth/authorize
  Token URL: https://api.hubapi.com/oauth/v1/token scopes: crm.objects.carts.read
- or OAuth 2
  Authorization code: https://app.hubspot.com/oauth/authorize
  Token URL: https://api.hubapi.com/oauth/v1/token scopes: crm.objects.emails.read
- or OAuth 2
  Authorization code: https://app.hubspot.com/oauth/authorize
  Token URL: https://api.hubapi.com/oauth/v1/token scopes: crm.objects.quotes.read
- or OAuth 2
  Authorization code: https://app.hubspot.com/oauth/authorize
  Token URL: https://api.hubapi.com/oauth/v1/token scopes: crm.objects.courses.write
- or OAuth 2
  Authorization code: https://app.hubspot.com/oauth/authorize
  Token URL: https://api.hubapi.com/oauth/v1/token scopes: crm.objects.partner-clients.read
- or OAuth 2
  Authorization code: https://app.hubspot.com/oauth/authorize
  Token URL: https://api.hubapi.com/oauth/v1/token scopes: crm.objects.notes.read
- or OAuth 2
  Authorization code: https://app.hubspot.com/oauth/authorize
  Token URL: https://api.hubapi.com/oauth/v1/token scopes: crm.objects.courses.read
- or OAuth 2
  Authorization code: https://app.hubspot.com/oauth/authorize
  Token URL: https://api.hubapi.com/oauth/v1/token scopes: crm.objects.listings.read
- or OAuth 2
  Authorization code: https://app.hubspot.com/oauth/authorize
  Token URL: https://api.hubapi.com/oauth/v1/token scopes: crm.objects.contacts.sensitive.read.v2
- or OAuth 2
  Authorization code: https://app.hubspot.com/oauth/authorize
  Token URL: https://api.hubapi.com/oauth/v1/token scopes: crm.objects.products.read

Query parameters

archivedboolean

Whether to return only results that have been archived.

Request body

idPropertystring

When using a custom unique value property to retrieve records, the name of the property. Do not include this parameter if retrieving by record ID.

propertiesstring[] required

An array of strings specifying the properties to be returned in the response. If any specified properties are not present on the requested objects, they will be ignored.

propertiesWithHistorystring[] required

An array of strings specifying the properties to be returned along with their history of previous values. If any specified properties are not present on the requested objects, they will be ignored.

Example request

{
  "inputs": [
    {
      "id": "430001"
    }
  ]
}

Response

successful operation

completedAtstring date-time required

The date and time when the batch operation was completed, in ISO 8601 format.

linksobject

A map of link names to associated URIs, providing additional information or actions related to the batch operation.

requestedAtstring date-time

The date and time when the batch operation was requested, in ISO 8601 format.

startedAtstring date-time required

The date and time when the batch operation started, in ISO 8601 format.

status'CANCELED' | 'COMPLETE' | 'PENDING' | 'PROCESSING' required

The current status of the batch operation. Valid values include 'PENDING', 'PROCESSING', 'CANCELED', and 'COMPLETE'.

Changes

Oct 13, 20262026-097ffbe15ac78b Revision changes
- info
  the security scope crm.objects.deals.read was added to the endpoint's security scheme oauth2
- info
  the security scope crm.objects.products.read was removed from the endpoint's security scheme oauth2
Oct 10, 20262026-09127acea72a62 Revision changes
- info
  the security scope crm.objects.deals.read was added to the endpoint's security scheme oauth2
- info
  the security scope crm.objects.products.read was removed from the endpoint's security scheme oauth2

Operation history (8 revisions)