> ## Documentation Index
> Fetch the complete documentation index at: https://developers.hubspot.jp/docs/llms.txt
> Use this file to discover all available pages before exploring further.
# Get a contact by its user token
> For a given account, return information about a group of contacts by their user tokens. A visitor's user token is stored in the hubspotutk cookie. This cookie is created automatically by the HubSpot tracking code. The endpoint accepts many query parameters that allow for customization based on a variety of integration use cases. By default, this endpoint will not return the history for properties, only the current value of any populated properties, but you can include the history using the parameters listed below. Requests should be limited to 100 records in a single request.
export const ScopesList = ({scopes = [], description = "この API には、次のいずれかのスコープが必要です。"}) => {
if (!scopes || scopes.length === 0) {
return null;
}
const sortedScopes = scopes.sort((a, b) => a.localeCompare(b));
return
{description}
{sortedScopes.map((scope, index) =>
{scope}
)}
;
};
## OpenAPI
````yaml specs/legacy/v1/crm-contacts-v1.json GET /contacts/v1/contact/utk/{contact_utk}/profile
openapi: 3.0.0
info:
title: CRM Contacts API v1
version: 1.0.0
description: Use the contact lists API to create and manage contact lists.
x-hubspot-introduction: Use the contact lists API to create and manage contact lists.
x-hubspot-api-use-case: >-
Retrieve a contact list by ID to bring that contact data into your external
system.
servers:
- url: https://api.hubapi.com
description: HubSpot API Server
security: []
paths:
/contacts/v1/contact/utk/{contact_utk}/profile:
get:
summary: Get a contact by its user token
description: >-
For a given account, return information about a group of contacts by
their user tokens. A visitor's user token is stored in the hubspotutk
cookie. This cookie is created automatically by the HubSpot tracking
code. The endpoint accepts many query parameters that allow for
customization based on a variety of integration use cases. By default,
this endpoint will not return the history for properties, only the
current value of any populated properties, but you can include the
history using the parameters listed below. Requests should be limited to
100 records in a single request.
operationId: getcontactsv1contactutkcontactutkprofile
parameters:
- name: utk
in: query
required: true
description: >-
Each user token requires it's own query parameter (utk=xxx&utk=yyy).
Requests should be limited to 100 or fewer user tokens. Any user
tokens that are provided that are not associated with a contact
record will be ignored.
schema:
type: string
- name: property
in: query
required: false
description: >-
Specify the properties that should be returned for each ID. By
default, the endpoint returns all valued properties for a contact.
If this parameter is used, only the specified property or properties
will be included.
schema:
type: string
- name: propertyMode
in: query
required: false
description: >-
One of `value_only` or `value_and_history` to specify if the current
value for a property should be fetched, or the value and all the
historical values for that property. Default is `value_only`.
schema:
type: string
- name: formSubmissionMode
in: query
required: false
description: >-
One of `all`, `none`, `newest`, `oldest` to specify which form
submissions should be fetched. Default is `newest`.
schema:
type: string
- name: showListMemberships
in: query
required: false
description: >-
Boolean `true` or `false` to indicate whether current list
memberships should be fetched for the contact. Default is `false`.
schema:
type: string
- name: includeDeletes
in: query
required: false
description: >-
Boolean `true` or `false` to indicate whether current list
memberships should be fetched for the contact. Default is `false`.
schema:
type: string
responses:
'200':
description: >-
Successful response - For a given account, return information about
a group of contacts by their user tokens
content:
application/json:
schema:
type: object
examples:
example1:
summary: Get a contact by its user token - Example 1
value:
vid: 3234574
canonical-vid: 3234574
merged-vids: []
portal-id: 62515
is-contact: true
properties:
hs_analytics_last_url:
value: ''
versions:
- value: ''
source-type: ANALYTICS
source-id: ContactAnalyticsDetailsUpdateWorker
source-label: null
timestamp: 1484026587400
selected: false
lead_source:
value: DiscoverOrg
versions:
- value: DiscoverOrg
source-type: API
source-id: null
source-label: null
timestamp: 1484026593060
selected: false
num_unique_conversion_events:
value: '0'
versions:
- value: '0'
source-type: CALCULATED
source-id: null
source-label: null
timestamp: 0
selected: false
hs_analytics_revenue:
value: '0.0'
versions:
- value: '0.0'
source-type: ANALYTICS
source-id: ContactAnalyticsDetailsUpdateWorker
source-label: null
timestamp: 1484026587400
selected: false
createdate:
value: '1484026585538'
versions:
- value: '1484026585538'
source-type: API
source-id: Contacts
source-label: null
timestamp: 1484026585538
selected: false
hs_analytics_first_referrer:
value: ''
versions:
- value: ''
source-type: ANALYTICS
source-id: ContactAnalyticsDetailsUpdateWorker
source-label: null
timestamp: 1484026587400
selected: false
hs_email_optout:
value: 'true'
versions:
- value: 'true'
source-type: EMAIL
source-id: Updated in response to an email address change.
source-label: null
timestamp: 1484026585658
selected: false
hs_predictivecontactscore:
value: '50'
versions:
- value: '50'
source-type: TASK
source-id: predictive-contact-scoring
source-label: '3'
timestamp: 1484026586421
selected: false
annualrevenue:
value: '181900000'
versions:
- value: '181900000'
source-type: API
source-id: null
source-label: null
timestamp: 1484026593060
selected: false
hs_analytics_num_page_views:
value: '0'
versions:
- value: '0'
source-type: ANALYTICS
source-id: ContactAnalyticsDetailsUpdateWorker
source-label: null
timestamp: 1484026587400
selected: false
state:
value: MA
versions:
- value: MA
source-type: API
source-id: null
source-label: null
timestamp: 1484026585536
selected: false
zip:
value: '02139'
versions:
- value: '02139'
source-type: API
source-id: null
source-label: null
timestamp: 1484026585536
selected: false
fortune_rank:
value: ''
versions:
- value: ''
source-type: API
source-id: null
source-label: null
timestamp: 1484026593060
selected: false
hs_predictivecontactscorebucket:
value: bucket_3
versions:
- value: bucket_3
source-type: TASK
source-id: predictive-contact-scoring
source-label: '3'
timestamp: 1484857784401
selected: false
- value: bucket_2
source-type: TASK
source-id: predictive-contact-scoring
source-label: '3'
timestamp: 1484026587692
selected: false
- value: bucket_3
source-type: TASK
source-id: predictive-contact-scoring
source-label: '3'
timestamp: 1484026586421
selected: false
hubspotscore:
value: '0'
versions:
- value: '0'
source-type: WAL_INCREMENTAL
source-id: csrsu-kafka
source-label: null
timestamp: 1484026586290
selected: false
linkedinconnections:
value: '0'
versions:
- value: '0'
source-type: WAL_INCREMENTAL
source-id: iwsmp
source-label: null
timestamp: 1484026586434
selected: false
hs_lifecyclestage_subscriber_date:
value: '1484026585538'
versions:
- value: '1484026585538'
source-type: API
source-id: null
source-label: null
timestamp: 1484026585538
selected: false
hs_analytics_average_page_views:
value: '0'
versions:
- value: '0'
source-type: ANALYTICS
source-id: ContactAnalyticsDetailsUpdateWorker
source-label: null
timestamp: 1484026587400
selected: false
lastname:
value: Test
versions:
- value: Test
source-type: CRM_UI
source-id: dadams@hubspot.com
source-label: null
timestamp: 1484859512997
selected: false
- value: Huang
source-type: BATCH_UPDATE
source-id: null
source-label: null
timestamp: 1484858430193
selected: false
- value: Test
source-type: API
source-id: null
source-label: null
timestamp: 1484857783087
selected: false
- value: Mott
source-type: API
source-id: null
source-label: null
timestamp: 1484026585536
selected: false
twitterhandle:
value: ghidinelli
versions:
- value: ghidinelli
source-type: WAL_INCREMENTAL
source-id: iwsmp
source-label: null
timestamp: 1484026586434
selected: false
phone:
value: 555-122-2323
versions:
- value: 555-122-2323
source-type: API
source-id: null
source-label: null
timestamp: 1484026585536
selected: false
num_conversion_events:
value: '0'
versions:
- value: '0'
source-type: CALCULATED
source-id: null
source-label: null
timestamp: 0
selected: false
currentlyinworkflow:
value: 'false'
versions:
- value: 'false'
source-type: WORKFLOWS
source-id: null
source-label: null
timestamp: 1484026663404
selected: false
- value: 'true'
source-type: WORKFLOWS
source-id: null
source-label: null
timestamp: 1484026588355
selected: false
hs_analytics_num_event_completions:
value: '2'
versions:
- value: '2'
source-type: ANALYTICS
source-id: ContactAnalyticsDetailsUpdateWorker
source-label: null
timestamp: 1484653296522
selected: false
- value: '1'
source-type: ANALYTICS
source-id: ContactAnalyticsDetailsUpdateWorker
source-label: null
timestamp: 1484049018265
selected: false
- value: '0'
source-type: ANALYTICS
source-id: ContactAnalyticsDetailsUpdateWorker
source-label: null
timestamp: 1484026587400
selected: false
followercount:
value: '582'
versions:
- value: '582'
source-type: WAL_INCREMENTAL
source-id: iwsmp
source-label: null
timestamp: 1484026586434
selected: false
hs_email_optout_2849:
value: ''
versions:
- value: ''
source-type: EMAIL
source-id: Updated in response to an email address change.
source-label: null
timestamp: 1484026585658
selected: false
associatedcompanyid:
value: '184896670'
versions:
- value: '184896670'
source-type: COMPANIES
source-id: WriteAssociatedCompanyIdStep
source-label: null
timestamp: 1484026585846
selected: false
firstname:
value: HubSpot
versions:
- value: HubSpot
source-type: CRM_UI
source-id: dadams@hubspot.com
source-label: null
timestamp: 1484859512997
selected: false
- value: Codey
source-type: BATCH_UPDATE
source-id: null
source-label: null
timestamp: 1484858430193
selected: false
- value: HubSpot
source-type: API
source-id: null
source-label: null
timestamp: 1484857783087
selected: false
- value: Adrian
source-type: API
source-id: null
source-label: null
timestamp: 1484026585536
selected: false
city:
value: Cambridge
versions:
- value: Cambridge
source-type: API
source-id: null
source-label: null
timestamp: 1484026585536
selected: false
hs_email_optout_354586:
value: ''
versions:
- value: ''
source-type: EMAIL
source-id: Updated in response to an email address change.
source-label: null
timestamp: 1484026585658
selected: false
hs_social_num_broadcast_clicks:
value: '0'
versions:
- value: '0'
source-type: ANALYTICS
source-id: ContactAnalyticsDetailsUpdateWorker
source-label: null
timestamp: 1484026587400
selected: false
hs_analytics_last_timestamp:
value: ''
versions:
- value: ''
source-type: ANALYTICS
source-id: ContactAnalyticsDetailsUpdateWorker
source-label: null
timestamp: 1484026587400
selected: false
hs_analytics_num_visits:
value: '0'
versions:
- value: '0'
source-type: ANALYTICS
source-id: ContactAnalyticsDetailsUpdateWorker
source-label: null
timestamp: 1484026587400
selected: false
twitterbio:
value: >-
Racer, entrepreneur, world traveler. Crossfitter,
foodie, kitesurfing newbie. If racing is life, I'm
building a lifestyle business @MotorsportReg
@RaceHeroApp
versions:
- value: >-
Racer, entrepreneur, world traveler. Crossfitter,
foodie, kitesurfing newbie. If racing is life, I'm
building a lifestyle business @MotorsportReg
@RaceHeroApp
source-type: WAL_INCREMENTAL
source-id: iwsmp
source-label: null
timestamp: 1484026586434
selected: false
hs_social_linkedin_clicks:
value: '0'
versions:
- value: '0'
source-type: ANALYTICS
source-id: ContactAnalyticsDetailsUpdateWorker
source-label: null
timestamp: 1484026587400
selected: false
hs_analytics_last_visit_timestamp:
value: ''
versions:
- value: ''
source-type: ANALYTICS
source-id: ContactAnalyticsDetailsUpdateWorker
source-label: null
timestamp: 1484026587400
selected: false
hs_social_last_engagement:
value: ''
versions:
- value: ''
source-type: ANALYTICS
source-id: ContactAnalyticsDetailsUpdateWorker
source-label: null
timestamp: 1484026587400
selected: false
hs_twitterid:
value: '49019793'
versions:
- value: '49019793'
source-type: WAL_INCREMENTAL
source-id: iwsmp
source-label: null
timestamp: 1484026586434
selected: false
associatedcompanylastupdated:
value: '13365279006997343'
versions:
- value: '13365279006997343'
source-type: COMPANIES
source-id: WriteAssociatedCompanyIdStep
source-label: null
timestamp: 1484026585846
selected: false
hs_analytics_source:
value: OFFLINE
versions:
- value: OFFLINE
source-type: ANALYTICS
source-id: ContactAnalyticsDetailsUpdateWorker
source-label: null
timestamp: 1484026587400
selected: false
company:
value: HubSpot
versions:
- value: HubSpot
source-type: API
source-id: null
source-label: null
timestamp: 1484026585536
selected: false
email:
value: testingapis@hubspot.com
versions:
- value: testingapis@hubspot.com
source-type: API
source-id: null
source-label: null
timestamp: 1484026585536
selected: false
linkedinbio:
value: Racecar driver, entrepreneur, world traveler
versions:
- value: Racecar driver, entrepreneur, world traveler
source-type: WAL_INCREMENTAL
source-id: iwsmp
source-label: null
timestamp: 1484026586434
selected: false
hs_analytics_first_url:
value: ''
versions:
- value: ''
source-type: ANALYTICS
source-id: ContactAnalyticsDetailsUpdateWorker
source-label: null
timestamp: 1484026587400
selected: false
website:
value: ''
versions:
- value: ''
source-type: API
source-id: null
source-label: null
timestamp: 1484857783087
selected: false
- value: ''
source-type: API
source-id: null
source-label: null
timestamp: 1484026663212
selected: false
- value: ''
source-type: API
source-id: null
source-label: null
timestamp: 1484026585536
selected: false
address:
value: 25 First Street
versions:
- value: 25 First Street
source-type: API
source-id: null
source-label: null
timestamp: 1484026585536
selected: false
hs_analytics_first_visit_timestamp:
value: ''
versions:
- value: ''
source-type: ANALYTICS
source-id: ContactAnalyticsDetailsUpdateWorker
source-label: null
timestamp: 1484026587400
selected: false
hs_analytics_first_timestamp:
value: '1484026585538'
versions:
- value: '1484026585538'
source-type: ANALYTICS
source-id: ContactAnalyticsDetailsUpdateWorker
source-label: null
timestamp: 1484026587400
selected: false
lastmodifieddate:
value: '1484859513090'
versions:
- value: '1484859513090'
source-type: CALCULATED
source-id: null
source-label: null
timestamp: 1484859513090
selected: false
photo:
value: ''
versions:
- value: ''
source-type: WAL_INCREMENTAL
source-id: iwsmp
source-label: null
timestamp: 1484026586434
selected: false
hs_social_google_plus_clicks:
value: '0'
versions:
- value: '0'
source-type: ANALYTICS
source-id: ContactAnalyticsDetailsUpdateWorker
source-label: null
timestamp: 1484026587400
selected: false
hs_analytics_last_referrer:
value: ''
versions:
- value: ''
source-type: ANALYTICS
source-id: ContactAnalyticsDetailsUpdateWorker
source-label: null
timestamp: 1484026587400
selected: false
kloutscoregeneral:
value: '48'
versions:
- value: '48'
source-type: WAL_INCREMENTAL
source-id: iwsmp
source-label: null
timestamp: 1484026586434
selected: false
hs_email_optout_230318:
value: ''
versions:
- value: ''
source-type: EMAIL
source-id: Updated in response to an email address change.
source-label: null
timestamp: 1484026585658
selected: false
hs_social_facebook_clicks:
value: '0'
versions:
- value: '0'
source-type: ANALYTICS
source-id: ContactAnalyticsDetailsUpdateWorker
source-label: null
timestamp: 1484026587400
selected: false
twitterprofilephoto:
value: ''
versions:
- value: ''
source-type: WAL_INCREMENTAL
source-id: iwsmp
source-label: null
timestamp: 1484026586434
selected: false
hs_analytics_source_data_2:
value: ''
versions:
- value: ''
source-type: ANALYTICS
source-id: ContactAnalyticsDetailsUpdateWorker
source-label: null
timestamp: 1484026587400
selected: false
hs_social_twitter_clicks:
value: '0'
versions:
- value: '0'
source-type: ANALYTICS
source-id: ContactAnalyticsDetailsUpdateWorker
source-label: null
timestamp: 1484026587400
selected: false
hs_analytics_source_data_1:
value: API
versions:
- value: API
source-type: ANALYTICS
source-id: ContactAnalyticsDetailsUpdateWorker
source-label: null
timestamp: 1484026587400
selected: false
lifecyclestage:
value: subscriber
versions:
- value: subscriber
source-type: API
source-id: null
source-label: null
timestamp: 1484026585538
selected: false
hs_email_sends_since_last_engagement:
value: '0'
versions:
- value: '0'
source-type: MIGRATION
source-id: email-migration
source-label: null
timestamp: 1484882338392
selected: false
form-submissions: []
list-memberships:
- static-list-id: 1
internal-list-id: 220441
timestamp: 1484026586509
vid: 3234574
is-member: true
- static-list-id: 230006
internal-list-id: 230635
timestamp: 1484026588372
vid: 3234574
is-member: true
- static-list-id: 230008
internal-list-id: 230637
timestamp: 1484026663355
vid: 3234574
is-member: true
- static-list-id: 232135
internal-list-id: 232770
timestamp: 1484026586509
vid: 3234574
is-member: true
- static-list-id: 236675
internal-list-id: 237312
timestamp: 1484026588449
vid: 3234574
is-member: true
- static-list-id: 236677
internal-list-id: 237314
timestamp: 1484026593326
vid: 3234574
is-member: true
- static-list-id: 236813
internal-list-id: 237460
timestamp: 1484026586509
vid: 3234574
is-member: true
identity-profiles:
- vid: 3234574
saved-at-timestamp: 1484026585613
deleted-changed-timestamp: 0
identities:
- type: EMAIL
value: testingapis@hubspot.com
timestamp: 1484026585538
- type: LEAD_GUID
value: 4b11f8af-50d9-4665-9c43-bb2fc46e3a80
timestamp: 1484026585610
merge-audits: []
associated-company:
company-id: 184896670
portal-id: 62515
properties:
country:
value: United States
city:
value: Cambridge
num_associated_contacts:
value: '102'
timezone:
value: America/New_York
facebook_company_page:
value: ''
createdate:
value: '1457708103847'
description:
value: >-
HubSpot is the world’s leading inbound marketing and
sales platform. Since 2006, HubSpot has been on a
mission to make the world more inbound. Today, over
10,000 customers in 65 countries use HubSpot’s
software, services, and support to transform the way
they attract, engage, and delight customers.
HubSpot’s inbound marketing software, ranked #1 in
customer satisfaction by VentureBeat and G2Crowd,
includes social media publishing and monitoring,
blogging, SEO, website content management, email
marketing, marketing automation, and reporting and
analytics, all in one integrated platform. Signals,
HubSpot’s award-winning sales application, enables
sales and service teams to have more effective
conversations with leads, prospects, and customers.
HubSpot is headquartered in Cambridge, MA with an
office in Dublin, Ireland, and has been recognized
by Inc., Forbes, and Deloitte as one of the world’s
fastest-growing companies.
industry:
value: COMPUTER_SOFTWARE
total_money_raised:
value: $100.5M
days_to_close:
value: '220'
hs_analytics_num_visits:
value: '0'
linkedin_company_page:
value: ''
recent_conversion_event_name:
value: 'Contact Us: excedalogic form'
hs_analytics_source:
value: OFFLINE
num_contacted_notes:
value: '12'
annualrevenue:
value: '250000000'
founded_year:
value: '2006'
hs_analytics_num_page_views:
value: '0'
state:
value: MA
linkedinbio:
value: >-
HubSpot is the world’s leading inbound marketing and
sales platform. Since 2006, HubSpot has been on a
mission to make the world more inbound. Today, over
10,000 customers in 65 countries use HubSpot’s
software, services, and support to transform the way
they attract, engage, and delight customers.
HubSpot’s inbound marketing software, ranked #1 in
customer satisfaction by VentureBeat and G2Crowd,
includes social media publishing and monitoring,
blogging, SEO, website content management, email
marketing, marketing automation, and reporting and
analytics, all in one integrated platform. Signals,
HubSpot’s award-winning sales application, enables
sales and service teams to have more effective
conversations with leads, prospects, and customers.
HubSpot is headquartered in Cambridge, MA with an
office in Dublin, Ireland, and has been recognized
by Inc., Forbes, and Deloitte as one of the world’s
fastest-growing companies.
notes_next_activity_date:
value: ''
zip:
value: '02141'
notes_last_updated:
value: '1480625888696'
website:
value: hubspot.com
closedate:
value: '1476768116137'
hs_analytics_first_timestamp:
value: '1390574181854'
first_conversion_date:
value: '1477892839033'
engagements_last_meeting_booked:
value: ''
first_contact_createdate:
value: '1390574181854'
twitterhandle:
value: HubSpot
hs_lastmodifieddate:
value: '1484915991732'
notes_last_contacted:
value: '1479030015191'
phone:
value: +1 888-482-7768
num_conversion_events:
value: '41'
domain:
value: hubspot.com
is_public:
value: 'true'
name:
value: Hubspot, Inc.
recent_conversion_date:
value: '1484915989198'
hs_analytics_source_data_2:
value: ''
hs_analytics_source_data_1:
value: ''
first_conversion_event_name:
value: excedalogic form
num_notes:
value: '12'
security:
- oauth2:
- crm.objects.contacts.read
- oauth2_legacy: []
- private_apps:
- crm.objects.contacts.read
- private_apps_legacy: []
components: {}
````