List Units under the Role

This article provides an example of calling the List Units under the Role API.

tip

This API is only available for spaces on the enterprise plan.(Learn more).
Only the primary admin and sub-admins who can manage roles can use this API.

Example: Get the list of members and teams with the specific role

A role contains members and teams that have the same functionality.

For example, the role named "product manager" contains the product management team and members who are product managers, learn more about Role

Suppose you have a space and want to get the list of all members and teams in the "Product designer" role.

Follow these steps:

Get your API Token. (How to get it)
Get your Space ID. (How to get it)
Get the unitId of the "Product designer" role (How to get it)
What is unitId?
Open the terminal on your computer and execute the following code to send a query request to the server (assuming the spaceId is spcjXzqVrjaP3 and the unitId of "Product designer" role is bV1wL8uG5iZnXz9xR7rMjYsKfPpTcHq):
- cURL
curl -X GET \ "https://aitable.ai/fusion/v1/spaces/spcjXzqVrjaP3/roles/bV1wL8uG5iZnXz9xR7rMjYsKfPpTcHq/units" \ -H "Authorization: Bearer {Your API Token}"

The server will return the following JSON data. The data under "data" is the members and teams data under the role:

For the meaning of each parameter in the response, please check the API Reference.

{
  "code": 200,
  "message": "SUCCESS",
  "success": true,
  "data": {
    "members": [
       {
         "unitId": "K2QmXjH1tLzSsZbYyVWv6gUoP9wN7pC",
         "name": "John",
         "mobile": {
             "number": "14567890123",
             "areaCode": "+86"
         }
         "email": "test3@aitable.ai",
         "avatar": "https://s1.aitable.ai/public/2023/05/16/00a91wbb47fd0594fbc975d2d764a45q",
         "status": 1,
         "type": "Member",
         "teams": [{
             "unitId": "aDfT7yGpJ5rVcN2xZ8nQzKuWkMl4SbH",
             "name": "Product team",
             "sequence": 3,
             "parentUnitId": "0"
         }],
         "roles": [{
             "unitId": "bV1wL8uG5iZnXz9xR7rMjYsKfPpTcHq",
             "name": "Product designer",
             "sequence": 1         
         }]
       }
     ],
     "teams": [
     {
       "unitId": "VS1SejiywaMWbiGMEHAohh62T9EPmmlh",
       "name": "team A",
       "sequence": 1,
       "parentUnitId": "0",
       "roles": [
         {
             "unitId": "bV1wL8uG5iZnXz9xR7rMjYsKfPpTcHq",
             "name": "Product designer",
             "sequence": 1
         }
       ]
     },
     {
       "unitId": "bG9xSdV1fR6pMlN2tJyXkZzW5TjHcK4",
       "name": "team B",
       "sequence": 2,
       "parentUnitId": "0",
       "roles": [
         {
             "unitId": "bV1wL8uG5iZnXz9xR7rMjYsKfPpTcHq",
             "name": "Product designer",
             "sequence": 1
         }
       ]
     }
   ]
  }
}

Example: Get the list of members and teams with the specific role​

Example: Get the list of members and teams with the specific role