GET/business-support/business-places

사업장 목록을 조회한다.

Authorization

oauth2

OAuth 2.0 인증.
자세한 인증 방식은 인가·인증을 참고한다.

Scope

businessSupport.businessPlace
businessSupport.businessPlace.read

HTTP Request

GEThttps://www.worksapis.com/v1.0/business-support/business-places

Query Parameters

ParameterTypeDescription
count integer 

조회 개수


default : 100
minimum : 1
maximum : 100
example : 20
format : int32 
cursor string 

다음 목록 조회 시 사용하는 값


example : JlIBsfJogXpzDGY8OscZziqZpYqCAu3RbZbaFzBb1od6lWQtSdPUd2FIdCuaGgu8DA== 

Header Parameters

HeadertypeDescription
Authorization string 

Bearer {token}


required 

Response

HTTP 200

OK

PropertyTypeDescription
businessPlaces array (object) 
 
responseMetaData object (responseMetaData) 

페이지 매김 처리를 위한 메타데이터

 

object

PropertyTypeDescription
businessPlaceId integer 

사업장 ID


format : int64 
businessPlaceType string 

사업장 타입

  • CORPORATE: 법인 사업자
  • SOLE_PROPRIETORSHIP: 개인 사업자

Allowed values : CORPORATE, SOLE_PROPRIETORSHIP 
businessPlaceName string 

사업장 이름


required 
i18nNames array (i18nName) 

다국어 목록 정보.
Admin > 기본환경 > 회사 정보 > 다국어 설정에서 지정된 항목의 다국어만 표시된다.

 
telephone string 

전화번호

 
corporationName string 

법인명 또는 상호


required 
corporationNumber string 

법인 번호 또는 대표자 주민 번호

 
businessRegistrationNumber string 

사업자 번호


required 
businessRegistrationSubNumber integer 

종사업장 번호(4자리)

 
representativeName string 

대표자 이름


required 
representativei18nNames array (i18nName) 

다국어 목록 정보.
Admin > 기본환경 > 회사 정보 > 다국어 설정에서 지정된 항목의 다국어만 표시된다.

 
zipCode string 

우편번호


required 
address string 

주소


required 
addressDetail string 

상세 주소


required 
businessItem string 

업종

 
businessType string 

업태

 
taxOfficeCode integer 

세무서 코드


required 
closureDate string 

사업장 운영 종료일

 
externalKey string 

사업장 외부 키

 
enabled boolean 

사용 여부


required 

i18nName

PropertyTypeDescription
name string 

다국어 이름


required
minLength : 1
maxLength : 100 
language string 

다국어 언어 코드


required
Allowed values : ko_KR, en_US, ja_JP, zh_CN, zh_TW 

responseMetaData

PropertyTypeDescription
nextCursor string 

다음 페이지 조회를 위한 커서

 

Response Example

example

1{2  "businessPlaces": [3    {4      "businessPlaceId": 58,5      "businessPlaceType": "CORPORATE",6      "businessPlaceName": "서초 사업장",7      "i18nNames": [8        {9          "name": "서초 사업장",10          "language": "ko_KR"11        }12      ],13      "corporationNumber": "0000001000000",14      "corporationName": "주식회사 네이버클라우드",15      "telephone": "0200000000",16      "businessRegistrationNumber": "111111111",17      "businessRegistrationSubNumber": 1234,18      "representativeName": "홍길동",19      "representativei18nNames": [20        {21          "name": "홍길동",22          "language": "ko_KR"23        }24      ],25      "zipCode": "06693",26      "address": "경기도 성남시 분당구 동판교로 65번길 34-13",27      "addressDetail": "103동 101호",28      "businessItem": "IT",29      "businessType": "교육",30      "taxOfficeCode": 123,31      "closureDate": "2027-12-31",32      "enabled": true33    }34  ],35  "responseMetaData": {36    "nextCursor": "JlIBsfJogXpzDGY8OscZziqZpYqCAu3RbZbaFzBb1od6lWQtSdPUd2FIdCuaGgu8DA=="37  }38}

HTTP 403

Forbidden