---
url: /en/develops/openapi.md
---
## API Service Address

The API Service and Document address is `https://api.cnb.build`.

## API Documentation

API documentation address: [\_\_ENV\_\_API\_LINK](https://api.cnb.build).

## Calling Methods

### Header Information

* `Authorization` for authentication, format: `Bearer ${token}`, Where `${token}` is the [access token](../guide/access-token.md)
* `Accept` According to the optional types listed in the API documentation for **Response content type**, fill in the corresponding value, e.g., `application/json`

### Request Example

curl request example:

```shell
curl -X "GET" \
  -H "accept: application/json" \
  -H "Authorization: Bearer 1Z00000000000000000000000vA" \
  "https://api.cnb.build/user/groups?page=1&page_size=10"
```

Response example:

```json
[
  {
    "id": 1816756487609032700,
    "name": "test",
    "remark": "Test organization",
    "description": "",
    "site": "",
    "email": "",
    "freeze": false,
    "wechat_mp": "hello-world",
    "created_at": "2024-07-26T08:44:35Z",
    "updated_at": "2024-08-13T07:32:13Z",
    "follow_count": 0,
    "member_count": 4,
    "all_member_count": 4,
    "sub_group_count": 5,
    "sub_repo_count": 7,
    "sub_mission_count": 1,
    "all_sub_group_count": 13,
    "all_sub_repo_count": 12,
    "all_sub_mission_count": 1,
    "has_sub_group": true,
    "path": "test",
    "access_role": "Owner"
  }
]
```

Repository events interface details see [Repository Events](./openapi-event.md)
