QueryAppCommunityList

2026-07-06

GET

https://zim-api.zego.im/

Get the IDs of all communities in the App.

Note

The retrieved data may have a delay of up to 1 minute.

QPS Limit

1 time/s

Request

Query Parameters

Action stringrequired

Possible values: [QueryAppCommunityList]

API prototype parameter

https://zim-api.zego.im/?Action=QueryAppCommunityList

AppId uint32required

💡Public parameter. Application ID, assigned by ZEGOCLOUD. Get it from the ZEGOCLOUD Admin Console.

SignatureNonce stringrequired

💡Public parameter. A 16-character hexadecimal random string (hex encoding of 8-byte random number). Refer to Signature example for how to generate.

Timestamp int64required

💡Public parameter. Current Unix timestamp, in seconds. Refer to Signature example for how to generate, with a maximum error of 10 minutes.

SignatureVersion stringrequired

Possible values: [2.0]

Default value: 2.0

💡Public parameter. Signature version number.

Signature stringrequired

💡Public parameter. Signature, used to verify the legitimacy of the request. Refer to Signing the requests for how to generate an API request signature.

application/json

Body

Limit number

Possible values: >= 0 and <= 10000

The upper limit on the number of community IDs to retrieve this time, which must not exceed 10000. That is, calling this API returns a maximum of 10000 community IDs at a time.

When the number of communities in the App exceeds the Limit, you need to call this API multiple times and the Limit must remain consistent.

If it is empty or greater than 10000, the default value is 10000.

Next number

Pagination flag. Fill in 0 for the first time, and then fill in the value returned last time. When the returned Next is 0, it means the community list has been fully retrieved.

For example, if there are 25,000 communities in the App, when calling this API to query the community list:

First call: Set Limit to 10000 and Next to 0 to query communities 1 to 10000; the Next value in the returned result is 1.
Second call: Set Limit to 10000 and Next to 1 to query communities 10001 to 20000; the Next value in the returned result is 2.
Third call: Set Limit to 10000 and Next to 2 to query communities 20001 to 25000; the query is complete, and the Next value in the returned result is 0.

Responses

application/json

Schema
Example (from schema)
Example

Schema

Code number

Return code.

The following only lists the return codes related to the API business logic. For the complete return codes, please refer to Return codes.

Return code	Description	Suggested Solution
660000002	Parameter error.	Please refer to Request Parameters and enter the correct parameters.

Message string

Description of the request result.

RequestId string

Request ID.

TotalCount number

Current total number of communities in the App.

Next number

Pagination flag. When non-zero, it indicates that the list query is not complete.

Note

Apart from the above description, this field has no association with the list information. Please do not base any other logic on this field.

CommunityIdList object[]

Collection of retrieved community IDs.

Array[

CommunityId string

Community ID.

CommunityName string

Community name.

]

{
  "Code": 0,
  "Message": "success",
  "RequestId": "343649807833778782",
  "TotalCount": 1680,
  "Next": 2,
  "CommunityIdList": [
    {
      "CommunityId": "CommunityA",
      "CommunityName": "CommunityNameA"
    }
  ]
}

{
  "Code": 0,
  "Message": "success",
  "RequestId": "343649807833778782",
  "TotalCount": 1680,
  "Next": 2,
  "CommunityIdList": [
    {
      "CommunityId": "CommunityA",
      "CommunityName": "CommunityNameA"
    }
  ]
}

{
  "Code": 0,
  "Message": "success",
  "RequestId": "343649807833778782",
  "TotalCount": 1680,
  "Next": 2,
  "CommunityIdList": [
    {
      "CommunityId": "CommunityA",
      "CommunityName": "CommunityNameA"
    },
    {
      "CommunityId": "CommunityB",
      "CommunityName": "CommunityNameB"
    }
  ]
}

{
  "Code": 0,
  "Message": "success",
  "RequestId": "343649807833778782",
  "TotalCount": 1680,
  "Next": 2,
  "CommunityIdList": [
    {
      "CommunityId": "CommunityA",
      "CommunityName": "CommunityNameA"
    },
    {
      "CommunityId": "CommunityB",
      "CommunityName": "CommunityNameB"
    }
  ]
}