프로젝트

프로젝트 조회

get

프로젝트 ID로 프로젝트 상세 정보를 조회합니다.

Authorizations

x-api-keystringRequired

Path parameters

idstringRequired

프로젝트 ID

Responses

200

모든 응답은 200으로 내려갑니다 (성공 실패 포함) (장애상황에서만 5xx 노출)

application/json

resultstring · enumRequired

응답 결과 타입

Possible values:

get

/api/v1/projects/{id}

GET /api/v1/projects/{id} HTTP/1.1
Host: openapi.archisketch.com
x-api-key: YOUR_API_KEY
Accept: */*

200

모든 응답은 200으로 내려갑니다 (성공 실패 포함) (장애상황에서만 5xx 노출)

{
  "result": "SUCCESS",
  "data": {
    "id": "text",
    "name": "text",
    "enterpriseId": "text",
    "floorplans": [],
    "images": [
      {
        "type": "DEFAULT",
        "imageId": "text",
        "url": "text",
        "order": 1
      }
    ],
    "mapFloorplanDetail": {
      "id": "text",
      "mapFloorplanId": "text",
      "floorplanDetailId": "text",
      "enterpriseId": "text",
      "userId": "text",
      "access": "text",
      "lat": 1,
      "lng": 1,
      "floorplanDetails": [
        {
          "id": "text",
          "mapFloorplanId": "text",
          "preview": "text",
          "status": "CREATED",
          "areaInfo": {
            "areaType": "text",
            "area": "text",
            "supplyArea": "text",
            "exclusiveArea": "text"
          },
          "assign": {
            "userId": "text",
            "email": "text"
          },
          "oldMapId": 1,
          "createdAt": "2026-05-21T00:10:27.486Z",
          "updatedAt": "2026-05-21T00:10:27.486Z"
        }
      ],
      "address": {
        "id": "text",
        "parentId": "text",
        "userId": "text",
        "enterpriseId": "text",
        "numberAddress": "text",
        "roadAddress": "text",
        "zipcode": "text",
        "danjiCode": "text",
        "adminCode": "text",
        "roadCode": "text",
        "buildingCode": "text",
        "buildingName": "text"
      },
      "createdAt": "2026-05-21T00:10:27.486Z"
    },
    "ownerUser": {
      "id": "text",
      "name": "text",
      "email": "text",
      "imageUrl": "text"
    },
    "projectAccessUsers": [
      {
        "id": "text",
        "name": "text",
        "email": "text",
        "imageUrl": "text",
        "accessType": "EDIT"
      }
    ],
    "createdAt": "2026-05-21T00:10:27.486Z",
    "updatedAt": "2026-05-21T00:10:27.486Z"
  },
  "error": {
    "errorCode": "INTERNAL_ERROR",
    "message": "text"
  }
}

프로젝트 수정

put

프로젝트 ID로 프로젝트 이름을 수정합니다.

Authorizations

x-api-keystringRequired

Path parameters

idstringRequired

프로젝트 ID

Body

namestringRequired

프로젝트 이름

Responses

200

모든 응답은 200으로 내려갑니다 (성공 실패 포함) (장애상황에서만 5xx 노출)

application/json

resultstring · enumRequired

응답 결과 타입

Possible values:

dataanyOptional

응답 데이터

put

/api/v1/projects/{id}

PUT /api/v1/projects/{id} HTTP/1.1
Host: openapi.archisketch.com
x-api-key: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 15

{
  "name": "text"
}

200

모든 응답은 200으로 내려갑니다 (성공 실패 포함) (장애상황에서만 5xx 노출)

{
  "result": "SUCCESS",
  "data": null,
  "error": {
    "errorCode": "INTERNAL_ERROR",
    "message": "text"
  }
}

휴지통 프로젝트 노출 상태 보이기로 변경

post

프로젝트 ID 목록으로 휴지통 프로젝트를 복원합니다.

Authorizations

x-api-keystringRequired

Body

idsstring[]Required

복구할 프로젝트 ID 목록

Responses

200

모든 응답은 200으로 내려갑니다 (성공 실패 포함) (장애상황에서만 5xx 노출)

application/json

resultstring · enumRequired

응답 결과 타입

Possible values:

dataanyOptional

응답 데이터

post

/api/v1/projects/restore

POST /api/v1/projects/restore HTTP/1.1
Host: openapi.archisketch.com
x-api-key: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 16

{
  "ids": [
    "text"
  ]
}

200

모든 응답은 200으로 내려갑니다 (성공 실패 포함) (장애상황에서만 5xx 노출)

{
  "result": "SUCCESS",
  "data": null,
  "error": {
    "errorCode": "INTERNAL_ERROR",
    "message": "text"
  }
}

북마크 프로젝트 목록 조회

get

북마크된 프로젝트 목록을 조회합니다.

사용처

사용자가 북마크한 프로젝트 목록 확인
기업/개인별 북마크 프로젝트 관리
북마크 프로젝트 검색 및 필터링

페이지네이션

offset 기반 페이징 (0부터 시작)
limit: 페이지 크기 (최소 1, 최대 100)
응답의 hasNext로 다음 페이지 존재 여부 확인

필터 조건

bookmarkOwnerType: 북마크 소유자 유형 (필수)
projectDirectoryType: 프로젝트 디렉토리 유형 (필수)
userId: PERSONAL 타입일 때 필수
directoryId: 특정 디렉토리 내 조회
targetType: 사용자 검색 유형
keyword: 프로젝트 이름 검색
sortType: 정렬 기준 (기본값: ID_DESC)
status: 프로젝트 상태 (기본값: ACTIVE)

Authorizations

x-api-keystringRequired

Query parameters

userIdstringOptional

사용자 ID (PERSONAL 타입 필수)

bookmarkOwnerTypestring · enumRequired

북마크 소유자 유형

Possible values:

projectDirectoryTypestring · enumRequired

프로젝트 디렉토리 타입

Possible values:

directoryIdstringOptional

디렉토리 ID

targetTypestring · enumOptional

사용자 검색 대상 타입

Possible values:

keywordstringOptional

검색어

offsetinteger · int32Required

페이지 번호 (0부터 시작, offset 페이징)

limitinteger · int32Required

페이지 크기 (최소: 1, 최대: 100)

sortTypestring · enumOptional

정렬 타입

Default: ID_DESCPossible values:

statusstring · enumOptional

활성 상태

Default: ACTIVEPossible values:

Responses

200

모든 응답은 200으로 내려갑니다 (성공 실패 포함) (장애상황에서만 5xx 노출)

application/json

resultstring · enumRequired

응답 결과 타입

Possible values:

get

/api/v1/bookmark-projects

GET /api/v1/bookmark-projects?bookmarkOwnerType=PERSONAL&projectDirectoryType=ENTERPRISE&offset=1&limit=1 HTTP/1.1
Host: openapi.archisketch.com
x-api-key: YOUR_API_KEY
Accept: */*

200

모든 응답은 200으로 내려갑니다 (성공 실패 포함) (장애상황에서만 5xx 노출)

{
  "result": "SUCCESS",
  "data": {
    "content": [
      {
        "id": "text",
        "name": "text",
        "images": [
          {
            "type": "DEFAULT",
            "imageId": "text",
            "url": "text",
            "order": 1
          }
        ],
        "bookmarked": true,
        "ownerUser": {
          "id": "text",
          "name": "text",
          "email": "text",
          "imageUrl": "text"
        },
        "projectAccessUsers": [
          {
            "id": "text",
            "name": "text",
            "email": "text",
            "imageUrl": "text",
            "accessType": "EDIT"
          }
        ],
        "createdAt": "2026-05-21T00:10:27.486Z",
        "updatedAt": "2026-05-21T00:10:27.486Z"
      }
    ],
    "hasNext": true,
    "totalCount": 1
  },
  "error": {
    "errorCode": "INTERNAL_ERROR",
    "message": "text"
  }
}

프로젝트 북마크 적용

post

프로젝트에 북마크를 추가하거나 제거합니다.

Authorizations

x-api-keystringRequired

Body

projectIdstringRequired

프로젝트 ID

ownerTypestring · enumRequired

북마크 소유자 유형

Possible values:

typestring · enumRequired

북마크 유형 (BOOKMARKED: 북마크, UNBOOKMARKED: 북마크 제거)

Possible values:

userIdstringOptional

사용자 ID (PERSONAL 타입 시 필수)

Responses

200

모든 응답은 200으로 내려갑니다 (성공 실패 포함) (장애상황에서만 5xx 노출)

application/json

resultstring · enumRequired

응답 결과 타입

Possible values:

dataanyOptional

응답 데이터

post

/api/v1/bookmark-projects

POST /api/v1/bookmark-projects HTTP/1.1
Host: openapi.archisketch.com
x-api-key: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 79

{
  "projectId": "text",
  "ownerType": "PERSONAL",
  "type": "BOOKMARKED",
  "userId": "text"
}

200

모든 응답은 200으로 내려갑니다 (성공 실패 포함) (장애상황에서만 5xx 노출)

{
  "result": "SUCCESS",
  "data": null,
  "error": {
    "errorCode": "INTERNAL_ERROR",
    "message": "text"
  }
}

get

공유된 프로젝트 목록을 조회합니다.

사용처

사용자가 공유한/공유받은 프로젝트 목록 확인
공유 방향별 프로젝트 관리
공유 프로젝트 검색

페이지네이션

offset 기반 페이징 (0부터 시작)
limit: 페이지 크기 (최소 1, 최대 100)
응답의 hasNext로 다음 페이지 존재 여부 확인

필터 조건

userId: 사용자 ID (필수)
shareDirection: 공유 방향 (필수)
keyword: 프로젝트 이름 검색
sortType: 정렬 기준 (기본값: ID_DESC)

Authorizations

x-api-keystringRequired

Query parameters

userIdstringRequired

사용자 ID

shareDirectionstring · enumRequired

공유 타입

Possible values:

keywordstringOptional

프로젝트 이름 검색어

offsetinteger · int32Required

페이지 번호 (0부터 시작, offset 페이징)

limitinteger · int32Required

페이지 크기 (최소: 1, 최대: 100)

sortTypestring · enumOptional

정렬 타입

Default: ID_DESCPossible values:

Responses

200

모든 응답은 200으로 내려갑니다 (성공 실패 포함) (장애상황에서만 5xx 노출)

application/json

resultstring · enumRequired

응답 결과 타입

Possible values:

get

/api/v1/share-projects

GET /api/v1/share-projects?userId=text&shareDirection=SHARED_BY_ME&offset=1&limit=1 HTTP/1.1
Host: openapi.archisketch.com
x-api-key: YOUR_API_KEY
Accept: */*

200

모든 응답은 200으로 내려갑니다 (성공 실패 포함) (장애상황에서만 5xx 노출)

{
  "result": "SUCCESS",
  "data": {
    "content": [
      {
        "id": "text",
        "name": "text",
        "images": [
          {
            "type": "DEFAULT",
            "imageId": "text",
            "url": "text",
            "order": 1
          }
        ],
        "bookmarked": true,
        "ownerUser": {
          "id": "text",
          "name": "text",
          "email": "text",
          "imageUrl": "text"
        },
        "projectAccessUsers": [
          {
            "id": "text",
            "name": "text",
            "email": "text",
            "imageUrl": "text",
            "accessType": "EDIT"
          }
        ],
        "createdAt": "2026-05-21T00:10:27.486Z",
        "updatedAt": "2026-05-21T00:10:27.486Z"
      }
    ],
    "hasNext": true,
    "totalCount": 1
  },
  "error": {
    "errorCode": "INTERNAL_ERROR",
    "message": "text"
  }
}

프로젝트 목록 조회

get

프로젝트 디렉토리 유형에 따른 프로젝트 목록을 조회합니다.

사용처

기업/개인 디렉토리별 프로젝트 목록 조회
특정 디렉토리 내 프로젝트 필터링
사용자별, 키워드별 프로젝트 검색

페이지네이션

offset 기반 페이징 (0부터 시작)
limit: 페이지 크기 (최소 1, 최대 100)
응답의 hasNext로 다음 페이지 존재 여부 확인

필터 조건

projectDirectoryType: 프로젝트 디렉토리 유형 (필수)
userId: PERSONAL 타입일 때 필수
directoryId: 특정 디렉토리 내 조회
targetType: 사용자 검색 유형
keyword: 프로젝트 이름 검색
sortType: 정렬 기준 (기본값: ID_DESC)
status: 프로젝트 상태 (기본값: ACTIVE)

Authorizations

x-api-keystringRequired

Query parameters

projectDirectoryTypestring · enumRequired

프로젝트 디렉토리 타입

Possible values:

userIdstringOptional

사용자 ID (PERSONAL 타입 필수)

offsetinteger · int32Required

페이지 번호 (0부터 시작, offset 페이징)

limitinteger · int32Required

페이지 크기 (최소: 1, 최대: 100)

directoryIdstringOptional

디렉토리 ID

targetTypestring · enumOptional

사용자 검색 대상 타입

Possible values:

keywordstringOptional

검색어

sortTypestring · enumOptional

정렬 타입

Default: ID_DESCPossible values:

statusstring · enumOptional

활성 상태

Default: ACTIVEPossible values:

Responses

200

모든 응답은 200으로 내려갑니다 (성공 실패 포함) (장애상황에서만 5xx 노출)

application/json

resultstring · enumRequired

응답 결과 타입

Possible values:

get

/api/v1/projects

GET /api/v1/projects?projectDirectoryType=ENTERPRISE&offset=1&limit=1 HTTP/1.1
Host: openapi.archisketch.com
x-api-key: YOUR_API_KEY
Accept: */*

200

모든 응답은 200으로 내려갑니다 (성공 실패 포함) (장애상황에서만 5xx 노출)

{
  "result": "SUCCESS",
  "data": {
    "content": [
      {
        "id": "text",
        "name": "text",
        "images": [
          {
            "type": "DEFAULT",
            "imageId": "text",
            "url": "text",
            "order": 1
          }
        ],
        "bookmarked": true,
        "ownerUser": {
          "id": "text",
          "name": "text",
          "email": "text",
          "imageUrl": "text"
        },
        "projectAccessUsers": [
          {
            "id": "text",
            "name": "text",
            "email": "text",
            "imageUrl": "text",
            "accessType": "EDIT"
          }
        ],
        "createdAt": "2026-05-21T00:10:27.486Z",
        "updatedAt": "2026-05-21T00:10:27.486Z"
      }
    ],
    "hasNext": true,
    "totalCount": 1
  },
  "error": {
    "errorCode": "INTERNAL_ERROR",
    "message": "text"
  }
}

프로젝트 견적 조회

get

프로젝트의 현재 견적 데이터를 조회합니다.

Authorizations

x-api-keystringRequired

Path parameters

idstringRequired

프로젝트 ID

Responses

200

모든 응답은 200으로 내려갑니다 (성공 실패 포함) (장애상황에서만 5xx 노출)

application/json

resultstring · enumRequired

응답 결과 타입

Possible values:

get

/api/v1/project/{id}/estimates

GET /api/v1/project/{id}/estimates HTTP/1.1
Host: openapi.archisketch.com
x-api-key: YOUR_API_KEY
Accept: */*

200

모든 응답은 200으로 내려갑니다 (성공 실패 포함) (장애상황에서만 5xx 노출)

{
  "result": "SUCCESS",
  "data": {
    "projectId": "proj_abc123",
    "projectName": "강남 아파트 인테리어",
    "userId": "user_xyz789",
    "userName": "홍길동",
    "userEmail": "[email protected]",
    "furnitureItems": [
      {
        "floorId": "floor_001",
        "floorName": "1층",
        "roomId": "room_001",
        "roomType": "거실",
        "componentId": "comp_abc123",
        "code": "SKU-001",
        "previewImage": "https://cdn.example.com/images/sofa.jpg",
        "name": "3인용 패브릭 소파",
        "colorName": "라이트 그레이",
        "colorCode": "#D3D3D3",
        "brand": "한샘",
        "dimensionInch": {
          "width": 90,
          "height": 85,
          "depth": 95
        },
        "dimensionMm": {
          "width": 90,
          "height": 85,
          "depth": 95
        },
        "quantity": 1,
        "retailPrice": {
          "value": 1500000,
          "currency": "KRW"
        },
        "factoryPrice": {
          "value": 1500000,
          "currency": "KRW"
        },
        "totalPrice": {
          "value": 1500000,
          "currency": "KRW"
        }
      }
    ],
    "finishItems": [
      {
        "floorId": "floor_001",
        "floorName": "1층",
        "roomId": "room_001",
        "roomType": "거실",
        "productId": "prod_abc123",
        "previewImage": "https://cdn.example.com/images/tile.jpg",
        "name": "포세린 타일 600x600",
        "colorName": "화이트 마블",
        "colorCode": "#F5F5F5",
        "dimensionInch": {
          "width": 90,
          "height": 85,
          "depth": 95
        },
        "dimensionMm": {
          "width": 90,
          "height": 85,
          "depth": 95
        },
        "quantity": 10,
        "tileQuantity": 45,
        "tileQuantityMin": 40,
        "tileQuantityMax": 50,
        "targetType": "FLOOR",
        "targetArea": 24.5,
        "retailPrice": {
          "value": 1500000,
          "currency": "KRW"
        },
        "totalPrice": {
          "value": 1500000,
          "currency": "KRW"
        }
      }
    ],
    "createdAt": "2024-01-01T00:00:00"
  },
  "error": {
    "errorCode": "INTERNAL_ERROR",
    "message": "text"
  }
}

Previous카테고리 Next이미지

Last updated 8 days ago

Was this helpful?

프로젝트 조회

프로젝트 수정

휴지통 프로젝트 노출 상태 보이기로 변경

북마크 프로젝트 목록 조회

사용처

페이지네이션

필터 조건

프로젝트 북마크 적용

공유 프로젝트 목록 조회

사용처

페이지네이션

필터 조건

프로젝트 목록 조회

사용처

페이지네이션

필터 조건

프로젝트 견적 조회