고객 목록 조회 API

플랫폼 서비스에서 특정 비즈니스의 고객 목록을 조회할 수 있는 API를 제공합니다.

GET kit-api/v1/customers

Method: GET Endpoint: kit-api/v1/customers

Example

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

...kit-api/v1/customers?customKey=A5-k159402

Request Query

Key	Description	Required
limit	목록 개수 (default 10, max 100)	no
offset	스킵할 목록 개수	no
customKey	검색할 custom key (단건 검색)	no

Response

{
  "ok": true,
  "data": {
    "total": 2,
    "customers": [
      {
        "id": 1,
        "title": "김철수",
        "customKey": "A5-k159402"
      },
      {
        "id": 2,
        "title": "김영희",
        "customKey": null
      }
    ]
  }
}

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

Error Codes

Status Code	Error Code	Description
400	INVALID_CUSTOMER_CUSTOM_KEY	규칙을 벗어난 customKey인 경우
404	NOT_FOUND_CUSTOMER	존재하지 않는 고객인 경우