GET
/
crm
/
v3
/
objects
/
invoices
リスト
curl --request GET \
  --url https://api.hubapi.com/crm/v3/objects/invoices \
  --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.invoices.read

Authorizations

​
Authorization
string
header
required

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

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

The response is of type object.