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/leads/{lead_id}

GET リード

公開中

分類: guide
scope: marketing
API group: get_integration_lead_api_integrations_v1_leads__lead_id__get
endpoint: GET /integrations/v1/leads/{lead_id}

GET/integrations/v1/leads/{lead_id}

Get Integration Lead

Auth

Integration token

Idempotency-Key

not required

Scopes

1 required

operationId

get_integration_lead_api_integrations_v1_leads__lead_id__get

Lifecycle

stable

Risk

low

Classification

confidential

Resource

lead

Required Scope

required

leads:read

optional

leads:contact:read

Parameters

name	in	required	schema
lead_id	path	required	string

Request

request body はありません

Response

status	media type	schema
200	application/json	LeadOut campaign_idstring \| nulloptional activity_idstring \| nulloptional business_location_idstring \| nulloptional business_location_service_idstring \| nulloptional sourcestringoptional statusstringoptional namestring \| nulloptional company_namestring \| nulloptional phonestring \| nulloptional emailstring \| nulloptional regionstring \| nulloptional inquiry_bodystring \| nulloptional assigned_user_namestring \| nulloptional consent_statusstringoptional idstringrequired tenant_idstringrequired received_atstringrequired created_atstringrequired updated_atstringrequired

Operation Contract

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

cURL

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

Endpoint

field	value
method	GET
path	/api/integrations/v1/leads/{lead_id}
operationId	get_integration_lead_api_integrations_v1_leads__lead_id__get
auth	server to server integration client token
Idempotency-Key	not required
lifecycle	stable
resource type	lead
data classification	confidential
scope risk	low
write operation	no

Summary

Get Integration Lead

Required scope

scope	requirement
leads:read	required

Operation contract

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

Path parameters

name	required	schema
lead_id	required	string

Query parameters

name	required	schema
-	-	-
-	-	-

Header parameters

name	required	schema
-	-	-
-	-	-

Request body

status	media type	schema
-	-	-
-	-	-

Response

status	media type	schema
200	application/json	LeadOut

Example

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

業務境界

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