Sign in
Channel

채널 목록 조회

채널을 조회한다. page/size 를 모두 생략하면 페이지네이션 없이 전체 채널을 반환한다. page 또는 size 중 하나라도 지정하면 페이지 조회로 동작한다(생략된 값은 page=0, size=12). size 는 최대 100. name 지정 시 채널명으로 필터링. primaryCategory 지정 시 그 대표 업종의 채널만 반환한다. 여러 번 넘기거나(primaryCategory=A&primaryCategory=B) 쉼표로 이어(primaryCategory=A,B) 여러 업종을 고를 수 있고, 그중 하나에 해당하면 남는다. 정렬은 name, createdAt 만 지원한다(형식: sort=name,desc / 기본값 name,asc)

get/api/v1/channels

Request

  • Base URL: https://api.chaeso-zip.com
  • URL: https://api.chaeso-zip.com/api/v1/channels
  • Auth: none declared

Query parameters

namestring

채널명 검색어

Example:11번가
primaryCategorystring[]

대표 업종 코드값

[
  "SHOPPING_COMMERCE"
]
pageinteger

페이지 번호(0-base)

sizeinteger

페이지 크기

Example:12
sortstring[]

Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported.

Response

조회 성공

successboolean required

요청 성공 여부

codestring nullable required

성공 안내 코드. 안내할 것이 없으면 null

Example response

{
  "success": true,
  "data": {
    "content": [
      {
        "id": "550e8400-e29b-41d4-a716-446655440000",
        "name": "11번가 광고",
        "iconUrl": "https://assets.chaeso-zip.com/channels/550e8400-e29b-41d4-a716-446655440000/icon.png",
        "primaryCategory": "SHOPPING_COMMERCE"
      }
    ],
    "size": 12,
    "totalElements": 101,
    "totalPages": 9
  },
  "error": {
    "code": "C-001",
    "message": "입력값이 올바르지 않습니다.",
    "fieldErrors": [
      {
        "field": "name",
        "reason": "이름은 필수입니다."
      }
    ]
  },
  "code": "GOOGLE_ACCOUNT_LINKED"
}

Changes

No recorded changes to this operation across all 1 revision of this API.