> ## Documentation Index
> Fetch the complete documentation index at: https://docs.cocoondata.com/llms.txt
> Use this file to discover all available pages before exploring further.

# <access-service>/api/v1/organisations/{orgId}/groups/{groupId}/users

## URL structure&#x20;

```text theme={null}
https://access-service.xy-company.com/api/v1/organisations/{orgId}/groups/{groupId}/users
```

where `{orgId}` is the ID of an organisation and `{groupId}` is the ID of one of this organisation's clearances.

## Supported methods and overview&#x20;

* `GET` - retrieves a list of information for all [Covata users](/3.5/api/authentication-and-authorisation.md) who are currently members of a [clearance](/3.5/admin-org/managing-clearances.md) (specified by `groupId`) in an organisation (specified by `orgId`).

> [!NOTE]
>
> This method takes no parameters.

## Detailed description&#x20;

This API endpoint retrieves a list of information for all Covata users who are currently members of a clearance (specified by `groupId`) in an organisation (specified by `orgId`).

A clearance's ID can be obtained by calling the `GET` method of the [\<access-service>/api/v1/organisations/\{orgId}/groups](/3.5/api/access-service-api-v1-organisations-orgid-groups.md) API endpoint, which retrieves a list of information for all clearances in an organisation (specified by `orgId`).

## Supported roles and conditions&#x20;

This API endpoint supports requests utilising Covata user accounts with the following [roles](/3.5/admin-org/administering-users-within-an-organisation.md#an-organisation-users-roles) (as described in the [Organisation Administrator's Guide](/3.5/admin-org.md)) and conditions:

* [Organisation administrator](/3.5/admin-org/administering-users-within-an-organisation.md#organisation-administrator-role) - if this user is a member of the organisation specified by `{orgId}` in the request's URL.

The Covata Platform's resources available to one of these Covata users (above) is determined by the access token submitted in the [header](/3.5/api/access-service-api-v1-organisations-orgid-groups-groupid-users.md#access-service-api-v1-organisations-orgid-groups-groupid-users-required-headers) of requests to this endpoint.

## Required headers&#x20;

The appropriate access token as the `Bearer` token:

* `Authorisation: Bearer eyJhbGciOiJSUzI1NiJ9.eyJleHAiOjE0NjcwMTY2NjYsInVzZXJfbmFtZSI6ImFsZXgub...`

## Returns&#x20;

A JSON-formatted response containing the following members:

* **items** - .
* **email** - .
* **firstName** - .
* **lastName** - .
* **mfaEnabled** - .
* **id** - .
* **accountType** - .
* **organisations** - .
* **count** - .
* **offset** - . \

  **Example (response):**

  ```json theme={null}
  {
      "items": [{
          "email": "alex.originator@xy-company.com",
          "firstName": "Alex",
          "lastName": "Originator",
          "mfaEnabled": false,
          "id": "760757111507689472",
          "accountType": {
              "i18n": {
                  "code": "server.useraccounttype.local",
                  "arguments": []
              },
              "value": "LOCAL"
          },
          "organisations": [{
              "id": "760756644367081472",
              "name": "XY Company",
              "addressBookEnabled": false,
              "watermarkingEnabled": false,
              "plan": {
                  "id": "760757068528656384",
                  "name": "Staff Originators",
                  "description": "Staff members with the Originator role.",
                  "quota": 10240,
                  "default": true
              },
              "adminEmail": "",
              "organisationAlias": null,
              "userMessage": null,
              "supportUrl": "",
              "companyName": null,
              "legalUrl": null,
              "webappHelpUrl": null,
              "orgAdminHelpUrl": null,
              "privacyUrl": "",
              "securityRoles": [{
                  "i18n": {
                      "code": "db.securityroles.organisationadmin",
                      "arguments": []
                  },
                  "value": "ROLE_ORGANISATION_ADMIN"
              }, {
                  "i18n": {
                      "code": "db.securityroles.originator",
                      "arguments": []
                  },
                  "value": "ROLE_ORIGINATOR"
              }]
          }]
      }, {
          "email": "chris.collaborator@xy-company.com",
          "firstName": null,
          "lastName": null,
          "mfaEnabled": false,
          "id": "760765715686137856",
          "accountType": {
              "i18n": {
                  "code": "server.useraccounttype.local",
                  "arguments": []
              },
              "value": "LOCAL"
          },
          "organisations": [{
              "id": "760756644367081472",
              "name": "XY Company",
              "addressBookEnabled": false,
              "watermarkingEnabled": false,
              "plan": null,
              "adminEmail": "",
              "organisationAlias": null,
              "userMessage": null,
              "supportUrl": "",
              "companyName": null,
              "legalUrl": null,
              "webappHelpUrl": null,
              "orgAdminHelpUrl": null,
              "privacyUrl": "",
              "securityRoles": [{
                  "i18n": {
                      "code": "db.securityroles.collaborator",
                      "arguments": []
                  },
                  "value": "ROLE_COLLABORATOR"
              }]
          }]
      }, {
          "email": "org.administrator@xy-company.com",
          "firstName": "Org",
          "lastName": "Administrator",
          "mfaEnabled": false,
          "id": "760756646413901824",
          "accountType": {
              "i18n": {
                  "code": "server.useraccounttype.local",
                  "arguments": []
              },
              "value": "LOCAL"
          },
          "organisations": [{
              "id": "760756644367081472",
              "name": "XY Company",
              "addressBookEnabled": false,
              "watermarkingEnabled": false,
              "plan": null,
              "adminEmail": "",
              "organisationAlias": null,
              "userMessage": null,
              "supportUrl": "",
              "companyName": null,
              "legalUrl": null,
              "webappHelpUrl": null,
              "orgAdminHelpUrl": null,
              "privacyUrl": "",
              "securityRoles": [{
                  "i18n": {
                      "code": "db.securityroles.organisationadmin",
                      "arguments": []
                  },
                  "value": "ROLE_ORGANISATION_ADMIN"
              }]
          }]
      }],
      "count": "3",
      "offset": "0"
  }
  ```


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.