CallaboDevelopersBeta
문서 메뉴

REST API

역할

워크스페이스 역할과 팀 역할의 상세 정보와 권한을 조회합니다.

GET/v2/workspaces/{slug}/workspace-roles

워크스페이스 역할 목록 조회

워크스페이스 역할 목록과 역할별 멤버 수를 페이지 단위로 조회합니다.

파라미터

  • slug필수stringpath
    워크스페이스 슬러그입니다.
  • offsetintegerquery기본값 0
    첫 번째 반환 항목의 0부터 시작하는 오프셋입니다.
  • limitintegerquery기본값 100
    반환할 최대 항목 수입니다.

요청 예시

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

성공 응답

응답 본문

  • items필수V2WorkspaceRole[]
    워크스페이스 커스텀 역할 목록입니다.
  • id필수integer
    워크스페이스 커스텀 역할 식별자입니다.
  • name필수string
    워크스페이스 커스텀 역할 이름입니다.
  • descriptionstring | null
    워크스페이스 커스텀 역할 설명입니다.
  • is_system_role필수boolean
    시스템이 관리하는 역할인지 여부입니다.
  • member_count필수integer
    역할이 부여된 멤버 수입니다.
  • created_at필수string (date-time)
    역할 생성 시각입니다.
  • updated_at필수string (date-time)
    역할 마지막 수정 시각입니다.
  • permissions필수V2Permission[]
    워크스페이스 커스텀 역할 권한 목록입니다.
  • page필수V2Pagination
    워크스페이스 커스텀 역할 목록 페이지 정보입니다.
  • offset필수integer
    첫 번째 반환 항목의 0부터 시작하는 오프셋입니다.
  • limit필수integer
    요청한 최대 항목 수입니다.
  • total필수integer
    조건에 맞는 전체 항목 수입니다.

응답 예시

{
  "items": [
    {
      "id": 1,
      "name": "Example",
      "is_system_role": true,
      "member_count": 1,
      "created_at": "2026-08-27T03:00:00Z",
      "updated_at": "2026-08-27T03:00:00Z",
      "permissions": [
        {
          "resource": "member_management",
          "effect": "allow"
        }
      ]
    }
  ],
  "page": {
    "offset": 1,
    "limit": 1,
    "total": 1
  }
}

오류

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

워크스페이스 역할 상세 조회

워크스페이스 역할의 권한과 할당된 멤버 수를 조회합니다.

파라미터

  • role_id필수integerpath
    역할 식별자입니다.
  • slug필수stringpath
    워크스페이스 슬러그입니다.

요청 예시

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

성공 응답

응답 본문

  • id필수integer
    워크스페이스 커스텀 역할 식별자입니다.
  • name필수string
    워크스페이스 커스텀 역할 이름입니다.
  • descriptionstring | null
    워크스페이스 커스텀 역할 설명입니다.
  • is_system_role필수boolean
    시스템이 관리하는 역할인지 여부입니다.
  • member_count필수integer
    역할이 부여된 멤버 수입니다.
  • created_at필수string (date-time)
    역할 생성 시각입니다.
  • updated_at필수string (date-time)
    역할 마지막 수정 시각입니다.
  • permissions필수V2Permission[]
    워크스페이스 커스텀 역할 권한 목록입니다.
  • resource필수PermissionResource
    권한을 적용할 리소스입니다.
  • effect필수PermissionStatus
    리소스에 적용할 허용 또는 거부 상태입니다.

응답 예시

{
  "id": 1,
  "name": "Example",
  "is_system_role": true,
  "member_count": 1,
  "created_at": "2026-08-27T03:00:00Z",
  "updated_at": "2026-08-27T03:00:00Z",
  "permissions": [
    {
      "resource": "member_management",
      "effect": "allow"
    }
  ]
}

오류

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

팀 역할 목록 조회

팀 역할 목록과 권한을 페이지 단위로 조회합니다.

파라미터

  • slug필수stringpath
    워크스페이스 슬러그입니다.
  • offsetintegerquery기본값 0
    첫 번째 반환 항목의 0부터 시작하는 오프셋입니다.
  • limitintegerquery기본값 100
    반환할 최대 항목 수입니다.

요청 예시

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

성공 응답

응답 본문

  • items필수V2TeamRole[]
    팀 커스텀 역할 목록입니다.
  • id필수integer
    팀 커스텀 역할 식별자입니다.
  • name필수string
    팀 커스텀 역할 이름입니다.
  • descriptionstring | null
    팀 커스텀 역할 설명입니다.
  • is_system_role필수boolean
    시스템이 관리하는 역할인지 여부입니다.
  • permissions필수V2Permission[]
    팀 커스텀 역할 권한 목록입니다.
  • page필수V2Pagination
    팀 커스텀 역할 목록 페이지 정보입니다.
  • offset필수integer
    첫 번째 반환 항목의 0부터 시작하는 오프셋입니다.
  • limit필수integer
    요청한 최대 항목 수입니다.
  • total필수integer
    조건에 맞는 전체 항목 수입니다.

응답 예시

{
  "items": [
    {
      "id": 1,
      "name": "Example",
      "is_system_role": true,
      "permissions": [
        {
          "resource": "member_management",
          "effect": "allow"
        }
      ]
    }
  ],
  "page": {
    "offset": 1,
    "limit": 1,
    "total": 1
  }
}

오류

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

팀 역할 상세 조회

팀 역할의 상세 정보와 권한을 조회합니다.

파라미터

  • role_id필수integerpath
    역할 식별자입니다.
  • slug필수stringpath
    워크스페이스 슬러그입니다.

요청 예시

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

성공 응답

응답 본문

  • id필수integer
    팀 커스텀 역할 식별자입니다.
  • name필수string
    팀 커스텀 역할 이름입니다.
  • descriptionstring | null
    팀 커스텀 역할 설명입니다.
  • is_system_role필수boolean
    시스템이 관리하는 역할인지 여부입니다.
  • permissions필수V2Permission[]
    팀 커스텀 역할 권한 목록입니다.
  • resource필수PermissionResource
    권한을 적용할 리소스입니다.
  • effect필수PermissionStatus
    리소스에 적용할 허용 또는 거부 상태입니다.

응답 예시

{
  "id": 1,
  "name": "Example",
  "is_system_role": true,
  "permissions": [
    {
      "resource": "member_management",
      "effect": "allow"
    }
  ]
}

오류

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