Zum Hauptinhalt springen
GET
/
crm
/
v3
/
objects
/
{objectType}
/
{objectId}
Lu
curl --request GET \
  --url https://api.hubapi.com/crm/v3/objects/{objectType}/{objectId} \
  --header 'Authorization: Bearer <token>'
{
  "archived": true,
  "archivedAt": "2023-11-07T05:31:56Z",
  "associations": {},
  "createdAt": "2023-11-07T05:31:56Z",
  "id": "<string>",
  "objectWriteTraceId": "<string>",
  "properties": {},
  "propertiesWithHistory": {},
  "updatedAt": "2023-11-07T05:31:56Z",
  "url": "<string>"
}

Produits pris en charge

Exige l'un des produits suivants ou un produit supérieur.
Marketing HubMarketing Hub -Gratuit
Sales HubSales Hub -Gratuit
Service HubService Hub -Gratuit
Content HubContent Hub -Gratuit
Cette API requiert l'une des portées suivantes :
crm.objects.appointments.read
crm.objects.appointments.sensitive.read.v2
crm.objects.appointments.sensitive.write.v2
crm.objects.appointments.write
crm.objects.carts.read
crm.objects.carts.write
crm.objects.commercepayments.read
crm.objects.commercepayments.write
crm.objects.companies.highly_sensitive.read.v2
crm.objects.companies.highly_sensitive.write.v2
crm.objects.companies.read
crm.objects.companies.sensitive.read.v2
crm.objects.companies.sensitive.write.v2
crm.objects.companies.write
crm.objects.contacts.highly_sensitive.read.v2
crm.objects.contacts.highly_sensitive.write.v2
crm.objects.contacts.read
crm.objects.contacts.sensitive.read.v2
crm.objects.contacts.sensitive.write.v2
crm.objects.contacts.write
crm.objects.courses.read
crm.objects.courses.write
crm.objects.custom.highly_sensitive.read.v2
crm.objects.custom.highly_sensitive.write.v2
crm.objects.custom.read
crm.objects.custom.sensitive.read.v2
crm.objects.custom.sensitive.write.v2
crm.objects.custom.write
crm.objects.deals.highly_sensitive.read.v2
crm.objects.deals.highly_sensitive.write.v2
crm.objects.deals.read
crm.objects.deals.sensitive.read.v2
crm.objects.deals.sensitive.write.v2
crm.objects.deals.write
crm.objects.goals.read
crm.objects.goals.write
crm.objects.invoices.read
crm.objects.invoices.write
crm.objects.leads.read
crm.objects.leads.write
crm.objects.line_items.read
crm.objects.line_items.write
crm.objects.listings.read
crm.objects.listings.write
crm.objects.orders.read
crm.objects.orders.write
crm.objects.partner-clients.read
crm.objects.partner-clients.write
crm.objects.partner-services.read
crm.objects.partner-services.write
crm.objects.products.read
crm.objects.products.write
crm.objects.quotes.read
crm.objects.quotes.write
crm.objects.services.read
crm.objects.services.write
crm.objects.subscriptions.read
crm.objects.subscriptions.write
crm.objects.users.read
crm.objects.users.write
e-commerce
media_bridge.read
oauth
tickets
tickets.highly_sensitive.v2
tickets.sensitive.v2

Authorizations

​
Authorization
string
header
required

The access token received from the authorization server in the OAuth 2.0 flow.

Path Parameters

​
objectId
string
required
​
objectType
string
required

Query Parameters

​
archived
boolean
default:false

S'il faut renvoyer uniquement les résultats qui ont été archivés.

​
associations
string[]

Une liste d'objets séparés par des virgules pour lesquels les ID associés doivent être récupérés. Si l'une des associations spécifiées n'existe pas, elle sera ignorée.

​
idProperty
string

Le nom d'une propriété dont les valeurs sont uniques pour cet objet

​
properties
string[]

Une liste des propriétés séparées par des virgules à renvoyer dans la réponse. Si l'une des propriétés spécifiées n'est pas présente sur l'objet ou les objets demandé(s), elle sera ignorée.

​
propertiesWithHistory
string[]

Une liste des propriétés séparées par des virgules à retourner avec leur historique des valeurs précédentes. Si l'une des propriétés spécifiées n'est pas présente sur l'objet ou les objets demandé(s), elle sera ignorée.

Response

successful operation

Represents a CRM object along with its properties, timestamps, and a set of associated object IDs grouped by association type.

​
archived
boolean
required

Si l'objet est archivé.

​
createdAt
string<date-time>
required

L'horodatage du moment où l'objet a été créé, au format ISO 8601.

​
id
string
required

L'ID unique de l'objet.

​
properties
object
required

Paires clé-valeur représentant les propriétés de l'objet.

​
updatedAt
string<date-time>
required

L'horodatage du moment où l'objet a été mis à jour pour la dernière fois, au format ISO 8601.

​
archivedAt
string<date-time>

L'horodatage du moment où l'objet a été archivé, au format ISO 8601.

​
associations
object

Une liste définissant les relations avec d'autres objets.

​
objectWriteTraceId
string
​
propertiesWithHistory
object

Paires clé-valeur représentant les propriétés de l'objet avec leur historique.

​
url
string

URL directe pour cet objet dans HubSpot