GET
/
crm
/
v3
/
objects
/
{objectType}
リスト
curl --request GET \
  --url https://api.hubapi.com/crm/v3/objects/{objectType} \
  --header 'Authorization: Bearer <token>'
{
  "results": [
    {
      "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"
    }
  ],
  "paging": {
    "next": {
      "after": "NTI1Cg%3D%3D",
      "link": "?after=NTI1Cg%3D%3D"
    },
    "prev": {
      "before": "<string>",
      "link": "<string>"
    }
  }
}
サポートされる製品
次のいずれかの製品またはそれ以上が必要です。
Marketing HubMarketing Hub無料ツール
Sales HubSales Hub無料ツール
Service HubService Hub無料ツール
Content HubContent Hub無料ツール

​
必須スコープ

この API には、次のいずれかのスコープが必要です。
  • crm.objects.orders.read
  • crm.objects.appointments.sensitive.read.v2
  • crm.objects.contacts.highly_sensitive.read.v2
  • crm.objects.companies.write
  • crm.objects.custom.sensitive.read.v2
  • crm.objects.users.read
  • crm.objects.users.write
  • crm.objects.commercepayments.write
  • crm.objects.invoices.write
  • crm.objects.contacts.highly_sensitive.write.v2
  • crm.objects.carts.write
  • crm.objects.appointments.write
  • crm.objects.partner-services.read
  • crm.objects.custom.write
  • tickets
  • crm.objects.deals.sensitive.write.v2
  • oauth
  • crm.objects.deals.highly_sensitive.write.v2
  • crm.objects.companies.highly_sensitive.write.v2
  • tickets.sensitive.v2
  • crm.objects.appointments.read
  • crm.objects.appointments.sensitive.write.v2
  • media_bridge.read
  • crm.objects.listings.read
  • crm.objects.courses.write
  • crm.objects.carts.read
  • crm.objects.listings.write
  • crm.objects.custom.read
  • crm.objects.deals.read
  • crm.objects.subscriptions.read
  • crm.objects.companies.sensitive.read.v2
  • crm.objects.companies.read
  • crm.objects.custom.sensitive.write.v2
  • crm.objects.deals.highly_sensitive.read.v2
  • crm.objects.contacts.sensitive.write.v2
  • crm.objects.companies.highly_sensitive.read.v2
  • crm.objects.partner-services.write
  • crm.objects.contacts.read
  • crm.objects.services.write
  • crm.objects.orders.write
  • crm.objects.subscriptions.write
  • crm.objects.commercepayments.read
  • crm.objects.products.write
  • crm.objects.custom.highly_sensitive.read.v2
  • crm.objects.deals.write
  • crm.objects.invoices.read
  • e-commerce
  • tickets.highly_sensitive.v2
  • crm.objects.quotes.write
  • crm.objects.leads.read
  • crm.objects.leads.write
  • crm.objects.custom.highly_sensitive.write.v2
  • crm.objects.deals.sensitive.read.v2
  • crm.objects.goals.write
  • crm.objects.companies.sensitive.write.v2
  • crm.objects.contacts.write
  • crm.objects.goals.read
  • crm.objects.partner-clients.write
  • crm.objects.line_items.read
  • crm.objects.contacts.sensitive.read.v2
  • crm.objects.line_items.write
  • crm.objects.products.read
  • crm.objects.courses.read
  • crm.objects.quotes.read
  • crm.objects.partner-clients.read
  • crm.objects.services.read

Authorizations

​
Authorization
string
header
required

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

Path Parameters

​
objectType
string
required

Query Parameters

​
limit
integer
default:10

ページごとに表示する結果の最大数。

​
after
string

最後に正常に読み取られたリソースのページ操作カーソルトークンは、より多くの結果を含むページ付きレスポンスのpaging.next.after JSONプロパティーとして返されます。

​
properties
string[]

レスポンスで返されるプロパティーのカンマ区切りリスト。指定されたプロパティーがリクエストされたオブジェクトに存在しない場合は、無視されます。

​
propertiesWithHistory
string[]

以前の値の履歴と一緒に返されるプロパティーのカンマ区切りリスト。指定されたプロパティーがリクエストされたオブジェクトに存在しない場合は、無視されます。このパラメーターを使用することで、1回のリクエストで読み取れるオブジェクトの最大数が減ります。

​
associations
string[]

関連付けられているIDを取得するオブジェクトタイプのカンマ区切りリスト。指定された関連付けが存在しない場合は、無視されます。

​
archived
boolean
default:false

アーカイブ済みの結果のみを返すかどうか。

Response

successful operation

​
results
object[]
required
​
paging
object