API 레퍼런스
로그인
본문으로 건너뛰기

알림 목록

GET/v1/organizations/{org_id}/notifications

조직에 보낸 알림 메일 기록을 최신순으로 돌려줍니다

콘솔 세션 전용입니다, 조직 역할 owner, admin, developer만 부를 수 있고 API 키로 부르면 403 console_only입니다

  • 소유자와 관리자는 모든 알림을, 개발자는 배정된 워크스페이스의 한도 알림과 그 워크스페이스 키의 알림만 봅니다

Headers

  • Cookie: string
    콘솔 로그인 세션 쿠키, 콘솔 전용 엔드포인트라 API 키로 부르면 403 console_only입니다

Parameters

  • org_id: string
    조직 ID
    형식 ^org_[A-Za-z0-9]+$
  • kind: optional string
    이 종류의 알림만
  • limit: optional integer
    한 페이지 크기
    기본값 20, 최소 1, 최대 100
  • cursor: optional string
    이전 응답의 next_cursor

Returns

200 application/json

  • NotificationList: object
    • data: array of Notification { id, kind, status, … }
      항목 배열
      • id: string
        ntf_<번호>
      • kind: "low_balance" or "credit_exhausted" or "workspace_limit" or "tier_limit" or "key_leaked" or "key_spike" or "key_new_ip" or "job_stopped"
        알림 종류
      • status: "sending" or "sent" or "failed" or "suppressed"
        sending, sent, failed, suppressed
      • created_at: string
        만든 시각
        RFC 3339 UTC 시각
      • sent_at: optional string or null
        보낸 시각
      • workspace_id: optional string or null
        워크스페이스 ID
      • api_key_id: optional string or null
        API 키 ID
      • job_id: optional string or null
        잡 ID
      • detail: optional object
        종류별 숫자(기준, 금액), 수신 주소와 키 비밀 값은 없습니다
      • recipients: optional integer or null
        보낸 주소 수, 개발자에게는 null
    • next_cursor: string or null
      다음 페이지 커서, 마지막이면 null

오류

  • invalid_request: HTTP 400
    본문이나 쿼리가 검증에 실패했습니다, error.details.fields에 문제 필드가 있습니다
  • session_required: HTTP 401
    콘솔 엔드포인트를 유효한 콘솔 세션 쿠키 없이 불렀습니다
  • console_only: HTTP 403
    콘솔 세션 전용 엔드포인트입니다, API 키로는 결제, 키, 멤버 관리를 할 수 없습니다
  • insufficient_permission: HTTP 403
    역할이나 키 권한(run/read)이 이 요청을 허용하지 않습니다
  • not_found: HTTP 404
    자원이 없거나 이 호출자에게 보이지 않습니다
  • rate_limited: HTTP 429, 다시 시도 가능
    이 키 또는 조직의 요청이 너무 많습니다, retry_after_s만큼 기다리세요
  • internal_error: HTTP 500, 다시 시도 가능
    예상하지 못한 오류입니다, 다시 시도하고 반복되면 request_id와 함께 알려 주세요

오류 봉투 모양과 전체 코드 표는 오류 코드에 있습니다

다음 단계