# API Docs

## Docs
- [SmartPOST Message API 概要](https://api-docs.smartpost.jp/sp-message/introduction.md): 
- [SmartPOST Management API 概要](https://api-docs.smartpost.jp/sp-management/introduction.md): 
- [用語定義](https://api-docs.smartpost.jp/833902m0.md): 

## API Docs
- [listAccountSubscriptions](https://api-docs.smartpost.jp/sp-message/list-account-subscriptions.md): 利用者が登録されているアカウントに関する情報を取得できます。
- [healthcheck](https://api-docs.smartpost.jp/sp-message/healthcheck.md): Message APIの稼働状況を確認できます。
- [listMessages](https://api-docs.smartpost.jp/sp-message/list-message.md): このエンドポイントを使用することで、xIDアプリユーザーがSmartPOSTに受信したメッセージの一覧を取得することができます。
- [getMessage](https://api-docs.smartpost.jp/sp-message/get-message.md): listMessageで取得した`message_id`を使用して本エンドポイントにリクエストを送ることで、当該メッセージの本文（`message`）をHTML形式で取得することができます。
- [getImageUrls](https://api-docs.smartpost.jp/sp-message/get-image-urls.md): ListMessageで取得した`message_id`を使用して本エンドポイントにリクエストを送ることで、当該メッセージに含まれる画像のID、および、URLを取得することができます。
- [updateMessageStatusToRead](https://api-docs.smartpost.jp/sp-message/update-message-status.md): getMessageのリクエストの際に`change-read-status: false`でレスポンスを取得する場合、クライアントサービスにおいてユーザーがメッセージを開くタイミングで本APIのリクエストをお願いします。対象のメッセージのmessage_idを使用してリクエストすると、SmartPOSTサービス上における当メッセージの既読時刻（`api_read_at`）が入力されます。
- project [listProjects](https://api-docs.smartpost.jp/sp-management/list-projects.md): このエンドポイントを使用することで、プロジェクト（テンプレート、Welcome プロジェクト）の一覧を取得できます。
- project [getProject](https://api-docs.smartpost.jp/sp-management/get-project.md): listProjectsで取得したプロジェクトのIDを使用して本エンドポイントにリクエストを送ることで、プロジェクト（Welcomeプロジェクト、テンプレートも含む）の詳細情報を取得できます。
- project [listImageUrls](https://api-docs.smartpost.jp/sp-management/get-image-urls.md): listProjectsで取得したプロジェクトのIDを使用して本エンドポイントにリクエストを送ることで、プロジェクトのメッセージに挿入された画像のID、および、署名付きURLを取得できます。
- project [listProjectRecipients](https://api-docs.smartpost.jp/sp-management/list-project-recipients.md): listProjectsで取得したプロジェクトのIDを使用して本エンドポイントにリクエストを送ることで、プロジェクトの受信者情報を取得できます。受信者情報にはカスタム変数の値も含まれます。
- project [listProjectVariables](https://api-docs.smartpost.jp/sp-management/list-project-variables.md): listProjectsで取得したプロジェクトのIDを使用して本エンドポイントにリクエストを送ることで、プロジェクトのカスタム変数に関する情報を取得できます。カスタム変数の値は受信者に紐づくため、このエンドポイントのレスポンスには含まれません。カスタム変数の値は[listProjectRecipients](sp-management/list-project-variables)を利用して取得します。
- admin [listAdmins](https://api-docs.smartpost.jp/sp-management/list-admins.md): このエンドポイントを使用することで、管理者の一覧を取得できます。
- admin [getAdmin](https://api-docs.smartpost.jp/sp-management/get-admin.md): listAdminsで取得した管理者のIDを使用して本エンドポイントにリクエストを送ることで、管理者の詳細情報を取得できます。
- custom policy [listCustomPolicies](https://api-docs.smartpost.jp/sp-management/list-custom-policies.md): このエンドポイントを使用することで、カスタムポリシーの一覧を取得できます。
- custom policy [getCustomPolicy](https://api-docs.smartpost.jp/sp-management/get-custom-policy.md): listCustomPoliciesで取得したカスタムポリシーのIDを使用して本エンドポイントにリクエストを送ることで、カスタムポリシーの詳細情報を取得できます。
- custom role [listCustomRoles](https://api-docs.smartpost.jp/sp-management/list-custom-roles.md): このエンドポイントを使用することで、カスタムロールの一覧を取得できます。
- custom role [getCustomRole](https://api-docs.smartpost.jp/sp-management/get-custom-role.md): listCustomRolesで取得したカスタムロールのIDを使用して本エンドポイントにリクエストを送ることで、カスタムロールの詳細情報を取得できます。
- group [listGroups](https://api-docs.smartpost.jp/sp-management/list-groups.md): このエンドポイントを使用することで、グループの一覧を取得できます。
- group [getGroup](https://api-docs.smartpost.jp/sp-management/get-group.md): listGroupsで取得したグループのIDを使用して本エンドポイントにリクエストを送ることで、グループの詳細情報を取得できます。
- health [healthCheck](https://api-docs.smartpost.jp/13469056e0.md): Management APIの稼働状況を確認できます。