Skip to content
Hyperproof API
/
/
Get Group

Groups API (1.0)

Provides access to the groups that are part of a Hyperproof organization.

Download OpenAPI description
groups.openapi.json
groups.openapi.yaml
Languages
Servers
Mock server
https://developer.hyperproof.app/_mock/hyperproof-api/groups/groups.openapi
Hyperproof US
https://api.hyperproof.app/v1/groups
Hyperproof Gov
https://api.hyperproofgov.app/v1/groups
Hyperproof EU
https://api.hyperproof.eu/v1/groups

Add Group

Request

POST /

Description

Creates a new group in Hyperproof, defining its name, description, and initial membership or permissions.

Security
oauth2
Bodyapplication/json
namestringrequired

The name of the group.

Example: "Compliance Managers"
groupLeadIdstring(uuid)

The unique identifier of the user who is designated as the group lead.

Example: "abcdef12-3456-7890-abcd-ef1234567890"
userIdsArray of strings

The list of unique identifiers of users who are in the group.

Example: ["195032c4-0a2b-4f3e-8d5f-1a2b3c4d5e6f","12345678-1234-5678-1234-123456789012"]
curl -i -X POST \
  https://developer.hyperproof.app/_mock/hyperproof-api/groups/groups.openapi/ \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "name": "Compliance Managers",
    "groupLeadId": "abcdef12-3456-7890-abcd-ef1234567890",
    "userIds": [
      "195032c4-0a2b-4f3e-8d5f-1a2b3c4d5e6f",
      "12345678-1234-5678-1234-123456789012"
    ]
  }'

Responses

Success.

Bodyapplication/json
idstring(uuid)

The unique identifier for the group.

Example: "abcdef12-3456-7890-abcd-ef1234567890"
orgIdstring(uuid)

The unique identifier for the organization the group belongs to.

Example: "12345678-1234-5678-1234-123456789012"
namestring

The name of the group.

Example: "Compliance Managers"
groupLeadIdstring(uuid)

The unique identifier of the user who is designated as the group lead.

Example: "876654321-1234-5678-8765-123456789012"
userIdsArray of strings

The list of unique identifiers of users who are in the group.

createdOnstring(date-time)

The date and time the group was created (ISO-8601 format).

Example: "2023-01-01T00:00:00Z"
updatedOnstring(date-time)

The date and time the group was last updated (ISO-8601 format).

Example: "2023-01-01T00:00:00Z"
Response
application/json
{
  "id": "abcdef12-3456-7890-abcd-ef1234567890",
  "orgId": "12345678-1234-5678-1234-123456789012",
  "name": "Compliance Managers",
  "groupLeadId": "876654321-1234-5678-8765-123456789012",
  "createdOn": "2023-01-01T00:00:00.0000000+00:00",
  "updatedOn": "2023-01-01T00:00:00.0000000+00:00"
}

Get Groups

Request

GET /

Description

Retrieves details of all groups within an organiztion, including their names, descriptions, and membership information.

Security
oauth2
Query
statusstring

Comma-separated list of statuses (only active by default). Supported values are active and archived.

expandstring

Comma separated list of fields to expand. Supported values: userIds.

curl -i -X GET \
  'https://developer.hyperproof.app/_mock/hyperproof-api/groups/groups.openapi/?status=string&expand=string' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>'

Responses

Success.

Bodyapplication/jsonArray [
idstring(uuid)

The unique identifier for the group.

Example: "abcdef12-3456-7890-abcd-ef1234567890"
orgIdstring(uuid)

The unique identifier for the organization the group belongs to.

Example: "12345678-1234-5678-1234-123456789012"
namestring

The name of the group.

Example: "Compliance Managers"
groupLeadIdstring(uuid)

The unique identifier of the user who is designated as the group lead.

Example: "876654321-1234-5678-8765-123456789012"
userIdsArray of strings

The list of unique identifiers of users who are in the group.

createdOnstring(date-time)

The date and time the group was created (ISO-8601 format).

Example: "2023-01-01T00:00:00Z"
updatedOnstring(date-time)

The date and time the group was last updated (ISO-8601 format).

Example: "2023-01-01T00:00:00Z"
]
Response
application/json
[
  {
    "id": "abcdef12-3456-7890-abcd-ef1234567890",
    "orgId": "12345678-1234-5678-1234-123456789012",
    "name": "Compliance Managers",
    "groupLeadId": "876654321-1234-5678-8765-123456789012",
    "createdOn": "2023-01-01T00:00:00.0000000+00:00",
    "updatedOn": "2023-01-01T00:00:00.0000000+00:00"
  }
]

Get Group

Request

GET /{groupId}

Description

Retrieves details of a specific group by its unique ID, including its name, description, and membership information.

Security
oauth2
Path
groupIdstringrequired

Unique ID of the group to retrieve.

curl -i -X GET \
  'https://developer.hyperproof.app/_mock/hyperproof-api/groups/groups.openapi/{groupId}' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>'

Responses

Success.

Bodyapplication/json
idstring(uuid)

The unique identifier for the group.

Example: "abcdef12-3456-7890-abcd-ef1234567890"
orgIdstring(uuid)

The unique identifier for the organization the group belongs to.

Example: "12345678-1234-5678-1234-123456789012"
namestring

The name of the group.

Example: "Compliance Managers"
groupLeadIdstring(uuid)

The unique identifier of the user who is designated as the group lead.

Example: "876654321-1234-5678-8765-123456789012"
userIdsArray of strings

The list of unique identifiers of users who are in the group.

createdOnstring(date-time)

The date and time the group was created (ISO-8601 format).

Example: "2023-01-01T00:00:00Z"
updatedOnstring(date-time)

The date and time the group was last updated (ISO-8601 format).

Example: "2023-01-01T00:00:00Z"
Response
application/json
{
  "id": "abcdef12-3456-7890-abcd-ef1234567890",
  "orgId": "12345678-1234-5678-1234-123456789012",
  "name": "Compliance Managers",
  "groupLeadId": "876654321-1234-5678-8765-123456789012",
  "createdOn": "2023-01-01T00:00:00.0000000+00:00",
  "updatedOn": "2023-01-01T00:00:00.0000000+00:00"
}

Update Group

Request

PATCH /{groupId}

Description

Updates the details of an existing group, allowing changes to its name, description, or membership configuration.

Security
oauth2
Path
groupIdstringrequired

Unique ID of the group to update.

Bodyapplication/json
namestring

The name of the group.

Example: "Compliance Managers"
groupLeadIdstring(uuid)

The unique identifier of the user who is designated as the group lead.

Example: "abcdef12-3456-7890-abcd-ef1234567890"
clearGroupLeadboolean

Clears the group lead if 'true'. If set, groupLeadId must not be set.

curl -i -X PATCH \
  'https://developer.hyperproof.app/_mock/hyperproof-api/groups/groups.openapi/{groupId}' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "name": "Compliance Managers",
    "groupLeadId": "abcdef12-3456-7890-abcd-ef1234567890",
    "clearGroupLead": false
  }'

Responses

Success.

Bodyapplication/json
idstring(uuid)

The unique identifier for the group.

Example: "abcdef12-3456-7890-abcd-ef1234567890"
orgIdstring(uuid)

The unique identifier for the organization the group belongs to.

Example: "12345678-1234-5678-1234-123456789012"
namestring

The name of the group.

Example: "Compliance Managers"
groupLeadIdstring(uuid)

The unique identifier of the user who is designated as the group lead.

Example: "876654321-1234-5678-8765-123456789012"
userIdsArray of strings

The list of unique identifiers of users who are in the group.

createdOnstring(date-time)

The date and time the group was created (ISO-8601 format).

Example: "2023-01-01T00:00:00Z"
updatedOnstring(date-time)

The date and time the group was last updated (ISO-8601 format).

Example: "2023-01-01T00:00:00Z"
Response
application/json
{
  "id": "abcdef12-3456-7890-abcd-ef1234567890",
  "orgId": "12345678-1234-5678-1234-123456789012",
  "name": "Compliance Managers",
  "groupLeadId": "876654321-1234-5678-8765-123456789012",
  "createdOn": "2023-01-01T00:00:00.0000000+00:00",
  "updatedOn": "2023-01-01T00:00:00.0000000+00:00"
}

Get All Group Members

Request

GET /users}

Description

Retrieves the members of groups in the organization.

Notes and caveats

Security
oauth2
Query
statusstring

Comma-separated list of statuses (only active by default). Supported values are active and archived.

curl -i -X GET \
  'https://developer.hyperproof.app/_mock/hyperproof-api/groups/groups.openapi/users?status=string' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>'

Responses

Success.

Bodyapplication/jsonArray [
groupIdstring(uuid)

The unique identifier of the group.

Example: "12345678-1234-5678-1234-123456789012"
userIdsArray of strings

The list of unique identifiers of users who are in the group.

Example: ["195032c4-0a2b-4f3e-8d5f-1a2b3c4d5e6f","12345678-1234-5678-1234-123456789012"]
]
Response
application/json
[
  {
    "id": "abcdef12-3456-7890-abcd-ef1234567890",
    "groupId": "12345678-1234-5678-1234-123456789012",
    "userIds": [ … ]
  }
]

Get Group Members

Request

GET /{groupId}

Description

Retrieves the members of a group.

Security
oauth2
Path
groupIdstringrequired

Unique ID of the group.

curl -i -X GET \
  'https://developer.hyperproof.app/_mock/hyperproof-api/groups/groups.openapi/{groupId}/users' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>'

Responses

Success.

Bodyapplication/json
groupIdstring(uuid)

The unique identifier of the group.

Example: "12345678-1234-5678-1234-123456789012"
userIdsArray of strings

The list of unique identifiers of users who are in the group.

Example: ["195032c4-0a2b-4f3e-8d5f-1a2b3c4d5e6f","12345678-1234-5678-1234-123456789012"]
Response
application/json
{
  "id": "abcdef12-3456-7890-abcd-ef1234567890",
  "groupId": "12345678-1234-5678-1234-123456789012",
  "userIds": [
    "195032c4-0a2b-4f3e-8d5f-1a2b3c4d5e6f",
    "12345678-1234-5678-1234-123456789012"
  ]
}

Add Group Member

Request

POST /{groupId}/users

Description

Adds a user to a specified group, granting them the roles and permissions associated with that group.

Security
oauth2
Path
groupIdstringrequired

Unique ID of the group.

Bodyapplication/json
userIdsArray of strings
Example: ["195032c4-0a2b-4f3e-8d5f-1a2b3c4d5e6f 12345678-1234-5678-1234-123456789012"]
curl -i -X POST \
  'https://developer.hyperproof.app/_mock/hyperproof-api/groups/groups.openapi/{groupId}/users' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "userIds": [
      "195032c4-0a2b-4f3e-8d5f-1a2b3c4d5e6f 12345678-1234-5678-1234-123456789012"
    ]
  }'

Responses

Success.

Bodyapplication/json
groupIdstring(uuid)

The unique identifier of the group.

Example: "12345678-1234-5678-1234-123456789012"
userIdsArray of strings

The list of unique identifiers of users who are in the group.

Example: ["195032c4-0a2b-4f3e-8d5f-1a2b3c4d5e6f","12345678-1234-5678-1234-123456789012"]
Response
application/json
{
  "id": "abcdef12-3456-7890-abcd-ef1234567890",
  "groupId": "12345678-1234-5678-1234-123456789012",
  "userIds": [
    "195032c4-0a2b-4f3e-8d5f-1a2b3c4d5e6f",
    "12345678-1234-5678-1234-123456789012"
  ]
}

Remove Group Members

Request

PUT /{groupId}/users/delete

Description

Removes one or more members from a specified group, updating the group’s membership and associated permissions.

Security
oauth2
Path
groupIdstringrequired

Unique ID of the group.

Bodyapplication/json
userIdsArray of strings
Example: ["195032c4-0a2b-4f3e-8d5f-1a2b3c4d5e6f 12345678-1234-5678-1234-123456789012"]
curl -i -X PUT \
  'https://developer.hyperproof.app/_mock/hyperproof-api/groups/groups.openapi/{groupId}/users/delete' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "userIds": [
      "195032c4-0a2b-4f3e-8d5f-1a2b3c4d5e6f 12345678-1234-5678-1234-123456789012"
    ]
  }'

Responses

Success.

Bodyapplication/json
groupIdstring(uuid)

The unique identifier of the group.

Example: "12345678-1234-5678-1234-123456789012"
userIdsArray of strings

The list of unique identifiers of users who are in the group.

Example: ["195032c4-0a2b-4f3e-8d5f-1a2b3c4d5e6f","12345678-1234-5678-1234-123456789012"]
Response
application/json
{
  "id": "abcdef12-3456-7890-abcd-ef1234567890",
  "groupId": "12345678-1234-5678-1234-123456789012",
  "userIds": [
    "195032c4-0a2b-4f3e-8d5f-1a2b3c4d5e6f",
    "12345678-1234-5678-1234-123456789012"
  ]
}
® 2026 Hyperproof All Rights Reserved.