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

페이지 이동경로

Spaces

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

Spaces API 리스트
구분 API 명 설명
정보 조회 spaces.info 워크스페이스의 정보 조회

spaces.info

워크스페이스의 정보를 조회합니다.

Request

Request Syntax

코드예제space.info Request Syntax

  curl -X GET https://api.kakaowork.com/v1/spaces.info \
   -H "Authorization: Bearer {YOUR_APP_KEY}" \
   -H "Content-Type: application/json;charset=utf-8"

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

Request Header

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

spaces.info 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

요구하는 파라미터가 없습니다.

Response

Response Syntax

코드예제space.info Response Syntax

{
  "success": true,
  "space": { /* ... space entity ... */ }
}

Response Elements

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

spaces.info Response Elements
필드 타입 필수 여부 설명
success Boolean 필수 API 호출 실행 결과
true: 성공, space 필드와 함께 반환
false: 실패, error 필드와 함께 반환
Object 선택 스페이스의 상세 정보
- API 호출 성공(true)일 경우 제공
id String 필수 스페이스 ID
kakaoi_org_id String 필수 카카오 i 계정 시스템의 ID
name String 필수 스페이스 이름
color_code String 필수 스페이스 대표 색상
- 약속된 키워드가 저장되며, 기본 값은 default
- Deprecated 예정
- color_set으로 대체 예정
color_tone String 필수 스페이스 대표 색상의 색조
- Deprecated 예정
- color_set으로 대체 예정
Light
Dark
permitted_ext Integer[] 필수 스페이스 내에서 파일 첨부시 허용되는 확장자 리스트
- Deprecated 예정
.*: 모든 확장자 허용 (기본값)
.jpg, .png, .gif, .bmp: 열거된 확장자만 허용
profile_name_format String 필수 스페이스 내 이름 표시 형식
- Deprecated 예정
name_only: 이름만 표시
name_nickname: 이름_(닉네임) 형식
nickname_name: 닉네임_(이름) 형식
profile_position_format String 필수 멤버 프로필에 표시될 직위 또는 직책 정보
- Deprecated 예정
position: 직위(대리, 과장, 차장 등)
responsibility: 직책(셀장, 파트장 등)
logo_url String 선택 스페이스 로고 이미지 URL
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 으로 제보해주세요.