Work with groups

This article describes how to create a new group, add a user to a group, and get a list of group members.

Getting started

You will need the following tools and features:

1. Knowledge on how to use API key in FastReport Corporate Server.

   This article does not include the information about authentication and authorization.

2. The curl tool.

   Any other REST client will work, however, the examples are provided for curl.

3. Active subscription for FastReport.Cloud with two slots for the user.

4. Internet access.

Remark

Please, note: It is possible to add a user to a group only if the user is member of the subscription.

Please, note: You can add a user to a group only by the identifier.

Instructions

1. To create a new group, you need a subscription identifier and the name of the new group.

   Get your subscription identifier by GET request to https://fastreport.cloud/api/manage/v1/Subscriptions?skip=0&take=10.

   A sample request.

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

   A sample response.

   {
     "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,
             "hasSpaceOverdraft": false,
             "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 subscription identifier from the example above is 5fa919fa292a8300019349bc.

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

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

   A sample request.

   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\"}"
   

   A sample response.

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

   The group identifier from the example above is 5fe5d7866882ca0001760fcb.

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

   A sample request.

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

   In response, you will receive an empty message with the code OK 200.

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, substituting {id} with the group identifier.

   A sample request.

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

   A sample response.

   {
     "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