Senses Open API References (v1)

Download OpenAPI specification:Download

Overview

Sensesユーザ向けAPIです。本ドキュメントを確認頂き、ご利用ください。 また随時APIは拡張していきますので、ご希望のものがない場合は右下のチャットサポートからリクエストください。今後の開発の参考とさせて頂きます。

Introduction

Endpoints

APIのエンドポイントのベースURLは以下になります。バージョンの v1 も含めてリクエストしてください。 {PATH_TO_REQUEST} は利用するAPIのパスを指定してください。

https://senses-open-api.mazrica.com/v1/{PATH_TO_REQUEST}

Requests Limit

APIのリクエストには以下の制限があります。制限を超過した場合は 429 Too Many Requests がレスポンスされます。

  • 10,000リクエスト / 日
    • リクエスト数のリセットタイミングは UTC となります
  • 3リクエスト / 秒 (バースト 100)
    • トークンバケット 方式を利用した仕組みとなります

Sort

リストを返す API では、要素が「更新日時の降順」でソートされて返ってきます。ソート順を変更するには sort パラメータに並び替えのキーとなるプロパティを指定します。キーの前に - (ダッシュ) をつけると 降順 となります。以下を参考にしてください。

  • 更新日時の昇順でソートする場合
https://senses-open-api.mazrica.com/v1/customers?sort=updatedAt
  • 複数指定も可能(更新日時の降順かつidの昇順)
https://senses-open-api.mazrica.com/v1/customers?sort=-updatedAt,id

Authentication

X-Api-Key

APIの利用には APK Key が必要です。以下をご参考にSensesの管理機能から API Key を発行できます。APIをリクエストする際、発行した API Key をリクエストに含めてください。

  • オンラインマニュアル: SensesAPIを利用する – Senses
  • 以下のように生成した APK Key を リクエスト時のヘッダで X-Api-Key に指定してください
curl -X GET \
  https://senses-open-api.mazrica.com/v1/domains/settings \
  -H 'X-Api-Key: YOUR_API_KEY'
Security Scheme Type API Key
Header parameter name: X-Api-Key

チーム(Domains)

チーム設定情報取得 Deprecated

  • 所属しているチームの設定情報を取得

このエンドポイントは非推奨です。 ユーザー数やチーム設定が多い場合、性能に問題が出る可能性があります。 各種設定の取得には、以下の設定別エンドポイントをご利用ください。

Authorizations:

Responses

200

OK

404

Not Found

500

Internal Server Error

get /domains/settings

The Open API Service by Senses

https://senses-open-api.mazrica.com/v1/domains/settings

Response samples

Content type
application/json
Copy
Expand all Collapse all
{
  • "dealTypes":
    [
    ],
  • "users":
    [
    ],
  • "roles":
    [
    ]
}

ユーザー(Users)

ユーザー情報リスト取得

  • ユーザー情報のリスト取得
  • 一度に取得できる件数は100件
  • pageを指定することで続きを取得
Authorizations:
query Parameters
page
integer

ページ

Responses

200

OK

500

Internal Server Error

get /users

The Open API Service by Senses

https://senses-open-api.mazrica.com/v1/users

Response samples

Content type
application/json
Copy
Expand all Collapse all
{
  • "totalCount": 0,
  • "page": 0,
  • "users":
    [
    ]
}

ロール(Roles)

ロール情報リスト取得

  • ロール情報のリスト取得
  • 一度に取得できる件数は100件
  • pageを指定することで続きを取得
Authorizations:
query Parameters
page
integer

ページ

Responses

200

OK

500

Internal Server Error

get /roles

The Open API Service by Senses

https://senses-open-api.mazrica.com/v1/roles

Response samples

Content type
application/json
Copy
Expand all Collapse all
{
  • "totalCount": 0,
  • "page": 0,
  • "roles":
    [
    ]
}

取引先設定(CustomerSetting)

取引先設定

  • 取引先設定の取得
Authorizations:

Responses

200

OK

500

Internal Server Error

get /customer_setting

The Open API Service by Senses

https://senses-open-api.mazrica.com/v1/customer_setting

Response samples

Content type
application/json
Copy
Expand all Collapse all
{
  • "customerCustomItems":
    [
    ]
}

取引先(Customers)

取引先情報リスト

  • 取引先の情報のリスト取得
  • 一度に取得できる件数は100件
  • pageを指定することで続きを取得
Authorizations:
query Parameters
searchWord
string

指定した文字列と取引先名が部分一致する取引先を検索します。

sort
string

並び順 ソート可能 updatedAt

updatedAtFrom
string <date-time>
Example: updatedAtFrom=2018-04-01T10:30:00

更新日時による検索範囲(開始)

  • ex) 2018-04-01T10:30:00
updatedAtTo
string <date-time>
Example: updatedAtTo=2018-04-01T10:30:00

更新日時による検索範囲(終了)

  • ex) 2018-04-01T10:30:00
page
integer

ページ

Responses

200

OK

500

Internal Server Error

get /customers

The Open API Service by Senses

https://senses-open-api.mazrica.com/v1/customers

Response samples

Content type
application/json
Copy
Expand all Collapse all
{
  • "totalCount": 0,
  • "page": 0,
  • "customers":
    [
    ]
}

取引先情報登録

  • 取引先情報を新規に登録します
  • 登録後の取引先IDをレスポンスとして返します
Authorizations:
Request Body schema: application/json
name
required
string

取引先名

address
string

住所

telNo
string

電話番号

webUrl
string

URL

employee
integer

従業員数

capital
integer

資本金

closingMonth
integer [ 1 .. 12 ]

決算月(1〜12)

ownerRoleId
integer

所有ロールID

customerCustoms
Array of objects

取引先詳細項目

Responses

201

Created

500

Internal Server Error

post /customers

The Open API Service by Senses

https://senses-open-api.mazrica.com/v1/customers

Request samples

Content type
application/json
Copy
Expand all Collapse all
{
  • "name": "string",
  • "address": "string",
  • "telNo": "string",
  • "webUrl": "string",
  • "employee": 0,
  • "capital": 0,
  • "closingMonth": 1,
  • "ownerRoleId": 0,
  • "customerCustoms":
    [
    ]
}

Response samples

Content type
application/json
Copy
Expand all Collapse all
{
  • "id": 0,
  • "name": "string",
  • "address": "string",
  • "telNo": "string",
  • "webUrl": "string",
  • "employee": 0,
  • "capital": 0,
  • "closingMonth": 0,
  • "ownerRole":
    {
    },
  • "createdAt": "2018-04-01T10:30:00+09:00",
  • "updatedAt": "2018-04-01T10:30:00+09:00",
  • "customerCustoms":
    [
    ]
}

取引先情報検索

取引先情報を検索します。

  • fieldreference (参照先関連オブジェクト) 指定には対応していません。
Authorizations:
Request Body schema: application/json
filter
required
object

絞り込み条件

sort
object

並び替え条件。

  • 詳細項目、関連オブジェクトの項目指定の並び替えには対応していません。

Responses

200

OK

400

検索条件が不正

500

Internal Server Error

post /customers/search

The Open API Service by Senses

https://senses-open-api.mazrica.com/v1/customers/search

Request samples

Content type
application/json
Copy
Expand all Collapse all
{
  • "filter":
    {
    },
  • "sort":
    {
    }
}

Response samples

Content type
application/json
Copy
Expand all Collapse all
{
  • "totalCount": 0,
  • "page": 0,
  • "customers":
    [
    ]
}

取引先情報

  • 取引先情報を取得
Authorizations:
path Parameters
id
required
integer

取引先ID

Responses

200

OK

404

Not Found

500

Internal Server Error

get /customers/{id}

The Open API Service by Senses

https://senses-open-api.mazrica.com/v1/customers/{id}

Response samples

Content type
application/json
Copy
Expand all Collapse all
{
  • "id": 0,
  • "name": "string",
  • "address": "string",
  • "telNo": "string",
  • "webUrl": "string",
  • "employee": 0,
  • "capital": 0,
  • "closingMonth": 0,
  • "ownerRole":
    {
    },
  • "createdAt": "2018-04-01T10:30:00+09:00",
  • "updatedAt": "2018-04-01T10:30:00+09:00",
  • "customerCustoms":
    [
    ]
}

取引先情報更新

  • 取引先情報を更新
Authorizations:
path Parameters
id
required
integer

取引先ID

Request Body schema: application/json
name
required
string

取引先名

address
string

住所

telNo
string

電話番号

webUrl
string

URL

employee
integer

従業員数

capital
integer

資本金

closingMonth
integer [ 1 .. 12 ]

決算月(1〜12)

ownerRoleId
integer

所有ロールID

customerCustoms
Array of objects

取引先詳細項目

Responses

200

OK

400

Bad Request

500

Internal Server Error

patch /customers/{id}

The Open API Service by Senses

https://senses-open-api.mazrica.com/v1/customers/{id}

Request samples

Content type
application/json
Copy
Expand all Collapse all
{
  • "name": "string",
  • "address": "string",
  • "telNo": "string",
  • "webUrl": "string",
  • "employee": 0,
  • "capital": 0,
  • "closingMonth": 1,
  • "ownerRoleId": 0,
  • "customerCustoms":
    [
    ]
}

Response samples

Content type
application/json
Copy
Expand all Collapse all
{
  • "id": 0,
  • "name": "string",
  • "address": "string",
  • "telNo": "string",
  • "webUrl": "string",
  • "employee": 0,
  • "capital": 0,
  • "closingMonth": 0,
  • "ownerRole":
    {
    },
  • "createdAt": "2018-04-01T10:30:00+09:00",
  • "updatedAt": "2018-04-01T10:30:00+09:00",
  • "customerCustoms":
    [
    ]
}

取引先情報削除

  • 取引先情報を削除
  • 取引先に紐づく案件、アクション、コンタクトは全て削除されます
Authorizations:
path Parameters
id
required
integer

取引先ID

Responses

200

OK

404

Not Found

500

Internal Server Error

delete /customers/{id}

The Open API Service by Senses

https://senses-open-api.mazrica.com/v1/customers/{id}

案件設定(DealSetting)

案件タイプリスト

  • 案件タイプのリスト取得
Authorizations:

Responses

200

OK

500

Internal Server Error

get /deal_setting/deal_types

The Open API Service by Senses

https://senses-open-api.mazrica.com/v1/deal_setting/deal_types

Response samples

Content type
application/json
Copy
Expand all Collapse all
{
  • "id": 0,
  • "name": "string"
}

案件タイプ設定情報

  • 案件タイプ設定情報
Authorizations:
path Parameters
id
required
integer

案件タイプID

Responses

200

OK

404

Not Found

500

Internal Server Error

get /deal_setting/deal_types/{id}

The Open API Service by Senses

https://senses-open-api.mazrica.com/v1/deal_setting/deal_types/{id}

Response samples

Content type
application/json
Copy
Expand all Collapse all
{
  • "id": 0,
  • "name": "string",
  • "phases":
    [
    ],
  • "products":
    [
    ],
  • "probabilities":
    [
    ],
  • "channels":
    [
    ],
  • "endPhaseReasons":
    [
    ],
  • "actionsPurposes":
    [
    ],
  • "dealCustomItems":
    [
    ],
  • "dealProductDetailTypes":
    [
    ]
}

案件(Deals)

案件情報リスト

  • 案件情報のリスト取得
  • 一度に取得できる件数は100件
  • pageを指定することで続きを取得
Authorizations:
query Parameters
searchWord
string

指定した文字列と取引先名、または案件名が部分一致する案件を検索します。

sort
string

並び順 ソート可能 updatedAt

updatedAtFrom
string <date-time>
Example: updatedAtFrom=2018-04-01T10:30:00

更新日時による検索範囲(開始)

  • ex) 2018-04-01T10:30:00
updatedAtTo
string <date-time>
Example: updatedAtTo=2018-04-01T10:30:00

更新日時による検索範囲指定(終了)

  • ex) 2018-04-01T10:30:00
page
integer

ページ

Responses

200

OK

500

Internal Server Error

get /deals

The Open API Service by Senses

https://senses-open-api.mazrica.com/v1/deals

Response samples

Content type
application/json
Copy
Expand all Collapse all
{
  • "totalCount": 0,
  • "page": 0,
  • "deals":
    [
    ]
}

案件情報登録

  • 案件情報を新規に登録します
  • 登録後の案件IDをレスポンスとして返します
  • 案件IDに該当する案件が存在しない場合は、登録エラーとなります
  • フェーズ、商品、契約確度、チャネル、ユーザー、最終停止理由、案件詳細項目、商品内訳に関するパラメータは、チーム設定情報取得APIで取得できる情報を指定する必要があります
  • IDがSenses上に存在しない、異なる案件タイプ用のIDが設定されている等、データに不整合がある場合、登録エラーとなります
  • 案件詳細項目の四則演算タイプの登録には対応していません
Authorizations:
Request Body schema: application/json
name
required
string

案件名

amount
integer

契約金額

expectedContractDate
required
string <date>

契約予定日

reason
string

最終停止理由

dealType
required
object

案件タイプ

endPhaseReasonIds
Array of integers

最終停止理由ID 配列

customer
required
object

取引先

phase
required
object

フェーズ

product
required
object

商品

probability
required
object

契約確度

channel
required
object

チャネル

user
required
object

ユーザー

dealCustoms
Array of objects

案件詳細項目

dealProductDetails
Array of objects

商品内訳

Responses

201

Created

500

Internal Server Error

post /deals

The Open API Service by Senses

https://senses-open-api.mazrica.com/v1/deals

Request samples

Content type
application/json
Copy
Expand all Collapse all
{
  • "name": "string",
  • "amount": 0,
  • "expectedContractDate": "2018-04-11",
  • "reason": "string",
  • "dealType":
    {
    },
  • "endPhaseReasonIds":
    [
    ],
  • "customer":
    {
    },
  • "phase":
    {
    },
  • "product":
    {
    },
  • "probability":
    {
    },
  • "channel":
    {
    },
  • "user":
    {
    },
  • "dealCustoms":
    [
    ],
  • "dealProductDetails":
    [
    ]
}

Response samples

Content type
application/json
Copy
Expand all Collapse all
{
  • "id": 0,
  • "name": "string",
  • "dealCode": "string",
  • "amount": 0,
  • "closingLeadtime": 0,
  • "fromEmail": true,
  • "memo": "string",
  • "expectedContractDate": "2018-04-11",
  • "createdAt": "2018-04-01T10:30:00+09:00",
  • "updatedAt": "2018-04-01T10:30:00+09:00",
  • "reason": "string",
  • "dealType":
    {
    },
  • "endPhaseReasons":
    [
    ],
  • "customer":
    {
    },
  • "phase":
    {
    },
  • "product":
    {
    },
  • "probability":
    {
    },
  • "channel":
    {
    },
  • "user":
    {
    },
  • "dealCustoms":
    [
    ],
  • "dealProductDetails":
    [
    ]
}

案件情報

  • 案件情報を取得
Authorizations:
path Parameters
id
required
integer

案件ID

Responses

200

OK

404

Not Found

500

Internal Server Error

get /deals/{id}

The Open API Service by Senses

https://senses-open-api.mazrica.com/v1/deals/{id}

Response samples

Content type
application/json
Copy
Expand all Collapse all
{
  • "id": 0,
  • "name": "string",
  • "dealCode": "string",
  • "amount": 0,
  • "closingLeadtime": 0,
  • "fromEmail": true,
  • "memo": "string",
  • "expectedContractDate": "2018-04-11",
  • "createdAt": "2018-04-01T10:30:00+09:00",
  • "updatedAt": "2018-04-01T10:30:00+09:00",
  • "reason": "string",
  • "dealType":
    {
    },
  • "endPhaseReasons":
    [
    ],
  • "customer":
    {
    },
  • "phase":
    {
    },
  • "product":
    {
    },
  • "probability":
    {
    },
  • "channel":
    {
    },
  • "user":
    {
    },
  • "dealCustoms":
    [
    ],
  • "dealProductDetails":
    [
    ]
}

案件情報更新

  • 案件情報を更新
Authorizations:
path Parameters
id
required
integer

案件ID

Request Body schema: application/json
name
string

案件名

amount
integer

契約金額

expectedContractDate
string <date>

契約予定日

reason
string

最終停止理由

dealType
object

案件タイプ

endPhaseReasonIds
Array of integers

最終停止理由ID 配列

customer
object

取引先

phase
object

フェーズ

product
object

商品

probability
object

契約確度

channel
object

チャネル

user
required
object

ユーザー

dealCustoms
Array of objects

案件詳細項目

dealProductDetails
Array of objects

商品内訳

Responses

200

OK

400

Bad Request

500

Internal Server Error

patch /deals/{id}

The Open API Service by Senses

https://senses-open-api.mazrica.com/v1/deals/{id}

Request samples

Content type
application/json
Copy
Expand all Collapse all
{
  • "name": "string",
  • "amount": 0,
  • "expectedContractDate": "2018-04-11",
  • "reason": "string",
  • "dealType":
    {
    },
  • "endPhaseReasonIds":
    [
    ],
  • "customer":
    {
    },
  • "phase":
    {
    },
  • "product":
    {
    },
  • "probability":
    {
    },
  • "channel":
    {
    },
  • "user":
    {
    },
  • "dealCustoms":
    [
    ],
  • "dealProductDetails":
    [
    ]
}

Response samples

Content type
application/json
Copy
Expand all Collapse all
{
  • "id": 0,
  • "name": "string",
  • "dealCode": "string",
  • "amount": 0,
  • "closingLeadtime": 0,
  • "fromEmail": true,
  • "memo": "string",
  • "expectedContractDate": "2018-04-11",
  • "createdAt": "2018-04-01T10:30:00+09:00",
  • "updatedAt": "2018-04-01T10:30:00+09:00",
  • "reason": "string",
  • "dealType":
    {
    },
  • "endPhaseReasons":
    [
    ],
  • "customer":
    {
    },
  • "phase":
    {
    },
  • "product":
    {
    },
  • "probability":
    {
    },
  • "channel":
    {
    },
  • "user":
    {
    },
  • "dealCustoms":
    [
    ],
  • "dealProductDetails":
    [
    ]
}

案件情報削除

  • 案件情報を削除
  • 案件に紐づく案件、アクションは全て削除されます
Authorizations:
path Parameters
id
required
integer

案件ID

Responses

200

OK

404

Not Found

500

Internal Server Error

delete /deals/{id}

The Open API Service by Senses

https://senses-open-api.mazrica.com/v1/deals/{id}

案件アクション(actions)

案件アクション情報リスト

  • アクション情報のリスト取得
  • 一度に取得できる件数は100件
  • pageを指定することで続きを取得
Authorizations:
query Parameters
sort
string

並び順 ソート可能 startDatetime

startDatetime
string <date-time>
Example: startDatetime=2018-04-01T10:30:00

開始日時

ex)

  • startDatetime=2019-01-01T09:00
  • endDatetime=2019-01-01T11:00

上記のように指定した場合、開始日時2019-01-01 09:00 から 終了日時2019-01-01 11:00のアクションを検索します。

endDatetime
string <date-time>
Example: endDatetime=2018-04-01T10:30:00

終了日時

ex)

  • startDatetime=2019-01-01T09:00
  • endDatetime=2019-01-01T11:00

上記のように指定した場合、開始日時2019-01-01 09:00 から 終了日時2019-01-01 11:00のアクションを検索します。

users
Array of objects

アクション担当者、その他の担当者を検索します。

GETパラメータで指定する場合、以下の形式で指定します。

?users[]id=1&users[]id=2

purpose
integer

アクションの目的

active
boolean

true:予定 false:完了

dealId
integer

案件IDを指定して検索します。

page
integer

ページ

Responses

200

OK

500

Internal Server Error

get /actions

The Open API Service by Senses

https://senses-open-api.mazrica.com/v1/actions

Response samples

Content type
application/json
Copy
Expand all Collapse all
{
  • "totalCount": 0,
  • "page": 0,
  • "actions":
    [
    ]
}

案件アクション登録

  • アクションを新規に登録します
  • 登録後のアクションをレスポンスとして返します
  • アクションIDに該当するアクションが存在しない場合は、登録エラーとなります
  • IDがSenses上に存在しない、異なる案件タイプ用のIDが設定されている等、データに不整合がある場合、登録エラーとなります
Authorizations:
Request Body schema: application/json
purpose
required
object

アクションの目的。

アクションの種別は目的に対応する値が自動的に設定されます。

目的と種別の組み合わせはDomainsAPIのactionsPurposesで確認できます。

deal
required
object

案件ID

startDatetime
required
string <date-time>

開始日時

endDatetime
required
string <date-time>

終了日時

creator
required
object

アクション担当者ID

invitees
Array of objects

他の担当者

preNote
string

アクションの事前メモ

result
string

アクションの実施結果

active
boolean

アクションの状態(true=未完了、false=完了)

contacts
Array of objects

アクションコンタクト

Responses

201

Created

400

Bad Request

404

Not Found

500

Internal Server Error

post /actions

The Open API Service by Senses

https://senses-open-api.mazrica.com/v1/actions

Request samples

Content type
application/json
Copy
Expand all Collapse all
{
  • "purpose":
    {
    },
  • "deal":
    {
    },
  • "startDatetime": "2018-04-01T10:30:00+09:00",
  • "endDatetime": "2018-04-01T10:30:00+09:00",
  • "creator":
    {
    },
  • "invitees":
    [
    ],
  • "preNote": "string",
  • "result": "string",
  • "active": true,
  • "contacts":
    [
    ]
}

Response samples

Content type
application/json
Copy
Expand all Collapse all
{
  • "id": 0,
  • "pattern":
    {
    },
  • "purpose":
    {
    },
  • "deal":
    {
    },
  • "startDatetime": null,
  • "createdAt": "2018-04-01T10:30:00+09:00",
  • "updatedAt": "2018-04-01T10:30:00+09:00",
  • "preNote": "string",
  • "endDatetime": null,
  • "active": true,
  • "result": "string",
  • "syncCalendar": true,
  • "contacts":
    [
    ],
  • "creator":
    {
    },
  • "invitees":
    [
    ]
}

案件アクション情報

  • アクション情報を取得
Authorizations:
path Parameters
id
required
integer

アクションID

Responses

200

OK

404

Not Found

500

Internal Server Error

get /actions/{id}

The Open API Service by Senses

https://senses-open-api.mazrica.com/v1/actions/{id}

Response samples

Content type
application/json
Copy
Expand all Collapse all
{
  • "id": 0,
  • "pattern":
    {
    },
  • "purpose":
    {
    },
  • "deal":
    {
    },
  • "startDatetime": null,
  • "createdAt": "2018-04-01T10:30:00+09:00",
  • "updatedAt": "2018-04-01T10:30:00+09:00",
  • "preNote": "string",
  • "endDatetime": null,
  • "active": true,
  • "result": "string",
  • "syncCalendar": true,
  • "contacts":
    [
    ],
  • "creator":
    {
    },
  • "invitees":
    [
    ]
}

案件アクション情報更新

  • アクション情報を更新
Authorizations:
path Parameters
id
required
integer

アクションID

Request Body schema: application/json
purpose
object

アクションの目的。

アクションの種別は目的に対応する値が自動的に設定されます。

目的と種別の組み合わせはDomainsAPIのactionsPurposesで確認できます。

deal
object

案件ID

startDatetime
string <date-time>

開始日時

endDatetime
string <date-time>

終了日時

invitees
Array of objects

他の担当者

invitees指定なし->何もしない

invitees:[]->全削除

invitees:[何か指定]->指定された通りに追加更新削除

preNote
string

アクションの事前メモ

result
string

アクションの実施結果

active
boolean

アクションの状態(true=未完了、false=完了)

contacts
Array of objects

コンタクトID

Responses

200

OK

400

Bad Request

500

Internal Server Error

patch /actions/{id}

The Open API Service by Senses

https://senses-open-api.mazrica.com/v1/actions/{id}

Request samples

Content type
application/json
Copy
Expand all Collapse all
{
  • "purpose":
    {
    },
  • "deal":
    {
    },
  • "startDatetime": "2018-04-01T10:30:00+09:00",
  • "endDatetime": "2018-04-01T10:30:00+09:00",
  • "invitees":
    [
    ],
  • "preNote": "string",
  • "result": "string",
  • "active": true,
  • "contacts":
    [
    ]
}

Response samples

Content type
application/json
Copy
Expand all Collapse all
{
  • "id": 0,
  • "pattern":
    {
    },
  • "purpose":
    {
    },
  • "deal":
    {
    },
  • "startDatetime": null,
  • "createdAt": "2018-04-01T10:30:00+09:00",
  • "updatedAt": "2018-04-01T10:30:00+09:00",
  • "preNote": "string",
  • "endDatetime": null,
  • "active": true,
  • "result": "string",
  • "syncCalendar": true,
  • "contacts":
    [
    ],
  • "creator":
    {
    },
  • "invitees":
    [
    ]
}

案件アクション情報削除

  • アクション情報を削除
Authorizations:
path Parameters
id
required
integer

アクションID

Responses

200

OK

404

Not Found

500

Internal Server Error

delete /actions/{id}

The Open API Service by Senses

https://senses-open-api.mazrica.com/v1/actions/{id}

コンタクト設定(ContactSetting)

コンタクト設定

  • コンタクト設定の取得
Authorizations:

Responses

200

OK

500

Internal Server Error

get /contact_setting

The Open API Service by Senses

https://senses-open-api.mazrica.com/v1/contact_setting

Response samples

Content type
application/json
Copy
Expand all Collapse all
{
  • "contactCustomItems":
    [
    ]
}

コンタクト(contacts)

コンタクト情報リスト

  • コンタクトの情報のリスト取得
  • 一度に取得できる件数は100件
  • pageを指定することで続きを取得
Authorizations:
query Parameters
searchWord
string

指定した文字列と取引先名、コンタクト名、またはメールアドレスが部分一致するコンタクトを検索します。

sort
string

並び順 ソート可能 updatedAt

updatedAtFrom
string <date-time>
Example: updatedAtFrom=2018-04-01T10:30:00

更新日時による検索範囲(開始)

  • ex) 2018-04-01T10:30:00
updatedAtTo
string <date-time>
Example: updatedAtTo=2018-04-01T10:30:00

更新日時による検索範囲(終了)

  • ex) 2018-04-01T10:30:00
page
integer

ページ

phoneNumber
string
Example: phoneNumber=03-1111-2222

固定電話番号、携帯電話番号による検索
ハイフン 市外局番 検索可能

  • ex) 03-1111-2222
  • ex) 0311112222
  • ex) 04992(0)1111
  • ex) 049920局1111

Responses

200

OK

500

Internal Server Error

get /contacts

The Open API Service by Senses

https://senses-open-api.mazrica.com/v1/contacts

Response samples

Content type
application/json
Copy
Expand all Collapse all
[
  • {
    }
]

コンタクト情報登録

  • コンタクト情報を新規に登録します
  • 登録後のコンタクト情報をレスポンスとして返します
Authorizations:
Request Body schema: application/json
name
required
string

コンタクト名

email
string Nullable

メールアドレス

tel
string Nullable

電話番号

mobileTel
string Nullable

携帯電話番号

address
string Nullable

住所

dept
string Nullable

部署

position
string Nullable

役職

memo
string Nullable

メモ

customer
object Nullable

取引先

contactCustoms
Array of objects

コンタクト詳細項目

Responses

201

Created

500

Internal Server Error

post /contacts

The Open API Service by Senses

https://senses-open-api.mazrica.com/v1/contacts

Request samples

Content type
application/json
Copy
Expand all Collapse all
{
  • "name": "string",
  • "email": "string",
  • "tel": "string",
  • "mobileTel": "string",
  • "address": "string",
  • "dept": "string",
  • "position": "string",
  • "memo": "string",
  • "customer":
    {
    },
  • "contactCustoms":
    [
    ]
}

Response samples

Content type
application/json
Copy
Expand all Collapse all
{
  • "id": 0,
  • "name": "string",
  • "email": "string",
  • "tel": "string",
  • "mobileTel": "string",
  • "address": "string",
  • "dept": "string",
  • "position": "string",
  • "memo": "string",
  • "marketoLeadScore": 0,
  • "customer":
    {
    },
  • "createdAt": "2018-04-01T10:30:00+09:00",
  • "updatedAt": "2018-04-01T10:30:00+09:00",
  • "contactCustoms":
    [
    ]
}

コンタクト情報検索

コンタクト情報を検索します。

  • fieldreference (参照先関連オブジェクト) として以下を指定できます。
    • customer (取引先)
Authorizations:
Request Body schema: application/json
filter
required
object

絞り込み条件

sort
object

並び替え条件。

  • 詳細項目、関連オブジェクトの項目指定の並び替えには対応していません。

Responses

200

OK

400

検索条件が不正

500

Internal Server Error

post /contacts/search

The Open API Service by Senses

https://senses-open-api.mazrica.com/v1/contacts/search

Request samples

Content type
application/json
Copy
Expand all Collapse all
{
  • "filter":
    {
    },
  • "sort":
    {
    }
}

Response samples

Content type
application/json
Copy
Expand all Collapse all
{
  • "totalCount": 0,
  • "page": 0,
  • "contacts":
    [
    ]
}

コンタクト情報

  • コンタクト情報を取得
Authorizations:
path Parameters
id
required
integer

コンタクトID

Responses

200

OK

404

Not Found

500

Internal Server Error

get /contacts/{id}

The Open API Service by Senses

https://senses-open-api.mazrica.com/v1/contacts/{id}

Response samples

Content type
application/json
Copy
Expand all Collapse all
{
  • "id": 0,
  • "name": "string",
  • "email": "string",
  • "tel": "string",
  • "mobileTel": "string",
  • "address": "string",
  • "dept": "string",
  • "position": "string",
  • "memo": "string",
  • "marketoLeadScore": 0,
  • "customer":
    {
    },
  • "createdAt": "2018-04-01T10:30:00+09:00",
  • "updatedAt": "2018-04-01T10:30:00+09:00",
  • "contactCustoms":
    [
    ]
}

コンタクト情報更新

  • コンタクト情報を更新
Authorizations:
path Parameters
id
required
integer

コンタクトID

Request Body schema: application/json
name
string

コンタクト名

email
string Nullable

メールアドレス

tel
string Nullable

電話番号

mobileTel
string Nullable

携帯電話番号

address
string Nullable

住所

dept
string Nullable

部署

position
string Nullable

役職

memo
string Nullable

メモ

customer
object Nullable

取引先

contactCustoms
Array of objects

コンタクト詳細項目

Responses

200

OK

400

Bad Request

500

Internal Server Error

patch /contacts/{id}

The Open API Service by Senses

https://senses-open-api.mazrica.com/v1/contacts/{id}

Request samples

Content type
application/json
Copy
Expand all Collapse all
{
  • "name": "string",
  • "email": "string",
  • "tel": "string",
  • "mobileTel": "string",
  • "address": "string",
  • "dept": "string",
  • "position": "string",
  • "memo": "string",
  • "customer":
    {
    },
  • "contactCustoms":
    [
    ]
}

Response samples

Content type
application/json
Copy
Expand all Collapse all
{
  • "id": 0,
  • "name": "string",
  • "email": "string",
  • "tel": "string",
  • "mobileTel": "string",
  • "address": "string",
  • "dept": "string",
  • "position": "string",
  • "memo": "string",
  • "marketoLeadScore": 0,
  • "customer":
    {
    },
  • "createdAt": "2018-04-01T10:30:00+09:00",
  • "updatedAt": "2018-04-01T10:30:00+09:00",
  • "contactCustoms":
    [
    ]
}

コンタクト情報削除

  • コンタクト情報を削除
Authorizations:
path Parameters
id
required
integer

コンタクトID

Responses

200

OK

404

Not Found

500

Internal Server Error

delete /contacts/{id}

The Open API Service by Senses

https://senses-open-api.mazrica.com/v1/contacts/{id}

コンタクトアクション(ContactActions)

コンタクトアクション情報リスト

  • アクション情報のリスト取得
  • 一度に取得できる件数は100件
  • pageを指定することで続きを取得
Authorizations:
path Parameters
contactId
required
integer

コンタクトIDを指定してアクションを検索します。

コンタクトIDの代わりに、allと指定することでコンタクトIDを跨いだアクションの取得が可能です。

また、data_typeを指定することで、アクションの種類を絞り込むことも可能です。

data_type: 0 → コンタクトが紐付いている案件アクション

data_type: 1 → コンタクトアクション

query Parameters
sort
string

並び順 ソート可能 startDatetime

startDatetime
string <date-time>
Example: startDatetime=2018-04-01T10:30:00

開始日時

ex)

  • startDatetime=2019-01-01T09:00
  • endDatetime=2019-01-01T11:00

上記のように指定した場合、開始日時2019-01-01 09:00 から 終了日時2019-01-01 11:00のアクションを検索します。

endDatetime
string <date-time>
Example: endDatetime=2018-04-01T10:30:00

終了日時

ex)

  • startDatetime=2019-01-01T09:00
  • endDatetime=2019-01-01T11:00

上記のように指定した場合、開始日時2019-01-01 09:00 から 終了日時2019-01-01 11:00のアクションを検索します。

users
Array of objects

アクション担当者、その他の担当者を検索します。

GETパラメータで指定する場合、以下の形式で指定します。

?users[]id=1&users[]id=2

pattern
integer

アクションの種別

active
boolean

true:予定 false:完了

dataType
integer

コンタクトの種類:

  • 0 - 案件アクション
  • 1 - コンタクトアクション
page
integer

ページ

Responses

200

OK

500

Internal Server Error

get /contacts/{contactId}/actions

The Open API Service by Senses

https://senses-open-api.mazrica.com/v1/contacts/{contactId}/actions

Response samples

Content type
application/json
Copy
Expand all Collapse all
{
  • "totalCount": 0,
  • "page": 0,
  • "actions":
    [
    ]
}

コンタクトアクション登録

  • アクションを新規に登録します
  • 登録後のアクションをレスポンスとして返します
  • アクションIDに該当するアクションが存在しない場合は、登録エラーとなります
  • IDがSenses上に存在しない、データに不整合がある場合などは、登録エラーとなります
Authorizations:
Request Body schema: application/json
pattern
required
object

アクションの種別。

startDatetime
required
string <date-time>

開始日時

endDatetime
required
string <date-time>

終了日時

creator
required
object

アクション担当者ID

invitees
Array of objects

他の担当者

preNote
string

アクションの事前メモ

result
string

アクションの実施結果

active
boolean

アクションの状態(true=未完了、false=完了)

Responses

201

Created

400

Bad Request

404

Not Found

500

Internal Server Error

post /contacts/{contactId}/actions

The Open API Service by Senses

https://senses-open-api.mazrica.com/v1/contacts/{contactId}/actions

Request samples

Content type
application/json
Copy
Expand all Collapse all
{
  • "pattern":
    {
    },
  • "startDatetime": "2018-04-01T10:30:00+09:00",
  • "endDatetime": "2018-04-01T10:30:00+09:00",
  • "creator":
    {
    },
  • "invitees":
    [
    ],
  • "preNote": "string",
  • "result": "string",
  • "active": true
}

Response samples

Content type
application/json
Copy
Expand all Collapse all
{
  • "id": 0,
  • "pattern":
    {
    },
  • "dataType": 0,
  • "deal":
    {
    },
  • "contact":
    {
    },
  • "startDatetime": null,
  • "createdAt": "2018-04-01T10:30:00+09:00",
  • "updatedAt": "2018-04-01T10:30:00+09:00",
  • "preNote": "string",
  • "endDatetime": null,
  • "active": true,
  • "result": "string",
  • "syncCalendar": true,
  • "creator":
    {
    },
  • "invitees":
    [
    ]
}

コンタクトアクション情報

  • アクション情報を取得
Authorizations:
path Parameters
contactId
required
integer

コンタクトID

id
required
integer

アクションID

Responses

200

OK

404

Not Found

500

Internal Server Error

get /contacts/{contactId}/actions/{id}

The Open API Service by Senses

https://senses-open-api.mazrica.com/v1/contacts/{contactId}/actions/{id}

Response samples

Content type
application/json
Copy
Expand all Collapse all
{
  • "id": 0,
  • "pattern":
    {
    },
  • "dataType": 0,
  • "deal":
    {
    },
  • "contact":
    {
    },
  • "startDatetime": null,
  • "createdAt": "2018-04-01T10:30:00+09:00",
  • "updatedAt": "2018-04-01T10:30:00+09:00",
  • "preNote": "string",
  • "endDatetime": null,
  • "active": true,
  • "result": "string",
  • "syncCalendar": true,
  • "creator":
    {
    },
  • "invitees":
    [
    ]
}

コンタクトアクション情報更新

  • アクション情報を更新
Authorizations:
path Parameters
contactId
required
integer

コンタクトID

id
required
integer

アクションID

Request Body schema: application/json
pattern
object

アクションの種別。

startDatetime
string <date-time>

開始日時

endDatetime
string <date-time>

終了日時

invitees
Array of objects

他の担当者

invitees指定なし->何もしない

invitees:[]->全削除

invitees:[何か指定]->指定された通りに追加更新削除

preNote
string

アクションの事前メモ

result
string

アクションの実施結果

active
boolean

アクションの状態(true=未完了、false=完了)

Responses

200

OK

400

Bad Request

500

Internal Server Error

patch /contacts/{contactId}/actions/{id}

The Open API Service by Senses

https://senses-open-api.mazrica.com/v1/contacts/{contactId}/actions/{id}

Request samples

Content type
application/json
Copy
Expand all Collapse all
{
  • "pattern":
    {
    },
  • "startDatetime": "2018-04-01T10:30:00+09:00",
  • "endDatetime": "2018-04-01T10:30:00+09:00",
  • "invitees":
    [
    ],
  • "preNote": "string",
  • "result": "string",
  • "active": true
}

Response samples

Content type
application/json
Copy
Expand all Collapse all
{
  • "id": 0,
  • "pattern":
    {
    },
  • "dataType": 0,
  • "deal":
    {
    },
  • "contact":
    {
    },
  • "startDatetime": null,
  • "createdAt": "2018-04-01T10:30:00+09:00",
  • "updatedAt": "2018-04-01T10:30:00+09:00",
  • "preNote": "string",
  • "endDatetime": null,
  • "active": true,
  • "result": "string",
  • "syncCalendar": true,
  • "creator":
    {
    },
  • "invitees":
    [
    ]
}

コンタクトアクション情報削除

  • アクション情報を削除
Authorizations:
path Parameters
contactId
required
integer

コンタクトID

id
required
integer

アクションID

Responses

200

OK

404

Not Found

500

Internal Server Error

delete /contacts/{contactId}/actions/{id}

The Open API Service by Senses

https://senses-open-api.mazrica.com/v1/contacts/{contactId}/actions/{id}