Working with groups

This article walks you through the process of creating a new group, adding a user to the group, and getting a list of the group's users.

Getting Started

You will need the following tools and features:

1. Knowledge of using API key in FastReport Cloud.

   This article will skip additional information on authentication and authorization.

2. curl tool.

   Any other REST client will do, but the examples will be built for curl.

3. Active FastReport Cloud subscription that has two user slots.

4. Access to the Internet.

Comment

Note! It is only possible to add a user to a group if the user exists in the workspace.

Note! It is only possible to add a user to a group by its identifier.

Instruction

1. To create a new group, you need a workspace identifier and a name for the new group.

   Get the workspace identifier by making a GET request to https://fastreport.cloud/api/manage/v1/Subscriptions?skip=0&take=10.

   Request example.

   curl -X GET "https://fastreport.cloud/api/manage/v1/Subscriptions?skip=0&take=10" -H "accept: text/plain"
   

   Response example.

   {
     "subscriptions": [
       {
         "id": "5fa919fa292a8300019349bc",
         "name": "Awesome Corp",
         "current": {
           "startTime": "2020-11-17T10:22:58.584Z",
           "endTime": "2025-11-17T10:22:58.584Z",
           "plan": {
             "id": "5f43924b0231500001225686",
             "isActive": false,
             "displayName": "The greatest power",
             "timePeriodType": "Year",
             "timePeriod": 5,
             "readonlyTimeLimitType": "Second",
             "readonlyTimeLimit": 0,
             "templatesSpaceLimit": 1048576000,
             "reportsSpaceLimit": 1048576000,
             "exportsSpaceLimit": 1048576000,
             "fileUploadSizeLimit": 1048576000000,
             "dataSourceLimit": 10,
             "maxUsersCount": 10,
             "groupLimit": 5,
             "onlineDesigner": true,
             "isDemo": false,
             "urlToBuy": "https://fast-report.com/",
             "unlimitedPage": true,
             "pageLimit": 15
           }
         },
         "old": [],
         "templatesFolder": {
           "folderId": "5fa919f9292a8300019349b9",
           "bytesUsed": 1668491
         },
         "reportsFolder": {
           "folderId": "5fa919f9292a8300019349ba",
           "bytesUsed": 6085990
         },
         "exportsFolder": {
           "folderId": "5fa919fa292a8300019349bb",
           "bytesUsed": 8336710
         }
       }
     ],
     "count": 1,
     "skip": 0,
     "take": 10
   }
   

   The workspace (subscription) identifier from the example above is 5fa919fa292a8300019349bc.

2. 2. To create a new group, make a POST request to https://fastreport.cloud/api/manage/v1/Groups, pass JSON in the request body as shown below.

   {
     "name": "string",
     "subscriptionId": "string id"
   }
   

   Request example.

   curl -X POST "https://fastreport.cloud/api/manage/v1/Groups" -H "accept: text/plain" -H "Content-Type: application/json-patch+json" -d "{ \"name\": \"My first group\", \"subscriptionId\": \"5fa919fa292a8300019349bc\"}"
   

   Response example.

   {
     "id": "5fe5d7866882ca0001760fcb",
     "name": "My first group",
     "subscriptionId": "5fa919fa292a8300019349bc"
   }
   

   The group identifier from the example above is 5fe5d7866882ca0001760fcb.

3. 3. To add a new user to a group, make a PUT request to https://fastreport.cloud/api/manage/v1/Groups/{groupId}/Users/{userId}, instead of {groupId} enter the group identifier, and instead of {userId} enter the user identifier.

   Request example.

   curl -X PUT "https://fastreport.cloud/api/manage/v1/Groups/5fe5d7866882ca0001760fcb/Users/5af5a8dc-8cb0-40f9-ac99-ca2533fa4492" -H "accept: text/plain"
   

   The response will be an empty message with the OK 200.

4. 4. To get a list of users in a group, make a GET request to https://fastreport.cloud/api/manage/v1/Groups/{id}/Users?skip=0&take=10, where {id} should be replaced with the group identifier.

   Request example.

   curl -X GET "https://fastreport.cloud/api/manage/v1/Groups/5fe5d7866882ca0001760fcb/Users?skip=0&take=10" -H "accept: text/plain"
   

   Response example.

   {
     "users": [
       {
         "userId": "5af5a8dc-8cb0-40f9-ac99-ca2533fa4491",
         "userId": "5af5a8dc-8cb0-40f9-ac99-ca2533fa4492"
       }
     ],
     "count": 2,
     "take": 10,
     "skip": 0
   }
   

What's next?

• Help and feedback