생성한 비즈니스 목록 조회 API

플랫폼 서비스에서 생성한 비즈니스 목록을 조회할 수 있도록 API를 제공합니다.

GET kit-api/v1/business/managing

Method: GET Endpoint: kit-api/v1/business/managing

Example

.../kit-api/v1/business/managing?limit=10&offset=0

Request Query

Key	Description	Required
limit	목록 개수 (default 10, max 100)	no
offset	스킵할 목록 개수	no

Response

{
  "ok": true,
  "data": {
    "total": 2,
    "businessList": [
      {
        "uuid": "686961a8-3975-4ad5-bf4e-134706efee15",
        "name": "홍길동 컴퍼니",
        "registrationNumber": "123-12-12345",
        "ceo": "홍길등",
        "address": null,
        "createdAt": "2024-11-16T04:40:26.298Z",
        "apiKey": "...", // api key
        "customerCustomName": "거래처", // 커스텀 '고객' 명칭
        "users": [
          {
            "name": "홍길동",
            "email": "[email protected]"
          }
        ]
      },
      {
        "uuid": "e790e9a8-a47e-4029-9d6c-e3dfc13fdf74",
        "name": "A에이전시",
        "registrationNumber": null,
        "ceo": null,
        "address": null,
        "createdAt": "2024-09-01T02:42:08.760Z",
        "apiKey": "...", // api key
        "customerCustomName": null,
        "users": [
          {
            "name": "김담당",
            "email": "[email protected]"
          }
        ]
      }
    ]
  }
}

{
  "ok": false, // api 실패
  "message": "error message", // Error가 존재하면 message(string)로 전달
  "errorCode": "ERROR_CODE"
}