문서 메뉴

REST API

워크스페이스

PAT 소유자가 접근할 수 있는 워크스페이스와 상세 설정을 조회합니다. 목록에는 PAT가 차단된 워크스페이스도 포함될 수 있으므로, 반환된 slug가 곧바로 워크스페이스 범위 API를 호출할 수 있음을 보장하지 않습니다.

GET/v2/workspaces

워크스페이스 목록 조회

요청자가 접근할 수 있는 워크스페이스 목록을 조회합니다.

파라미터

  • statusWorkspaceStatus | nullquery
    조회할 워크스페이스 상태입니다.
  • only_activeboolean | nullquery
    활성 워크스페이스만 조회할지 여부입니다.
  • offsetintegerquery기본값 0
    첫 번째 반환 항목의 0부터 시작하는 오프셋입니다.
  • limitintegerquery기본값 20
    반환할 최대 항목 수입니다.

요청 예시

curl --request GET \
  --url "https://api.callabo.ai/v2/workspaces" \
  --header "Accept: application/json" \
  --header "Authorization: Bearer $CALLABO_PAT"

성공 응답

응답 본문

  • items필수V2Workspace[]
    워크스페이스 목록입니다.
  • id필수integer
    워크스페이스 식별자입니다.
  • slug필수string
    요청 경로에 사용하는 현재 워크스페이스 슬러그입니다.
  • name필수string
    워크스페이스 이름입니다.
  • emailstring | null
    워크스페이스 대표 이메일입니다.
  • billing_email필수string
    워크스페이스 결제 이메일입니다.
  • keywords필수string[]
    워크스페이스 기본 키워드 목록입니다.
  • color필수string
    워크스페이스 대표 색상입니다.
  • use_2fa필수boolean
    2단계 인증 사용 여부입니다.
  • ip_block_type필수IpBlockType
    워크스페이스 IP 접근 제한 방식입니다.
  • status필수WorkspaceStatus
    워크스페이스 상태입니다.
  • referrer_codestring | null
    워크스페이스 추천 코드입니다.
  • domains필수string[]
    워크스페이스에 등록된 이메일 도메인 목록입니다.
  • pat_enabled필수boolean
    개인 액세스 토큰으로 워크스페이스 범위 API를 호출할 수 있는지 여부입니다.
  • base_role필수BaseWorkspaceRole
    요청자의 워크스페이스 기본 역할입니다.
  • settings필수V2WorkspaceSettings
    워크스페이스의 레코드·보존 기본 설정입니다.
  • created_at필수string (date-time)
    워크스페이스 생성 시각입니다.
  • updated_at필수string (date-time)
    워크스페이스 마지막 수정 시각입니다.
  • page필수V2Pagination
    워크스페이스 목록 페이지 정보입니다.
  • offset필수integer
    첫 번째 반환 항목의 0부터 시작하는 오프셋입니다.
  • limit필수integer
    요청한 최대 항목 수입니다.
  • total필수integer
    조건에 맞는 전체 항목 수입니다.

응답 예시

{
  "items": [
    {
      "id": 1,
      "slug": "your-workspace",
      "name": "Example",
      "billing_email": "developer@example.com",
      "keywords": [
        "string"
      ],
      "color": "string",
      "use_2fa": true,
      "ip_block_type": "none",
      "status": "created",
      "domains": [
        "string"
      ],
      "pat_enabled": true,
      "base_role": "workspace_manager",
      "settings": {
        "default_access_scope": "all",
        "default_transcribe_language": "detect",
        "save_media": true,
        "save_dialog": true,
        "provision_type": "scim_auto",
        "request_insight_extract_type": "custom"
      },
      "created_at": "2026-08-27T03:00:00Z",
      "updated_at": "2026-08-27T03:00:00Z"
    }
  ],
  "page": {
    "offset": 1,
    "limit": 1,
    "total": 1
  }
}

오류

상태오류 코드설명
401UNAUTHORIZED인증되지 않은 요청
422VALIDATION_ERROR처리할 수 없는 콘텐츠
429RATE_LIMIT_EXCEEDED요청 한도 초과자세히
GET/v2/workspaces/{slug}/quota

워크스페이스 사용량 및 한도 조회

워크스페이스의 현재 사용량과 한도를 조회합니다.

파라미터

  • slug필수stringpath
    워크스페이스 슬러그입니다.

요청 예시

curl --request GET \
  --url "https://api.callabo.ai/v2/workspaces/your-workspace/quota" \
  --header "Accept: application/json" \
  --header "Authorization: Bearer $CALLABO_PAT"

성공 응답

응답 본문

  • plan필수ApiSubscriptionPlan
    현재 적용 중인 구독 플랜입니다.
  • code필수string
    구독 플랜 코드입니다.
  • plan필수string
    사람이 읽을 수 있는 구독 플랜 이름입니다.
  • usage_reset_cycle필수SubscriptionCycle
    포함 사용량이 초기화되는 주기입니다.
  • price필수ApiSubscriptionPlanPrice
    구독 플랜 가격 정보입니다.
  • included필수ApiSubscriptionPlanIncluded
    구독 플랜에 포함된 리소스 정보입니다.
  • features필수SubscriptionPlanFeature[]
    구독 플랜에서 활성화된 기능 목록입니다.
  • purchase_policy필수ApiSubscriptionPlanPurchasePolicy
    구독 플랜 구매 정책입니다.
  • usage_period필수ApiWorkspaceQuotaUsagePeriod
    현재 사용량 집계 기간입니다.
  • start_date필수string (date)
    사용량 집계 기간의 시작일입니다.
  • end_date필수string (date)
    사용량 집계 기간의 종료일입니다.
  • quota필수ApiWorkspaceQuotaMetrics
    현재 플랜이 제공하는 한도입니다.
  • seat필수integer
    아카이빙 멤버 수입니다.
  • viewer필수integer | null
    뷰어 멤버 수이며 제한이 없으면 null입니다.
  • recording_seconds필수number
    레코딩 시간(초)입니다.
  • usage필수ApiWorkspaceQuotaMetrics
    현재 집계된 사용량입니다.
  • seat필수integer
    아카이빙 멤버 수입니다.
  • viewer필수integer | null
    뷰어 멤버 수이며 제한이 없으면 null입니다.
  • recording_seconds필수number
    레코딩 시간(초)입니다.
  • remaining필수ApiWorkspaceQuotaMetrics
    현재 남은 한도입니다.
  • seat필수integer
    아카이빙 멤버 수입니다.
  • viewer필수integer | null
    뷰어 멤버 수이며 제한이 없으면 null입니다.
  • recording_seconds필수number
    레코딩 시간(초)입니다.
  • allows_overage필수boolean
    레코딩 한도 초과분을 후불로 사용할 수 있는지 여부입니다.
  • rate_limit필수ApiWorkspaceRateLimit
    v2 공개 API 요청 한도 정책입니다.
  • scopestring
    요청 한도를 적용하는 단위입니다.
  • limit필수integer
    고정 구간에서 허용하는 최대 요청 수입니다.
  • window_seconds필수integer
    요청 횟수를 집계하는 고정 구간의 길이(초)입니다.

응답 예시

{
  "plan": {
    "code": "string",
    "plan": "string",
    "usage_reset_cycle": "monthly",
    "price": {
      "base": 1,
      "seat": 1,
      "recording_minutes": 1
    },
    "included": {
      "seat": 1,
      "viewer": 1,
      "unlimited_viewer": true,
      "recording_minutes": 1,
      "labels": 1,
      "restricted_event_words": 1
    },
    "features": [
      "ai_recording"
    ],
    "purchase_policy": {
      "additional_seat": true
    }
  },
  "usage_period": {
    "start_date": "2026-08-27",
    "end_date": "2026-08-27"
  },
  "quota": {
    "seat": 1,
    "viewer": 1,
    "recording_seconds": 1
  },
  "usage": {
    "seat": 1,
    "viewer": 1,
    "recording_seconds": 1
  },
  "remaining": {
    "seat": 1,
    "viewer": 1,
    "recording_seconds": 1
  },
  "allows_overage": true,
  "rate_limit": {
    "scope": "workspace",
    "limit": 1,
    "window_seconds": 1
  }
}

오류

상태오류 코드설명
401UNAUTHORIZED인증되지 않은 요청
403FORBIDDEN요청자 권한 부족
404WORKSPACE_NOT_FOUND존재하지 않음
422VALIDATION_ERROR처리할 수 없는 콘텐츠
429RATE_LIMIT_EXCEEDED요청 한도 초과자세히
GET/v2/workspaces/{slug}

워크스페이스 상세 조회

슬러그에 해당하는 워크스페이스의 상세 정보를 조회합니다.

파라미터

  • slug필수stringpath
    워크스페이스 슬러그입니다.

요청 예시

curl --request GET \
  --url "https://api.callabo.ai/v2/workspaces/your-workspace" \
  --header "Accept: application/json" \
  --header "Authorization: Bearer $CALLABO_PAT"

성공 응답

응답 본문

  • id필수integer
    워크스페이스 식별자입니다.
  • slug필수string
    요청 경로에 사용하는 현재 워크스페이스 슬러그입니다.
  • name필수string
    워크스페이스 이름입니다.
  • emailstring | null
    워크스페이스 대표 이메일입니다.
  • billing_email필수string
    워크스페이스 결제 이메일입니다.
  • keywords필수string[]
    워크스페이스 기본 키워드 목록입니다.
  • color필수string
    워크스페이스 대표 색상입니다.
  • use_2fa필수boolean
    2단계 인증 사용 여부입니다.
  • ip_block_type필수IpBlockType
    워크스페이스 IP 접근 제한 방식입니다.
  • status필수WorkspaceStatus
    워크스페이스 상태입니다.
  • referrer_codestring | null
    워크스페이스 추천 코드입니다.
  • domains필수string[]
    워크스페이스에 등록된 이메일 도메인 목록입니다.
  • pat_enabled필수boolean
    개인 액세스 토큰으로 워크스페이스 범위 API를 호출할 수 있는지 여부입니다.
  • base_role필수BaseWorkspaceRole
    요청자의 워크스페이스 기본 역할입니다.
  • settings필수V2WorkspaceSettings
    워크스페이스의 레코드·보존 기본 설정입니다.
  • default_access_scope필수DefaultAccessScope
    새 레코드의 기본 접근 범위입니다.
  • default_transcribe_language필수TranscribeLanguage
    새 레코드의 기본 전사 언어입니다.
  • save_media필수boolean
    원본 미디어 저장 여부입니다.
  • save_dialog필수boolean
    대화록 저장 여부입니다.
  • provision_type필수ProvisionType
    멤버 프로비저닝 방식입니다.
  • max_device_session_countinteger | null
    멤버별 최대 기기 세션 수입니다.
  • request_insight_extract_type필수WorkspaceInsightExtractType
    기본 인사이트 생성 유형입니다.
  • default_custom_insight_template_idinteger | null
    기본 커스텀 인사이트 템플릿 식별자입니다.
  • record_lifecycle_daysinteger | null
    레코드 보존 일수입니다.
  • media_lifecycle_daysinteger | null
    원본 미디어 보존 일수입니다.
  • dialog_lifecycle_daysinteger | null
    대화록 보존 일수입니다.
  • created_at필수string (date-time)
    워크스페이스 생성 시각입니다.
  • updated_at필수string (date-time)
    워크스페이스 마지막 수정 시각입니다.

응답 예시

{
  "id": 1,
  "slug": "your-workspace",
  "name": "Example",
  "billing_email": "developer@example.com",
  "keywords": [
    "string"
  ],
  "color": "string",
  "use_2fa": true,
  "ip_block_type": "none",
  "status": "created",
  "domains": [
    "string"
  ],
  "pat_enabled": true,
  "base_role": "workspace_manager",
  "settings": {
    "default_access_scope": "all",
    "default_transcribe_language": "detect",
    "save_media": true,
    "save_dialog": true,
    "provision_type": "scim_auto",
    "request_insight_extract_type": "custom"
  },
  "created_at": "2026-08-27T03:00:00Z",
  "updated_at": "2026-08-27T03:00:00Z"
}

오류

상태오류 코드설명
401UNAUTHORIZED인증되지 않은 요청
403FORBIDDEN요청자 권한 부족
404WORKSPACE_NOT_FOUND존재하지 않음
422VALIDATION_ERROR처리할 수 없는 콘텐츠
429RATE_LIMIT_EXCEEDED요청 한도 초과자세히
© 2026 Return Zero, Inc.