Query Organization Member

Last Updated on : 2022-09-22 09:32:29download

Querying the members of an organization returns a list of members.

API address

GET: /v1.0/iot-02/community/structure/members

Request parameter

Parameter nameTypeINRequiredDescription
structure_idStringquerytrueThe ID of a specified organization.
page_noIntegerquerytrueThe current page number.
page_sizeIntegerquerytrueThe paging size.

Return parameter

Parameter nameTypeDescription
resultHighwayStructureMembersListResponseThe list of returned results.

Description of result

Parameter nameTypeDescription
dataListThe returned data.
total_countIntegerThe total items.

Description of data

Parameter nameTypeDescription
structure_idStringThe ID of a specified organization.
structure_nameStringThe name of a specified organization.
admin_idStringThe ID of a specified member.
admin_nameStringThe name of a specified member.
role_infosListThe list of roles.
mobileStringThe phone number.
blocksListThe list of projects.
account_statusIntegerAccount status. 1: enabled, 2: disabled.
sexIntegerGender. 1: male, 2: female.

Description of role_infos

Parameter nameTypeDescription
role_idStringThe ID of a specified role.
role_nameStringThe name of a specified role.

Description of blocks

Parameter nameTypeDescription
block_idStringThe ID of the project.
block_nameStringThe name of the project.
related_structure_nameStringThe name of a specified organization.

Request example

GET: /v1.0/iot-02/community/structure/members?structure_id=137209008422933xxxx&page_no=1&page_size=20

Return example

    "roleInfos": [
            "roleId": "139066188980085xxxx",
            "roleName": "test"
    "blocks": [
            "blockName": "Test Project",
            "blockId": "138439127854128xxxx"
            "blockName": "Test Project",
            "blockId": "138443886026776xxxx"
    "myself": 2,
    "sex": 1,
    "mobile": "1368570xxxx",
    "admin": 2,
    "structureId": "138228055157827xxxx",
    "totalCount": 1,
    "accountStatus": 3,
    "adminName": "Administrator",
    "adminId": "139088092343572xxxx"

Error code

For more information, see error code.