> For the complete documentation index, see [llms.txt](https://api-docs.roundhr.com/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://api-docs.roundhr.com/round-api/api.md).

# 라운드 API 개요

## Round API

라운드 API를 통해 라운드에 등록된 채용 공고 및 지원서 폼 정보 등을 외부 서비스와 연동할 수 있습니다.

## 인증

라운드 API를 사용하기 위해서는 API Key 를 발급받으셔야 합니다.([라운드 API Key 발급 페이지](https://app.roundhr.com/w/1/setting/integration/data/api_keys?back=true))

{% hint style="info" %}
엔터프라이즈 플랜에서만 사용 가능합니다.
{% endhint %}

## 인증 방식

발급받으신 API Key를 아래와 같이 Authorization 헤더에 포함시켜 주세요.

```
authorization: "Bearer {API_KEY}"
```

{% hint style="info" %}
발급 받으신 API Key 가 외부로 유출되지 않도록 주의해 주세요.
{% endhint %}

## 응답 및 에러

API 응답의 결과는 HTTP 상태코드로 확인하실 수 있습니다.

<table><thead><tr><th width="157">code</th><th width="290">code</th><th>설명</th></tr></thead><tbody><tr><td>400</td><td>bad_request</td><td>올바르지 않은 요청의 경우</td></tr><tr><td>401</td><td>unauthorized</td><td>인증에 실패했을 경우</td></tr><tr><td>403</td><td>forbidden</td><td>실행 권한이 없는 경우</td></tr><tr><td>404</td><td>not_found</td><td>요청한 리소스를 찾지 못한 경우</td></tr></tbody></table>

인증에 실패했을 경우의 예:

```json
{
  "code": "unauthrized",
  "message": "권한이 없습니다.",
  "key": "string"
}
```

## 페이지네이션

요청하신 정보가 복수의 레코드를 반환할 경우 페이지네이션이 적용됩니다. 페이지네이션된 응답은 아래와 같은 포맷으로 반환됩니다.

```json
{
  "collection": [
    ...
  ],
  "pagination": {
    "total": 20,
    "previous_page": "MTk=_N",
    "previous_page_token": "https://api.roundhr.co.kr/v1/{path}?page_token=MTk=_N",
    "next_page": "MTk=_N",
    "next_page_token": "https://api.roundhr.co.kr/v1/{path}?page_token=MTk=_N"
  }
}
```