> ## Documentation Index
> Fetch the complete documentation index at: https://help.dingtalk.io/llms.txt
> Use this file to discover all available pages before exploring further.

# 勤怠グループ詳細の取得

> 勤怠グループ ID を指定し、グループ名・主管理者・勤怠タイプなど単一グループの詳細を取得する API です。

勤怠グループ ID を指定してこの API を呼び出し、勤怠グループの詳細を取得します。取得できる情報には、勤怠グループ名、勤怠グループの主管理者、勤怠タイプなどがあります。

## リクエスト

| **基本情報** | |
| - | - |
| HTTP URL | [https://api.dingtalk.io/topapi/attendance/group/query](https://api.dingtalk.io/topapi/attendance/group/query) |
| HTTP メソッド | POST |
| 対応するアプリタイプ | appType-社内アプリ　appType-サードパーティ社内アプリ |
| 必要な権限 | permission-qyapi\_attendance\_group\_read-勤怠グループの照会権限 |

### クエリパラメータ

| 名前 | タイプ | 必須 | 例 | 説明 |
| - | - | - | - | - |
| access\_token | String | はい | bE74xxxx | この API の呼び出しに使用するアプリ認証情報です。   - 社内アプリの場合は、[社内アプリの access\_token を取得](https://help.dingtalk.io/ja/open/development/obtain-orgapp-token) API を呼び出して取得します。 - サードパーティ社内アプリの場合は、サードパーティ社内アプリの access\_token を取得 API を呼び出して取得します。 |

### リクエストボディ

| 名前 | タイプ | 必須 | 例 | 説明 |
| - | - | - | - | - |
| op\_user\_id | String | はい | user123 | 操作者の userId です。 |
| group\_id | Number | はい | 685935028 | 勤怠グループ ID です。[勤怠グループの詳細を一括取得](https://help.dingtalk.io/ja/open/development/batch-obtain-attendance-group-details.md) API を呼び出して group\_id の値を取得します。  **注意**  旧形式の勤怠グループ識別子（group\_key）を使用している場合は、[groupKey から groupId への変換](https://help.dingtalk.io/ja/open/development/convert-groupkey-to-groupid.md) API を呼び出して、group\_key を group\_id に変換してください。 |

### リクエスト例

```curl theme={"theme":{"light":"github-light","dark":"github-dark"}}
curl -X POST "https://api.dingtalk.io/topapi/attendance/group/query" \
-H 'Content-Type:application/x-www-form-urlencoded;charset=utf-8' \
-d 'access_token=65671xxxx92ddf0' \
-d 'group_id=23456' \
-d 'op_user_id=dd_dd'
```

Java

```java theme={"theme":{"light":"github-light","dark":"github-dark"}}
DingTalkClient client = new DefaultDingTalkClient("https://api.dingtalk.io/topapi/attendance/group/query");
OapiAttendanceGroupQueryRequest req = new OapiAttendanceGroupQueryRequest();
req.setOpUserId("dd_dd");
req.setGroupId(23456L);
OapiAttendanceGroupQueryResponse rsp = client.execute(req, access_token);
System.out.println(rsp.getBody());
```

Python

```python theme={"theme":{"light":"github-light","dark":"github-dark"}}
import dingtalk.api

req=dingtalk.api.OapiAttendanceGroupQueryRequest("https://api.dingtalk.io/topapi/attendance/group/query")

req.op_user_id="dd_dd"
req.group_id=23456
try:
  resp= req.getResponse(access_token)
  print(resp)
except Exception,e:
  print(e)
```

PHP

```php theme={"theme":{"light":"github-light","dark":"github-dark"}}
include "TopSdk.php";
date_default_timezone_set('Asia/Shanghai');

$c = new DingTalkClient(DingTalkConstant::$CALL_TYPE_OAPI, DingTalkConstant::$METHOD_POST , DingTalkConstant::$FORMAT_JSON);
$req = new OapiAttendanceGroupQueryRequest;
$req->setOpUserId("dd_dd");
$req->setGroupId("23456");
$resp = $c->execute($req, $access_token, "https://api.dingtalk.io/topapi/attendance/group/query");
```

C#

```csharp theme={"theme":{"light":"github-light","dark":"github-dark"}}
IDingTalkClient client = new DefaultDingTalkClient("https://api.dingtalk.io/topapi/attendance/group/query");
OapiAttendanceGroupQueryRequest req = new OapiAttendanceGroupQueryRequest();
req.OpUserId = "dd_dd";
req.GroupId = 23456L;
OapiAttendanceGroupQueryResponse rsp = client.Execute(req, access_token);
Console.WriteLine(rsp.Body);
```

## レスポンス

### レスポンスボディ

| 名前 | タイプ | 例 | 説明 |
| - | - | - | - |
| result | TopSimpleGroupVO | | 返却結果です。 |
| name | String | 勤怠 | 勤怠グループ名です。 |
| shift\_ids | Number\[] | \[677995086] | シフト ID です。 |
| id | Number | 685935028 | 勤怠グループ ID です。 |
| wifis | String\[] | \["test-inc"] | Wi-Fi 名です。 |
| address\_list | String\[] | \["西渓湿地"] | 勤怠打刻場所の住所です。 |
| work\_day\_list | Number\[] | \[0,1,2,3] | 勤務日です。 |
| member\_count | Number | 39 | ユーザー数です。 |
| type | String | TURN | 勤怠グループのタイプです。   - **FIXED：** 固定シフト制の勤怠グループ - **TURN：** シフト制の勤怠グループ - **NONE：** フレックスタイムの勤怠グループ |
| url | String | [https://attend.dingtalk.io/xxxx](https://attend.dingtalk.io/xxxx) | リダイレクト先のリンクです。 |
| manager\_list | String | user456 | 勤怠グループの管理者です。 |
| owner\_user\_id | String | user01 | 勤怠グループの主管理者の userId です。 |
| success | Boolean | true | リクエストが成功したかどうかを示します。   - **true**：成功 - **false**：失敗 |
| errcode | Number | 0 | リターンコードです。 |
| request\_id | String | 72hycvnsyykp | リクエスト ID です。 |

### レスポンスボディ例

```json theme={"theme":{"light":"github-light","dark":"github-dark"}}
{
  "errcode": 0,
  "result": {
    "address_list": [
      "西渓湿地"
    ],
    "id": 685935028,
    "manager_list": "[user456]",
    "member_count": 1,
    "name": "勤怠",
    "owner_user_id": "user01",
    "shift_ids": [
      677995086
    ],
    "type": "TURN",
    "url": "https://attend.dingtalk.io/xxxx",
    "wifis": [
      "test-inc"
    ],
    "work_day_list": [
      0,
      677995086,
      677995086,
      677995086,
      677995086,
      678215070,
      0
    ]
  },
  "success": true,
  "request_id": "lps4czm0g3qu"
}
```

### エラーコード

この API の呼び出しでエラーが返された場合は、エラーメッセージをもとに[グローバルエラーコード](https://help.dingtalk.io/ja/open/development/server-api-error-codes-1.md)ドキュメントで解決方法を確認してください。


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.