本APIの利用には、認証が必要です。
認証を行うには、リクエストヘッダーに X-API-Key と X-API-Secret を含める必要があります。
これらの値は、APIの使用登録を完了した際に提供されます。正しい認証情報が提供されない場合、APIはアクセスを拒否し、エラーメッセージを返します。
リクエストヘッダー例
リクエストを送信する際には、以下の形式で認証ヘッダーを追加してください:
X-API-Key: <your-api-key>
X-API-Secret: <your-api-secret>
安全な使用について
X-API-Key と X-API-Secret は、あなたの API アクセス権を保護する重要な情報です。
第三者に漏れないよう、常に安全に管理してください。
レート制限を超えた場合、APIはリクエストを拒否し、状態コード 429 Too Many Requests
を返します。
このレスポンスには、リトライするまでの待機時間が含まれる場合がありますので、リクエストを再送信する前には応答を確認してください。
取引先一覧を取得
cursor | string cursor |
limit | integer [ 1 .. 100 ] Default: 10 limit |
name | string <= 255 characters name |
phone | string <= 45 characters phone |
website | string <= 255 characters website |
industry | string <= 45 characters industry |
{- "companies": [
- {
- "id": "123e4567-e89b-12d3-a456-426614174000",
- "name": "string",
- "phone": "string",
- "website": "string",
- "industry": "string",
- "corporateNumber": "string",
- "createdAt": "2019-08-24T14:15:22Z",
- "updatedAt": "2019-08-24T14:15:22Z"
}
], - "pagination": {
- "currentCursor": "string",
- "nextCursor": "string",
- "limit": 0,
- "count": 0
}
}
取引先を作成
name required | string <= 255 characters |
phone | string <= 45 characters |
website | string <= 2048 characters |
industry | string <= 45 characters |
corporateNumber | string <= 45 characters |
{- "name": "string",
- "phone": "string",
- "website": "string",
- "industry": "string",
- "corporateNumber": "string"
}
{- "company": {
- "id": "123e4567-e89b-12d3-a456-426614174000",
- "name": "string",
- "phone": "string",
- "website": "string",
- "industry": "string",
- "corporateNumber": "string",
- "createdAt": "2019-08-24T14:15:22Z",
- "updatedAt": "2019-08-24T14:15:22Z"
}
}
指定した取引先を取得
companyId required | string <uuid> (Uuid) Example: 123e4567-e89b-12d3-a456-426614174000 companyId |
{- "company": {
- "id": "123e4567-e89b-12d3-a456-426614174000",
- "name": "string",
- "phone": "string",
- "website": "string",
- "industry": "string",
- "corporateNumber": "string",
- "createdAt": "2019-08-24T14:15:22Z",
- "updatedAt": "2019-08-24T14:15:22Z"
}
}
指定した取引先を更新
companyId required | string <uuid> (Uuid) Example: 123e4567-e89b-12d3-a456-426614174000 companyId |
name | string <= 255 characters |
phone | string <= 45 characters |
website | string <= 2048 characters |
industry | string <= 45 characters |
corporateNumber | string <= 45 characters |
{- "name": "string",
- "phone": "string",
- "website": "string",
- "industry": "string",
- "corporateNumber": "string"
}
{- "company": {
- "id": "123e4567-e89b-12d3-a456-426614174000",
- "name": "string",
- "phone": "string",
- "website": "string",
- "industry": "string",
- "corporateNumber": "string",
- "createdAt": "2019-08-24T14:15:22Z",
- "updatedAt": "2019-08-24T14:15:22Z"
}
}
ユーザ一覧を取得
cursor | string cursor |
limit | integer [ 1 .. 100 ] Default: 10 limit |
{- "users": [
- {
- "id": "123e4567-e89b-12d3-a456-426614174000",
- "firstName": "string",
- "lastName": "string",
- "createdAt": "2019-08-24T14:15:22Z",
- "updatedAt": "2019-08-24T14:15:22Z"
}
], - "pagination": {
- "currentCursor": "string",
- "nextCursor": "string",
- "limit": 0,
- "count": 0
}
}
指定したユーザを取得
userId required | string <uuid> (Uuid) Example: 123e4567-e89b-12d3-a456-426614174000 userId |
{- "user": {
- "id": "123e4567-e89b-12d3-a456-426614174000",
- "firstName": "string",
- "lastName": "string",
- "createdAt": "2019-08-24T14:15:22Z",
- "updatedAt": "2019-08-24T14:15:22Z"
}
}
ユニット一覧を取得
cursor | string cursor |
limit | integer [ 1 .. 100 ] Default: 10 limit |
{- "units": [
- {
- "id": "123e4567-e89b-12d3-a456-426614174000",
- "name": "string",
- "phases": [
- "Nurturing"
], - "createdAt": "2019-08-24T14:15:22Z",
- "updatedAt": "2019-08-24T14:15:22Z"
}
], - "pagination": {
- "currentCursor": "string",
- "nextCursor": "string",
- "limit": 0,
- "count": 0
}
}
指定したユニットを取得
unitId required | string <uuid> (Uuid) Example: 123e4567-e89b-12d3-a456-426614174000 unitId |
{- "unit": {
- "id": "123e4567-e89b-12d3-a456-426614174000",
- "name": "string",
- "phases": [
- "Nurturing"
], - "createdAt": "2019-08-24T14:15:22Z",
- "updatedAt": "2019-08-24T14:15:22Z"
}
}
エンゲージメント一覧を取得
cursor | string cursor |
limit | integer [ 1 .. 100 ] Default: 10 limit |
name | string name |
ownerId | string <uuid> (Uuid) Example: ownerId=123e4567-e89b-12d3-a456-426614174000 ownerId |
ownerUnitId | string <uuid> (Uuid) Example: ownerUnitId=123e4567-e89b-12d3-a456-426614174000 ownerUnitId |
{- "engagements": [
- {
- "id": "123e4567-e89b-12d3-a456-426614174000",
- "companyId": "123e4567-e89b-12d3-a456-426614174000",
- "name": "string",
- "ownerId": "123e4567-e89b-12d3-a456-426614174000",
- "isEscalated": true,
- "phase": "Nurturing",
- "ownerUnitId": "123e4567-e89b-12d3-a456-426614174000",
- "createdBy": "123e4567-e89b-12d3-a456-426614174000",
- "status": "Active",
- "createdAt": "2019-08-24T14:15:22Z",
- "updatedAt": "2019-08-24T14:15:22Z"
}
], - "pagination": {
- "currentCursor": "string",
- "nextCursor": "string",
- "limit": 0,
- "count": 0
}
}
指定したエンゲージメントを取得
engagementId required | string <uuid> (Uuid) Example: 123e4567-e89b-12d3-a456-426614174000 engagementId |
{- "engagement": {
- "id": "123e4567-e89b-12d3-a456-426614174000",
- "companyId": "123e4567-e89b-12d3-a456-426614174000",
- "name": "string",
- "ownerId": "123e4567-e89b-12d3-a456-426614174000",
- "isEscalated": true,
- "phase": "Nurturing",
- "ownerUnitId": "123e4567-e89b-12d3-a456-426614174000",
- "createdBy": "123e4567-e89b-12d3-a456-426614174000",
- "status": "Active",
- "createdAt": "2019-08-24T14:15:22Z",
- "updatedAt": "2019-08-24T14:15:22Z"
}
}
プレイブック一覧を取得
cursor | string cursor |
limit | integer [ 1 .. 100 ] Default: 10 limit |
unitId | string <uuid> (Uuid) Example: unitId=123e4567-e89b-12d3-a456-426614174000 unitId |
{- "playbooks": [
- {
- "id": "123e4567-e89b-12d3-a456-426614174000",
- "phase": "Nurturing",
- "playbookName": "string",
- "status": "Draft",
- "createdAt": "2019-08-24T14:15:22Z",
- "updatedAt": "2019-08-24T14:15:22Z"
}
], - "pagination": {
- "currentCursor": "string",
- "nextCursor": "string",
- "limit": 0,
- "count": 0
}
}
指定したプレイブックを取得
playbookId required | string <uuid> (Uuid) Example: 123e4567-e89b-12d3-a456-426614174000 playbookId |
{- "playbook": {
- "id": "123e4567-e89b-12d3-a456-426614174000",
- "phase": "Nurturing",
- "playbookName": "string",
- "status": "Draft",
- "achievements": [
- {
- "name": "string",
- "consensuses": [
- {
- "name": "string",
- "items": [
- {
- "id": "123e4567-e89b-12d3-a456-426614174000",
- "name": "string",
- "isRequired": true,
- "forms": [
- {
- "id": null,
- "formType": null,
- "options": [ ],
- "createdAt": null,
- "updatedAt": null
}
], - "createdAt": "2019-08-24T14:15:22Z",
- "updatedAt": "2019-08-24T14:15:22Z"
}
]
}
]
}
], - "createdAt": "2019-08-24T14:15:22Z",
- "updatedAt": "2019-08-24T14:15:22Z"
}
}
指定したプレイブックのエンゲージメントを更新
playbookId required | string <uuid> (Uuid) Example: 123e4567-e89b-12d3-a456-426614174000 playbookId |
engagementId required | string <uuid> (Uuid) Example: 123e4567-e89b-12d3-a456-426614174000 engagementId |
userId | string <uuid> (Uuid) |
object | |
nextOwnerUnitId | string <uuid> (Uuid) |
nextOwnerId | string <uuid> (Uuid) |
{- "userId": "123e4567-e89b-12d3-a456-426614174000",
- "values": {
- "property1": {
- "formType": "Text",
- "values": [
- "string"
]
}, - "property2": {
- "formType": "Text",
- "values": [
- "string"
]
}
}, - "nextOwnerUnitId": "123e4567-e89b-12d3-a456-426614174000",
- "nextOwnerId": "123e4567-e89b-12d3-a456-426614174000"
}
{- "statusCode": 0,
- "message": "string",
- "errors": [
- {
- "field": "string",
- "message": "string"
}
]
}
指定したエンゲージメントにメモを作成
engagementId required | string <uuid> (Uuid) Example: 123e4567-e89b-12d3-a456-426614174000 engagementId |
body required | string <= 65535 characters |
ownerId required | string <uuid> (Uuid) |
{- "body": "string",
- "ownerId": "123e4567-e89b-12d3-a456-426614174000"
}
{- "memo": {
- "id": "123e4567-e89b-12d3-a456-426614174000",
- "body": "string",
- "ownerId": "123e4567-e89b-12d3-a456-426614174000",
- "createdAt": "2019-08-24T14:15:22Z",
- "updatedAt": "2019-08-24T14:15:22Z"
}
}