logo
API docs by Redocly

Playbook API (1.3.0)

Download OpenAPI specification:Download

Authentication

本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 アクセス権を保護する重要な情報です。

第三者に漏れないよう、常に安全に管理してください。

Rate Limit

本APIは、利用の公平性を保ち、サービスの品質を維持するためにレート制限を設けています。

各利用者は、60秒間に最大10回までのAPIリクエストを送信できます。

制限を超えた場合

レート制限を超えた場合、APIはリクエストを拒否し、状態コード 429 Too Many Requests を返します。

このレスポンスには、リトライするまでの待機時間が含まれる場合がありますので、リクエストを再送信する前には応答を確認してください。

Company

List Companies

取引先一覧を取得

Authorizations:
(KeySecret)
query Parameters
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

Responses

Response samples

Content type
application/json
{
  • "companies": [
    ],
  • "pagination": {
    }
}

Create Company

取引先を作成

Authorizations:
(KeySecret)
Request Body schema: application/json
name
required
string <= 255 characters
phone
string <= 45 characters
website
string <= 2048 characters
industry
string <= 45 characters
corporateNumber
string <= 45 characters

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "phone": "string",
  • "website": "string",
  • "industry": "string",
  • "corporateNumber": "string"
}

Response samples

Content type
application/json
{
  • "company": {
    }
}

Get Company

指定した取引先を取得

Authorizations:
(KeySecret)
path Parameters
companyId
required
string <uuid> (Uuid)
Example: 123e4567-e89b-12d3-a456-426614174000

companyId

Responses

Response samples

Content type
application/json
{
  • "company": {
    }
}

Update Company

指定した取引先を更新

Authorizations:
(KeySecret)
path Parameters
companyId
required
string <uuid> (Uuid)
Example: 123e4567-e89b-12d3-a456-426614174000

companyId

Request Body schema: application/json
name
string <= 255 characters
phone
string <= 45 characters
website
string <= 2048 characters
industry
string <= 45 characters
corporateNumber
string <= 45 characters

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "phone": "string",
  • "website": "string",
  • "industry": "string",
  • "corporateNumber": "string"
}

Response samples

Content type
application/json
{
  • "company": {
    }
}

User

List Users

ユーザ一覧を取得

Authorizations:
(KeySecret)
query Parameters
cursor
string

cursor

limit
integer [ 1 .. 100 ]
Default: 10

limit

Responses

Response samples

Content type
application/json
{
  • "users": [
    ],
  • "pagination": {
    }
}

Get User

指定したユーザを取得

Authorizations:
(KeySecret)
path Parameters
userId
required
string <uuid> (Uuid)
Example: 123e4567-e89b-12d3-a456-426614174000

userId

Responses

Response samples

Content type
application/json
{
  • "user": {
    }
}

Unit

List Units

ユニット一覧を取得

Authorizations:
(KeySecret)
query Parameters
cursor
string

cursor

limit
integer [ 1 .. 100 ]
Default: 10

limit

Responses

Response samples

Content type
application/json
{
  • "units": [
    ],
  • "pagination": {
    }
}

Get Unit

指定したユニットを取得

Authorizations:
(KeySecret)
path Parameters
unitId
required
string <uuid> (Uuid)
Example: 123e4567-e89b-12d3-a456-426614174000

unitId

Responses

Response samples

Content type
application/json
{
  • "unit": {
    }
}

List Unit Playbooks

ユニットのプレイブック一覧を取得

Authorizations:
(KeySecret)
path Parameters
unitId
required
string <uuid> (Uuid)
Example: 123e4567-e89b-12d3-a456-426614174000

unitId

query Parameters
cursor
string

cursor

limit
integer [ 1 .. 100 ]
Default: 10

limit

phase
string (PlaybookValue)
Enum: "Nurturing" "Qualification" "Closing" "Onboarding" "Adoption" "Expansion" "Recycling" "Event"

phase

isUnitDefault
boolean

ユニットがデフォルトで設定しているプレイブックを取得します。

Responses

Response samples

Content type
application/json
{
  • "playbooks": [
    ],
  • "pagination": {
    }
}

Engagement

List Engagements

エンゲージメント一覧を取得

Authorizations:
(KeySecret)
query Parameters
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

ownerName
string

string

ownerUnitId
string <uuid> (Uuid)
Example: ownerUnitId=123e4567-e89b-12d3-a456-426614174000

ownerUnitId

ownerUnitName
string

ownerUnitName

statuses
Array of strings (EngagementStatus)
Items Enum: "Active" "Recycle" "End"

array of statuses

複数の値をカンマ区切りで指定することができます。（例： statuses=Active,Recycle）

phases
Array of strings (EngagementPlaybookPhaseValue)
Items Enum: "Nurturing" "Qualification" "Closing" "Onboarding" "Adoption" "Expansion" "Recycling" "Event"

array of phases

複数の値をカンマ区切りで指定することができます。（例： phases=Nurturing,Closing）

orderBy
string^(createdAt|lastActionedAt)(:(asc|desc))?$
Example: orderBy=lastActionedAt:desc

ソート対象のキーを指定します。

{key}:{order} のフォーマットで指定してください。

サポートしているkeyは以下です。

  • createdAt: 作成日時（デフォルト）
  • lastActionedAt: 最終活動日

サポートしているorderは以下です。

  • asc: 昇順
  • desc: 降順

:{order} を省略した場合は、昇順になります。

null 値のフィールドのレコードは、昇順で末尾・降順で先頭で取得できます。

Responses

Response samples

Content type
application/json
{
  • "engagements": [
    ],
  • "pagination": {
    }
}

Get Engagement

指定したエンゲージメントを取得

Authorizations:
(KeySecret)
path Parameters
engagementId
required
string <uuid> (Uuid)
Example: 123e4567-e89b-12d3-a456-426614174000

engagementId

Responses

Response samples

Content type
application/json
{
  • "engagement": {
    }
}

Sequence

List Sequences

シーケンス一覧を取得

Authorizations:
(KeySecret)
path Parameters
unitId
required
string <uuid> (Uuid)
Example: 123e4567-e89b-12d3-a456-426614174000

unitId

query Parameters
triggerType
string (SequenceTriggerType)
Enum: "Auto" "Manual"

シーケンスをスタートするトリガーのタイプ

cursor
string

cursor

limit
integer [ 1 .. 100 ]
Default: 10

limit

Responses

Response samples

Content type
application/json
{
  • "sequences": [
    ],
  • "pagination": {
    }
}

Run Sequence

指定したシーケンスを実行

Authorizations:
(KeySecret)
path Parameters
unitId
required
string <uuid> (Uuid)
Example: 123e4567-e89b-12d3-a456-426614174000

unitId

sequenceId
required
string <uuid> (Uuid)
Example: 123e4567-e89b-12d3-a456-426614174000

sequenceId

Request Body schema: application/json
engagementId
required
string <uuid> (Uuid)

Responses

Request samples

Content type
application/json
{
  • "engagementId": "123e4567-e89b-12d3-a456-426614174000"
}

Response samples

Content type
application/json
{
  • "statusCode": 0,
  • "message": "string",
  • "errors": [
    ]
}

Task

List Tasks

タスク一覧を取得

Authorizations:
(KeySecret)
path Parameters
engagementId
required
string <uuid> (Uuid)
Example: 123e4567-e89b-12d3-a456-426614174000

engagementId

query Parameters
cursor
string

cursor

limit
integer [ 1 .. 100 ]
Default: 10

limit

Responses

Response samples

Content type
application/json
{
  • "tasks": [
    ],
  • "pagination": {
    }
}

Create Task

タスクを作成

Authorizations:
(KeySecret)
path Parameters
engagementId
required
string <uuid> (Uuid)
Example: 123e4567-e89b-12d3-a456-426614174000

engagementId

Request Body schema: application/json
dueDate
required
string <date-time>
ownerId
required
string <uuid> (Uuid)
type
required
string (TaskType)
Enum: "Appointment" "Todo"
name
required
string <= 255 characters
createdBy
string <uuid> (Uuid)

Responses

Request samples

Content type
application/json
{
  • "dueDate": "2019-08-24T14:15:22Z",
  • "ownerId": "123e4567-e89b-12d3-a456-426614174000",
  • "type": "Appointment",
  • "name": "string",
  • "createdBy": "123e4567-e89b-12d3-a456-426614174000"
}

Response samples

Content type
application/json
{
  • "task": {
    }
}

Get Task

指定したタスクを取得

Authorizations:
(KeySecret)
path Parameters
engagementId
required
string <uuid> (Uuid)
Example: 123e4567-e89b-12d3-a456-426614174000

engagementId

taskId
required
string <uuid> (Uuid)
Example: 123e4567-e89b-12d3-a456-426614174000

taskId

Responses

Response samples

Content type
application/json
{
  • "task": {
    }
}

Done Task

指定したタスクを完了

Authorizations:
(KeySecret)
path Parameters
engagementId
required
string <uuid> (Uuid)
Example: 123e4567-e89b-12d3-a456-426614174000

engagementId

taskId
required
string <uuid> (Uuid)
Example: 123e4567-e89b-12d3-a456-426614174000

taskId

Responses

Response samples

Content type
application/json
{
  • "task": {
    }
}

Playbook

List Playbooks

プレイブック一覧を取得

Authorizations:
(KeySecret)
query Parameters
cursor
string

cursor

limit
integer [ 1 .. 100 ]
Default: 10

limit

unitId
string <uuid> (Uuid)
Example: unitId=123e4567-e89b-12d3-a456-426614174000

unitId

Responses

Response samples

Content type
application/json
{
  • "playbooks": [
    ],
  • "pagination": {
    }
}

Get Playbook

指定したプレイブックを取得

Authorizations:
(KeySecret)
path Parameters
playbookId
required
string <uuid> (Uuid)
Example: 123e4567-e89b-12d3-a456-426614174000

playbookId

Responses

Response samples

Content type
application/json
{
  • "playbook": {
    }
}

Update Playbook Engagement

指定したプレイブックのエンゲージメントを更新

Authorizations:
(KeySecret)
path Parameters
playbookId
required
string <uuid> (Uuid)
Example: 123e4567-e89b-12d3-a456-426614174000

playbookId

engagementId
required
string <uuid> (Uuid)
Example: 123e4567-e89b-12d3-a456-426614174000

engagementId

Request Body schema: application/json
userId
string <uuid> (Uuid)
object
nextOwnerUnitId
string <uuid> (Uuid)
nextOwnerId
string <uuid> (Uuid)

Responses

Request samples

Content type
application/json
{
  • "userId": "123e4567-e89b-12d3-a456-426614174000",
  • "values": {
    },
  • "nextOwnerUnitId": "123e4567-e89b-12d3-a456-426614174000",
  • "nextOwnerId": "123e4567-e89b-12d3-a456-426614174000"
}

Response samples

Content type
application/json
{
  • "statusCode": 0,
  • "message": "string",
  • "errors": [
    ]
}

Memo

Create Engagement Memo

指定したエンゲージメントにメモを作成

Authorizations:
(KeySecret)
path Parameters
engagementId
required
string <uuid> (Uuid)
Example: 123e4567-e89b-12d3-a456-426614174000

engagementId

Request Body schema: application/json
body
required
string <= 65535 characters
ownerId
required
string <uuid> (Uuid)

Responses

Request samples

Content type
application/json
{
  • "body": "string",
  • "ownerId": "123e4567-e89b-12d3-a456-426614174000"
}

Response samples

Content type
application/json
{
  • "memo": {
    }
}