OpenMax
免费试用

Apps API · Organizations

Organizations: 5 个接口

← 全部分组

GET /api/v1/organizations

List my organizations

权限(scope): org:organization:read · 调用方式: appToken · operationId: list-my-organizations

Required app scope: org:organization:read.

Returns organizations the authenticated identity is a member of. Response wrapped in standard envelope.

参数

名字 位置 类型 必填 说明
page query integer (int32) Page number (default: 1)
page_size query integer (int32) Items per page (default: 20, max: 100)
order_by query string Sort expression, e.g. created_at:desc

回包

GET /api/v1/organizations/{org_id}

Get organization details

权限(scope): org:organization:read · 调用方式: appToken · operationId: get-organization

Required app scope: org:organization:read.

Returns detailed information about a specific organization. Response wrapped in standard envelope.

参数

名字 位置 类型 必填 说明
org_id path string (uuid) 是 Organization UUID

回包

PATCH /api/v1/organizations/{org_id}

Update organization info

权限(scope): org:organization:write · 调用方式: appToken · operationId: update-organization

Required app scope: org:organization:write.

Updates the organization's name, slug, or industry (industry / industry_other). Name / slug require the org.manage permission; industry / industry_other require org.industry (org-owner only for now). Response wrapped in standard envelope.

参数

名字 位置 类型 必填 说明
org_id path string (uuid) 是 Organization UUID

请求体

application/json · UpdateOrganizationRequestBody

字段 类型 必填 说明
industry string: retail_ecom, b2b_trade, content_media, consumer_brand, logistics, manufacturing, other Update the organization industry key. Switching to a value other than 'other' clears industry_other. Existing agents are not renamed.
industry_other string Update the free-text supplement; only valid when the resulting industry is 'other'. Blank clears it; omitted keeps the stored text while the industry stays 'other'.
name string Update organization name
slug string Update organization slug (globally unique)

回包

GET /api/v1/organizations/{org_id}/deletion-precheck

Read-only organization deletion precheck

权限(scope): org:organization:read · 调用方式: appToken · operationId: get-organization-deletion-precheck

Required app scope: org:organization:read.

Returns what deleting this Organization would affect — Agent count, conversation count, current subscription and credit balance — plus the per-participant impact breakdown and anything that currently blocks deletion. Strictly read-only: it creates no deletion Job, does not delete the Organization, does not deactivate the billing account and writes no participant deletion fence. Only the current org-owner may call it. Numbers that are unavailable are null; clients must render "unknown" rather than 0. Response wrapped in standard envelope.

参数

名字 位置 类型 必填 说明
org_id path string (uuid) 是 Organization UUID

回包

GET /api/v1/organizations/{org_id}/storage-quota

Get organization storage quota

权限(scope): org:organization:read · 调用方式: appToken · operationId: get-organization-storage-quota

Required app scope: org:organization:read.

参数

名字 位置 类型 必填 说明
org_id path string (uuid) 是

回包