HUhubspot
Basic

Retrieve a specific owner by ID

Changed on

Retrieve details of a specific owner using either their 'id' or 'userId'.

get/crm/v3/owners/{ownerId}

Request

  • Base URL
    https://api.hubapi.com
  • URL
    https://api.hubapi.com/crm/v3/owners/{ownerId}
  • Auth
    • OAuth 2
      Authorization code: https://app.hubspot.com/oauth/authorize
      Token URL: https://api.hubapi.com/oauth/v1/token scopes: automation
    • or OAuth 2
      Authorization code: https://app.hubspot.com/oauth/authorize
      Token URL: https://api.hubapi.com/oauth/v1/token scopes: crm.objects.owners.read
    • or OAuth 2
      Authorization code: https://app.hubspot.com/oauth/authorize
      Token URL: https://api.hubapi.com/oauth/v1/token scopes: crm.pipelines.approval.read
    • or OAuth 2
      Authorization code: https://app.hubspot.com/oauth/authorize
      Token URL: https://api.hubapi.com/oauth/v1/token scopes: crm.pipelines.governance.write

Path parameters

ownerIdinteger required

Query parameters

archivedboolean

Whether to return only results that have been archived.

idProperty'id' | 'userId'

Response

successful operation

archivedboolean required

Indicates whether the owner is archived.

createdAtstring date-time required

The date and time when the owner was created.

emailstring

The email address of the owner.

firstNamestring

The first name of the owner.

idstring required

The unique identifier of the owner.

lastNamestring

The last name of the owner.

type'PERSON' | 'QUEUE' required

The type of the owner, which can be either PERSON or QUEUE.

updatedAtstring date-time required

The date and time when the owner was last updated.

userIdinteger

The user ID of the owner.

userIdIncludingInactiveinteger

The user ID of the owner, including inactive users.

Example response

{
  "archived": false,
  "createdAt": "2019-10-30T03:30:17.883Z",
  "email": "jsmith@example.com",
  "firstName": "John",
  "id": "6166860",
  "lastName": "Smith",
  "teams": [
    {
      "id": "178588",
      "name": "West Coast Sales",
      "primary": true
    },
    {
      "id": "178590",
      "name": "California Sales",
      "primary": false
    }
  ],
  "updatedAt": "2019-12-07T16:50:06.678Z",
  "userId": 1296619
}

Changes

  • v3e364b33573c9Revision changes
    • info

      the security scope automation was added to the endpoint's security scheme oauth2

    • info

      the security scope crm.pipelines.governance.write was removed from the endpoint's security scheme oauth2

  • v3354d43093879Revision changes
    • info

      the security scope automation was added to the endpoint's security scheme oauth2

    • info

      the security scope crm.objects.owners.read was removed from the endpoint's security scheme oauth2