Skip to main content
GET
/
crm
/
v3
/
objects
/
companies
/
{companyId}
Recupera una empresa
curl --request GET \
  --url https://api.hubapi.com/crm/v3/objects/companies/{companyId} \
  --header 'Authorization: Bearer <token>'
{
  "archived": true,
  "createdAt": "2023-11-07T05:31:56Z",
  "id": "<string>",
  "properties": {},
  "updatedAt": "2023-11-07T05:31:56Z",
  "archivedAt": "2023-11-07T05:31:56Z",
  "associations": {},
  "objectWriteTraceId": "<string>",
  "propertiesWithHistory": {},
  "url": "<string>"
}

Productos compatibles

Se requiere uno de los siguientes productos o productos de ediciones superiores.
Marketing HubMarketing Hub -Gratuito
Sales HubSales Hub -Gratuito
Service HubService Hub -Gratuito
Content HubContent Hub -Gratuito
Esta API requiere uno de los siguientes ámbitos:
crm.objects.companies.read

Authorizations

​
Authorization
string
header
required

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

Path Parameters

​
companyId
string
required

Query Parameters

​
archived
boolean
default:false

Si se quieren devolver solo los resultados que se han archivado.

​
associations
string[]

Una lista separada por comas de los tipos de objetos para los que se desea recuperar los ID asociados. Si alguna de las asociaciones especificadas no existe, se ignorará.

​
idProperty
string

El nombre de una propiedad cuyos valores son únicos para este objeto

​
properties
string[]

Una lista separada por comas de las propiedades que se devolverán en la respuesta. Si alguna de las propiedades especificadas no está presente en los objetos solicitados, se ignorará.

​
propertiesWithHistory
string[]

Una lista separada por comas de las propiedades que se devolverán junto con su historial de valores anteriores. Si alguna de las propiedades especificadas no está presente en los objetos solicitados, se ignorará.

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

Whether the object is archived.

​
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.

​
archivedAt
string<date-time>

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

​
associations
object

A list defining relationships with other objects.

​
objectWriteTraceId
string
​
propertiesWithHistory
object

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

​
url
string