Query Group Details

Last Updated on : 2024-06-29 02:36:07download

Get the details of the specified group based on the group ID.

API address

GET: /v2.1/cloud/thing/group/{group_id}

Request parameter

Parameter name	Type	IN	Required	Description
group_id	Long	path	true	The group ID.

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
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/1393****

Return example

{
    "tid": "aa3d8de4021411efbe7a366d87620758",
    "result": {
        "icon_url": "https://images.tuyacn.com/smart/solution/142004/673976648441****.png",
        "create_time": 1713944884506,
        "group_name": "testGroup****",
        "update_time": 1713944884506,
        "group_id": 13930342,
        "space_id": "16702****"
    },
    "t": 1713947325181,
    "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 DocSend Group Properties

Next DocAdvanced Device Services