Xiaoman (OKKI) · OAuth Scopes

Xiaoman (OKKI) OAuth Scopes

OAuth 2.0 searched

Xiaoman (OKKI) publishes 12 OAuth 2.0 scopes via the password and clientCredentials flows. Scopes are the fine-grained permissions an application requests at authorization time to act against the Xiaoman (OKKI) API on a user’s behalf.

Tokens are issued from https://api-sandbox.xiaoman.cn/v1/oauth2/access_token.

This index is generated from the provider’s OpenAPI security definitions (and, where available, its documented scope reference) and refreshes on every APIs.io network build. Browse every provider’s scopes at scopes.apis.io.

CompanyCRMForeign TradeB2BSalesProspectingEmail MarketingAI AgentsChinaAlibaba

Scopes: 12 Flows: password, clientCredentials Method: searched

OAuth endpoints

Token URL
https://api-sandbox.xiaoman.cn/v1/oauth2/access_token

Flows
passwordclientCredentials

Scopes (12)

Scope	Description	Flows
company	Customers / companies module (客户)
lead	Leads module (线索)
opportunity	Opportunities module (商机)
product	Products module (产品)
invoices	Sales orders, quotations, and cash-collection invoices (订单、报价单、回款单)
purchaseOrder	Purchase orders module (采购订单)
costInvoice	Cost invoices module (费用单)
paymentInvoice	Payment invoices module (付款单)
warehouse	Inventory / warehouse module (库存)
capitalAccount	Capital accounts module (资金账户)
user	Users and departments (用户列表)
webhook	Message push / webhook subscription module (消息推送)

📄 Provider scope reference: https://open.xiaoman.cn/api-3473041

Source

OAuth Scopes

generated: '2026-07-21'
method: searched
source: https://open.xiaoman.cn/api-3473041
docs: https://open.xiaoman.cn/api-3473041
description: >-
  Module scopes for the Xiaoman OKKI CRM Open API OAuth2 token endpoint
  (POST /v1/oauth2/access_token). The scope parameter is a space-separated
  list; a token can only call APIs of modules whose scope it carries
  (otherwise "no permission <module> scopes"). Each module's scope is also
  shown on the first page of that module's docs section.
schemes:
  - name: XiaomanOAuth2
    flows:
      - flow: password
        tokenUrl: https://api-sandbox.xiaoman.cn/v1/oauth2/access_token
      - flow: clientCredentials
        tokenUrl: https://api-sandbox.xiaoman.cn/v1/oauth2/access_token
scopes:
  - scope: company
    description: Customers / companies module (客户)
  - scope: lead
    description: Leads module (线索)
  - scope: opportunity
    description: Opportunities module (商机)
  - scope: product
    description: Products module (产品)
  - scope: invoices
    description: Sales orders, quotations, and cash-collection invoices (订单、报价单、回款单)
  - scope: purchaseOrder
    description: Purchase orders module (采购订单)
  - scope: costInvoice
    description: Cost invoices module (费用单)
  - scope: paymentInvoice
    description: Payment invoices module (付款单)
  - scope: warehouse
    description: Inventory / warehouse module (库存)
  - scope: capitalAccount
    description: Capital accounts module (资金账户)
  - scope: user
    description: Users and departments (用户列表)
  - scope: webhook
    description: Message push / webhook subscription module (消息推送)