ユーザーIDを指定して在席情報を取得します。

クラウド版

https://sample.cybozu.com/g/api/v1/presence/users/USER_ID

パッケージ版

環境に合わせてそれぞれ以下を置き換えてください。

• IP_ADDRESS_OR_HOST_NAME：Garoonのインストール先のIPアドレスまたはホスト名
• INSTALL_IDENTIFER：Garoonのインストール識別子

Windows環境

http://IP_ADDRESS_OR_HOST_NAME/scripts/INSTALL_IDENTIFER/grn.exe/api/v1/presence/users/USER_ID

Linux環境

http://IP_ADDRESS_OR_HOST_NAME/cgi-bin/INSTALL_IDENTIFER/grn.cgi/api/v1/presence/users/USER_ID

パスパラメーター

GET

• クラウド版Garoon
• パッケージ版Garoon 5.0以降

なし

パラメーター

なし

リクエストの例

URL

https://sample.cybozu.com/g/api/v1/presence/users/1

ヘッダー

1
2
3

{
  "X-Cybozu-Authorization": "QWRtaW5pc3RyYXRvcjpjeWJvenU="
}

リクエストヘッダーの詳細は Garoon REST APIの共通仕様を参照してください。

プロパティ

プロパティ名	型	説明
user.id	数値	ユーザーID
user.code	文字列	ユーザーのログイン名 パッケージ版Garoonの場合、ログイン名を公開する設定が必要です。 詳細は ユーザー情報の項目を変更する を参照してください。
user.name	文字列	ユーザーの表示名
updatedAt	文字列	在席情報の更新日時 形式はISO8601のUTCタイムゾーンです。
notes	文字列	メモ 改行文字は「\n」です。
status	オブジェクト	在席情報のステータス
status.name	文字列	在席情報のステータス名 status.codeごとに内容が異なります。 また、値の言語はAPIを実行するユーザーの言語設定に応じます。次に示すのは、日本語に設定した場合の値です。 「attend」の場合：「在席」 「absence」の場合：「不在」 管理者またはアプリケーション管理者が追加したステータス：追加したステータス 空の文字列の場合：「登録がありません」
status.code	文字列	在席情報のステータスコード attend absence 管理者またはアプリケーション管理者が追加したステータス 空の文字列

レスポンスの例

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13

{
  "user": {
    "id": "1",
    "code": "c000001",
    "name": "Noboru Satoh(Satoh Noboru); Sales Department"
  },
  "updatedAt": "2022-09-29T06:25:18Z",
  "notes": "This is presence note.",
  "status": {
    "name": "At desk",
    "code": "attend"
  }
}

curlを使ったリクエスト

1
2

curl -X GET 'https://sample.cybozu.com/g/api/v1/presence/users/1' \
-H 'X-Cybozu-Authorization: QWRtaW5pc3RyYXRvcjpjeWJvenU=' 

Garoon REST APIリクエストを送信するAPIを使ったリクエスト

1

await garoon.api('/api/v1/presence/users/1', 'GET', {});