Kakao Work::Web API 레퍼런스::Departments

페이지 이동경로

Departments

특정 워크스페이스에 속한 부서 정보를 조회하기 위해 다음과 같은 API를 사용합니다.

Departments API 리스트
구분 API 명 설명
정보 조회 departments.list 특정 워크스페이스에 속한 전체 부서 리스트 및 상세 정보 조회

departments.list

워크스페이스에 속한 전체 부서 정보를 조회합니다.

Request

Request Syntax

코드예제departments.list Request Syntax

  curl -X GET https://api.kakaowork.com/v1/departments.list \
   -H "Authorization: Bearer {YOUR_APP_KEY}" 

API 호출 방식
메서드 요청 URL
GET https://api.kakaowork.com/v1/departments.list

Request Header

Request Header에 대한 상세는 다음과 같습니다.

departments.list Request Header
파라미터 타입 필수 여부 설명
Authorization String 필수 Bearer {YOUR_APP_KEY}
- {YOUR_APP_KEY}: Bot 등록 요청 후에 획득한 인증키(App Key)
Content-Type String 선택 application/json 또는 application/x-www-form-urlencoded

Request Elements

Request Elements에 대한 상세는 다음과 같습니다.

departments.list Request Elements
파라미터 타입 필수 여부 설명
limit String 선택 한 번에 가져올 수 있는 데이터 개수
- 기본값: 10, 최대값: 100
cursor String 선택 다음 API 호출 시에 사용할 페이징 커서(Cursor)
안내
Pagination의 자세한 규칙은 Pagination을 참고하시기 바랍니다.

Response

Response Syntax

코드예제departments.list Response Syntax

{
  "success": true,
  "departments": { /* ... departments entity ... */ },
  "cursor": " /* ... 다음 호출 항목이 있으면 커서 키, 없으면 null */ "
}

Response Elements

Response Elements에 대한 상세는 다음과 같습니다.

departments.list Response Elements
필드 타입 필수 여부 설명
success Boolean 필수 API 호출 실행 결과
true: 성공, departmentscursor 필드 함께 반환
false: 실패, error 필드와 함께 반환
Object[] 선택 부서의 상세 정보
- API 호출 성공(true)일 경우 제공
id String 필수 부서의 ID
space_id String 필수 부서가 속한 워크스페이스의 ID
name String 필수 부서명
code String 필수 부서를 구분하는 고유 값
user_count Integer 필수 팀원 수
- 하위 부서의 팀원 수는 포함하지 않음
has_child Boolean 선택 하위 부서가 있는지 여부
depth Integer 선택 부서 Depth 레벨
user_ids Integer[] 선택 팀원 정보
leader_ids Integer[] 선택 리더 정보
ancestry String 선택 현재 부서의 상위 부서들 ID 경로(/로 구분)
cursor String 선택 다음 API 호출 시에 쓰일 페이징 커서(Cursor)
- API 호출 성공(true)일 경우 제공
Object 선택 API 실행 오류 정보
- API 호출 실패(false)일 경우 제공
code String 필수 오류 상황을 구분하는 코드
invalid_parameter:
제공된 파라미터의 값이 올바르지 않음
invalid_authentication:
제공된 인증키가 유효하지 않음
invalid_representation:
유효하지 않은 포맷의 Body 데이터
api_not_found:
요청 API의 URL 혹은 HTTP 메서드와 다름
unauthorized:
인증키가 제공되지 않음
internal_server_error:
정의되지 않은 서버 오류 발생
too_many_requests:
API 사용 한도가 초과됨
expired_authentication:
제공된 인증키가 만료됨
invalid_content_type:
요청이 API가 요구하는 Content Type과 다름
missing_parameter:
필요한 파라미터 값이 제공되지 않았음
message String 필수 오류 원인에 대한 설명
이 문서가 만족스러운 이유를 알려주세요.
이 문서에 아쉬운 점을 알려주세요.
평가해주셔서 감사합니다.

더 자세한 의견은 documentation@kakaoenterprise.com 으로 제보해주세요.