Get Groups in Space

Last Updated on : 2024-06-29 02:11:00download

Based on the space ID, get a list of groups in the specified space.

API address

GET: /v2.1/cloud/thing/group

Request parameter

Parameter name	Type	IN	Required	Description
space_id	String	query	true	The ID of the specified space.
page_no	Integer	query	true	The current page number.
page_size	Integer	query	true	The number of entries to be returned per page.

Return parameter

Parameter name	Type	Description
result	JsonObject	The returned result of the specified group.
success	Boolean	Indicates whether the API is called successfully. Valid values: `true`: The API call succeeded. `false`: The API call failed.
t	Long	The timestamp.
tid	String	The link ID.

Description of result

Parameter name	Type	Description
data_list	List	The list of data.
count	Integer	The total number of returned entries.
page_size	Integer	The number of entries to be returned per page.
page_no	Integer	The current page number.

Description of data_list

Parameter name	Type	Description
group_id	Long	The group ID.
group_name	String	The name of the specified group.
space_id	String	The ID of the space to which the specified group belongs.
icon_url	String	The icon of the specified group. A product picture is used by default.
create_time	Long	The time when a group is created.
update_time	Long	The time when a group is updated.

Request example

GET: /v2.1/cloud/thing/group?page_no=1&page_size=10&space_id=16702****

Return example

{
    "tid": "3d9023fc021911efbe7a366d87620758",
    "result": {
        "data_list": [
            {
                "icon_url": "https://images.tuyacn.com/smart/solution/142004/673976648441****.png",
                "create_time": 1713944885,
                "group_name": "testUpdateGroup****",
                "update_time": 1713944885,
                "group_id": "1393****",
                "space_id": "16702****"
            }
        ],
        "count": 1,
        "page_no": 1,
        "page_size": 10
    },
    "t": 1713949290836,
    "success": true
}

Error code

For more information, see error code.

Limits on API Request Frequency

For more information, see Limits on API Request Frequency.

Prev DocQuery Group Properties

Next DocAdd Devices