marketing

Anshin Marketing API

Anshin Marketing API は、リード、キャンペーン、問い合わせ、分析データの外部連携を扱います。

Scope groups

4 件

API items

28 件

Base URL

https://api.marketing.anshin.care

API artifact coverage

operations

write APIs

idempotency

100%

high risk

Data classification

restricted: 1
confidential: 10
internal: 13

Scope risk

none: 1
medium: 9
low: 9
high: 5

スコープ別 API

業務スコープを選ぶと、right side contents に API 項目一覧を表示します。

共通仕様

スコープAPI 項目

法人7 API items7 件リード6 API items6 件キャンペーン10 API items10 件商談・成果5 API items5 件

表示：4 件

GET /integrations/v1/deals

GET 商談

公開中

分類: guide
scope: marketing
API group: list_integration_deals_api_integrations_v1_deals_get
endpoint: GET /integrations/v1/deals

GET/integrations/v1/deals

List Integration Deals

Auth

Integration token

Idempotency-Key

not required

Scopes

1 required

operationId

list_integration_deals_api_integrations_v1_deals_get

Lifecycle

stable

Risk

medium

Classification

confidential

Resource

deal

Required Scope

required

deals:read

Parameters

name	in	required	schema
limit	query	optional	integer
offset	query	optional	integer

Request

request body はありません

Response

status	media type	schema
200	application/json	array

Operation Contract

write operation	no
bulk mode	-
bulk max items	-
bulk dry run	-
sync type	paginated-list
sync max limit	200
reconciliation	-

cURL

curl -X GET "https://api.marketing.anshin.care/api/integrations/v1/deals" \
  -H "Authorization: Bearer $ANSHIN_MARKETING_INTEGRATION_ACCESS_TOKEN" \

Endpoint

field	value
method	GET
path	/api/integrations/v1/deals
operationId	list_integration_deals_api_integrations_v1_deals_get
auth	server to server integration client token
Idempotency-Key	not required
lifecycle	stable
resource type	deal
data classification	confidential
scope risk	medium
write operation	no

Summary

List Integration Deals

Required scope

scope	requirement
deals:read	required

Operation contract

field	value
bulk mode	-
bulk max items	-
bulk dry run	-
sync type	paginated-list
sync max limit	200
reconciliation	-

Path parameters

name	required	schema
-	-	-
-	-	-

Query parameters

name	required	schema
limit	optional	integer
offset	optional	integer

Header parameters

name	required	schema
-	-	-
-	-	-

Request body

status	media type	schema
-	-	-
-	-	-

Response

status	media type	schema
200	application/json	array

Example

curl -X GET "https://api.marketing.anshin.care/api/integrations/v1/deals" \
  -H "Authorization: Bearer $ANSHIN_MARKETING_INTEGRATION_ACCESS_TOKEN" \

業務境界

domain: 商談・成果
endpoint は各 backend の S2S scoped OpenAPI artifact から同期しています。
company 境界は backend で検証します。
write 系 endpoint は、画面用 API と endpoint を分け、処理本体は service 層で共通化します。