GET
/
crm
/
v3
/
objects
/
partner_clients
/
{partnerClientId}
Read
curl --request GET \
  --url https://api.hubapi.com/crm/v3/objects/partner_clients/{partnerClientId} \
  --header 'Authorization: Bearer <token>'
{
  "associations": {},
  "createdAt": "2023-11-07T05:31:56Z",
  "archived": true,
  "archivedAt": "2023-11-07T05:31:56Z",
  "propertiesWithHistory": {},
  "id": "<string>",
  "objectWriteTraceId": "<string>",
  "properties": {},
  "updatedAt": "2023-11-07T05:31:56Z"
}
Produtos suportados
Requer um dos seguintes produtos ou superior.
Marketing HubMarketing HubGrátis
Sales HubSales HubGrátis
Service HubService HubGrátis
Content HubContent HubGrátis

​
Escopos Necessários

Esta API requer um dos seguintes escopos:
  • crm.objects.partner-clients.read

Authorizations

​
Authorization
string
header
required

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

Path Parameters

​
partnerClientId
string
required

Query Parameters

​
properties
string[]

A comma separated list of the properties to be returned in the response. If any of the specified properties are not present on the requested object(s), they will be ignored.

​
propertiesWithHistory
string[]

A comma separated list of the properties to be returned along with their history of previous values. If any of the specified properties are not present on the requested object(s), they will be ignored.

​
associations
string[]

A comma separated list of object types to retrieve associated IDs for. If any of the specified associations do not exist, they will be ignored.

​
archived
boolean
default:false

Whether to return only results that have been archived.

​
idProperty
string

The name of a property whose values are unique for this object

Response

successful operation

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

​
createdAt
string<date-time>
required

The timestamp when the object was created, in ISO 8601 format.

​
id
string
required

The unique ID of the object.

​
properties
object
required

Key value pairs representing the properties of the object.

​
updatedAt
string<date-time>
required

The timestamp when the object was last updated, in ISO 8601 format.

​
associations
object

A list defining relationships with other objects.

​
archived
boolean

Whether the object is archived.

​
archivedAt
string<date-time>

The timestamp when the object was archived, in ISO 8601 format.

​
propertiesWithHistory
object

Key-value pairs representing the properties of the object along with their history.

​
objectWriteTraceId
string