Members API - Qoder CN

Endpoints for querying organization members, updating their roles, and managing member statistics and quotas.

List members

GET /v1/organizations/{org_id}/members

Query parameters:

Parameter	Type	Description
`userId`	string	Exact user UUID lookup; cannot be combined with `email`
`email`	string	Exact match on email address
`includeDeleted`	boolean	Include deleted members; defaults to `false`
`maxResults`	integer	Items per page; default 20, max 100
`nextToken`	string	Pagination cursor

userId must be a non-empty standard UUID. Exact lookup by userId or email returns at most one member and does not return a new nextToken. If no member matches, the API returns 200 OK with an empty members array. Request example:

curl -X GET "https://api.qoder.com.cn/v1/organizations/org_xxx/members?maxResults=10" \
  -H "Authorization: Bearer <api_key>"

Response example:

{
  "members": [
    {
      "id": "member_001",
      "userId": "550e8400-e29b-41d4-a716-446655440000",
      "email": "user@example.com",
      "name": "Alice Zhang",
      "role": "org_member",
      "status": "ENABLED",
      "joinedAt": "2025-01-10T08:00:00Z"
    }
  ],
  "maxResults": 10,
  "nextToken": "token_abc"
}

Member status values

Status	Description
`ENABLED`	Active
`DISABLED`	Disabled
`UNACTIVATED`	Not yet activated
`APPROVE_PENDING`	Pending approval
`APPROVE_DECLINED`	Approval declined
`DELETED`	Deleted

Get member details

GET /v1/organizations/{org_id}/members/{member_id}

Request example:

curl -X GET "https://api.qoder.com.cn/v1/organizations/org_xxx/members/member_001" \
  -H "Authorization: Bearer <api_key>"

Response example:

{
  "id": "member_001",
  "userId": "550e8400-e29b-41d4-a716-446655440000",
  "email": "user@example.com",
  "name": "Alice Zhang",
  "role": "org_member",
  "status": "ENABLED",
  "joinedAt": "2025-01-10T08:00:00Z"
}

Create a member

POST /v1/organizations/{org_id}/members

Create a new user and add the user to the organization. This endpoint creates new accounts only. If the email is already registered, the existing account is not reused and its password is not changed. Request body:

{
  "email": "user@example.com",
  "name": "Alice Zhang",
  "password": "StrongPassword123!",
  "role": "org_member"
}

Field	Type	Required	Description
`email`	string	Yes	New user email. Its domain must be verified and enabled for the organization
`name`	string	Yes	User and member display name
`password`	string	Yes	Initial password. It must meet the password-strength requirements and is never returned
`role`	string	No	`org_member` or `org_admin`; defaults to `org_member`

Request example:

curl -X POST "https://api.qoder.com.cn/v1/organizations/org_xxx/members" \
  -H "Authorization: Bearer <api_key>" \
  -H "Content-Type: application/json" \
  -d '{"email":"user@example.com","name":"Alice Zhang","password":"StrongPassword123!","role":"org_member"}'

Response example:

{
  "member": {
    "id": "member_001",
    "userId": "550e8400-e29b-41d4-a716-446655440000",
    "email": "user@example.com",
    "name": "Alice Zhang",
    "role": "org_member",
    "status": "ENABLED",
    "joinedAt": "2026-05-23T08:00:00Z"
  }
}

The endpoint may return InvalidParameter, InvalidPassword, InvalidRole, EmailDomainRequired, EmailDomainNotSupported, or InsufficientSeats (HTTP 400), or EmailAlreadyExists (HTTP 409).

Member statistics

GET /v1/organizations/{org_id}/members/statistics

Request example:

curl -X GET "https://api.qoder.com.cn/v1/organizations/org_xxx/members/statistics" \
  -H "Authorization: Bearer <api_key>"

Response example:

{
  "totalMembers": 50,
  "billableMembers": 45,
  "adminMembers": 3,
  "purchasedSeats": 60,
  "remainingSeats": 15
}

Field	Description
`totalMembers`	Total number of members
`billableMembers`	Number of billable members
`adminMembers`	Number of administrators
`purchasedSeats`	Total purchased seats
`remainingSeats`	Available seats

Delete a member

DELETE /v1/organizations/{org_id}/members/{member_id}

Request example:

curl -X DELETE "https://api.qoder.com.cn/v1/organizations/org_xxx/members/member_001" \
  -H "Authorization: Bearer <api_key>"

Returns HTTP 204 No Content on success.

Get member quota

GET /v1/organizations/{org_id}/members/{member_id}/quota

Request example:

curl -X GET "https://api.qoder.com.cn/v1/organizations/org_xxx/members/member_001/quota" \
  -H "Authorization: Bearer <api_key>"

Response example:

{
  "planQuota": 1000,
  "resourcePackageQuota": 500,
  "totalQuota": 1500,
  "sharedQuota": 200
}

Field	Description
`planQuota`	Quota from the subscription plan
`resourcePackageQuota`	Quota from resource packages
`totalQuota`	Total available quota
`sharedQuota`	Shared pool quota

Batch get member quotas

POST /v1/organizations/{org_id}/members/batchGetQuota

Request body:

{
  "memberIds": ["member_001", "member_002", "member_003"]
}

memberIds: Array of member IDs (1–100 items).

Request example:

curl -X POST "https://api.qoder.com.cn/v1/organizations/org_xxx/members/batchGetQuota" \
  -H "Authorization: Bearer <api_key>" \
  -H "Content-Type: application/json" \
  -d '{"memberIds": ["member_001", "member_002"]}'

Response example:

{
  "quotas": [
    {
      "memberId": "member_001",
      "planQuota": 1000,
      "resourcePackageQuota": 500,
      "totalQuota": 1500,
      "sharedQuota": 200
    },
    {
      "memberId": "member_002",
      "planQuota": 1000,
      "resourcePackageQuota": 0,
      "totalQuota": 1000,
      "sharedQuota": 200
    }
  ]
}

Update member Add-On Cap

PUT /v1/organizations/{org_id}/members/{member_id}/addon-cap

Request body:

{
  "addOnCap": 500
}

addOnCap accepts a non-negative integer, null, or omission. null or omission means unlimited; 0 disables the quota. Request example:

curl -X PUT "https://api.qoder.com.cn/v1/organizations/org_xxx/members/member_001/addon-cap" \
  -H "Authorization: Bearer <api_key>" \
  -H "Content-Type: application/json" \
  -d '{"addOnCap": 500}'

Response example:

{
  "memberId": "member_001",
  "email": "user@example.com",
  "addOnCap": 500
}

Batch update Add-On Cap

POST /v1/organizations/{org_id}/batchUpdateAddOnCap

Request body:

{
  "addOnCap": 500,
  "memberIds": ["member_001", "member_002"]
}

Each request accepts 1–100 non-empty member IDs and applies the same cap to every member. addOnCap accepts a non-negative integer, null, or omission; null or omission means unlimited. Request example:

curl -X POST "https://api.qoder.com.cn/v1/organizations/org_xxx/batchUpdateAddOnCap" \
  -H "Authorization: Bearer <api_key>" \
  -H "Content-Type: application/json" \
  -d '{"addOnCap": 500, "memberIds": ["member_001", "member_002"]}'

Response example:

{
  "members": [
    { "memberId": "member_001", "previousAddOnCap": 300 },
    { "memberId": "member_002" }
  ]
}

previousAddOnCap is omitted when the member was previously unlimited. Request validation may return InvalidBatchAddOnCapRequest, EmptyMemberIDs, TooManyMemberIDs, EmptyMemberIDAtIndex, or InvalidAddOnCapFormat.

Update member role

PUT /v1/organizations/{organization_id}/members/{member_id}/role Set an organization member’s role to Organization Admin, Organization Member, Config Admin, or Directory. Available for CN / Global and Teams / Enterprise, using the same IAM role-change capability as the dashboard.

Authentication and permissions

Use the target organization’s API key: Authorization: Bearer <api_key>. The key must belong to the organization in the path. Service account credentials cannot call this endpoint. The member_id must belong to that organization.

Path parameters

Parameter	Type	Required	Description
`organization_id`	string	Yes	Organization ID
`member_id`	string	Yes	Member ID returned by a member query endpoint; this is not the user ID

Request body

{
  "role": "org_admin"
}

Field	Type	Required	Description
`role`	string	Yes	`org_admin`: Organization Admin; `org_member`: Organization Member; `org_config_admin`: Config Admin; `org_directory`: Directory

role cannot be omitted, null, or an empty string. The deprecated org_free_member and other roles are not supported. Setting a non-billable role again still triggers IAM entitlement reclamation and can retry an incomplete reclamation.

Success response (200 OK)

Returns the updated member details directly, using the same fields as the get member details endpoint.

{
  "id": "member_abc123",
  "userId": "550e8400-e29b-41d4-a716-446655440000",
  "name": "Alice",
  "email": "alice@example.com",
  "role": "org_admin",
  "status": "ENABLED",
  "joinedAt": "2026-09-01T08:00:00Z"
}

Business restrictions

At least one administrator (Organization Admin or Config Admin) must remain. Role transitions use the same IAM validation as the dashboard.
Removed members cannot change roles; IAM rejects other unavailable member states.
Role changes are prohibited while a Teams-to-Enterprise upgrade is pending activation.
New assignments of Config Admin or Directory require the DirectoryRole rollout to be enabled for the organization; otherwise, the endpoint returns 403. Both are non-billable roles. Switching to them uses the IAM flow to release seats, remove billing entitlements, and revoke sessions. Switching back to a billable role requires an available seat; failures use the IAM compensation flow. Special-account restrictions match the dashboard.

Error responses

Error code	HTTP status	Description
`BadRequest`	400	Malformed request body, invalid member ID, or member state does not allow changes
`InvalidRole`	400	Role is missing or unsupported
`OrgMemberAdminCountLacked`	400	Cannot remove the last administrator role
`OrganizationPendingUpgrade`	400	Organization is awaiting activation of a Teams-to-Enterprise upgrade
`Unauthorized`	401	Missing or invalid credentials
`Forbidden`	403	Credentials lack permission, or the new role is not enabled for the organization
`UserNotTeamMember`	404	Member does not exist, was removed, or belongs to a different organization
`InternalError`	500	Internal service error

Other IAM business errors use the standard OpenAPI error response with requestId, code, and message.

{
  "requestId": "req_abc123",
  "code": "InvalidRole",
  "message": "role must be org_admin, org_member, org_config_admin or org_directory"
}

Request example

curl -X PUT 'https://api.qoder.com.cn/v1/organizations/org_xxx/members/member_abc123/role' \
  -H 'Authorization: Bearer <api_key>' \
  -H 'Content-Type: application/json' \
  -d '{"role":"org_member"}'

​List members

​Member status values

​Get member details

​Create a member

​Member statistics

​Delete a member

​Get member quota

​Batch get member quotas

​Update member Add-On Cap

​Batch update Add-On Cap

​Update member role

​Authentication and permissions

​Path parameters

​Request body

​Success response (200 OK)

​Business restrictions

​Error responses

​Request example

List members

Member status values

Get member details

Create a member

Member statistics

Delete a member

Get member quota

Batch get member quotas

Update member Add-On Cap

Batch update Add-On Cap

Update member role

Authentication and permissions

Path parameters

Request body

Success response (200 OK)

Business restrictions

Error responses

Request example