Visit our website

User Groups

User Groups are collections of users, which facilitate task assignment and task completion priviledges in Validere.

https://api.validere.io/app

Create a User Group

Create a user group

post
Body
namestringOptional
descriptionstringOptional
group_category_idstring · uuidOptional
Responses
200

A successful operation

application/json
Responseall of
and
post
POST /app/v1/user_groups HTTP/1.1
Host: api.validere.io
Content-Type: application/json
Accept: */*
Content-Length: 95

{
  "name": "text",
  "description": "text",
  "group_category_id": "123e4567-e89b-12d3-a456-426614174000"
}
200

A successful operation

{
  "name": "text",
  "description": "text",
  "group_category_id": "123e4567-e89b-12d3-a456-426614174000",
  "created_at": "2025-08-19T00:27:36.066Z",
  "updated_at": "2025-08-19T00:27:36.066Z",
  "created_by": "123e4567-e89b-12d3-a456-426614174000",
  "updated_by": "123e4567-e89b-12d3-a456-426614174000",
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "company_id": "123e4567-e89b-12d3-a456-426614174000"
}

Delete a User Group

Delete a user group

delete
Path parameters
user_group_idstring · uuidRequired

User Group ID

Responses
200

successful operation

delete
DELETE /app/v1/user_groups/{user_group_id} HTTP/1.1
Host: api.validere.io
Accept: */*
200

successful operation

No content

Update a User Group

Update a user group

put
Path parameters
user_group_idstring · uuidRequired

User Group ID

Body
namestringOptional
descriptionstringOptional
group_category_idstring · uuidOptional
Responses
200

A successful operation

application/json
Responseall of
and
put
PUT /app/v1/user_groups/{user_group_id} HTTP/1.1
Host: api.validere.io
Content-Type: application/json
Accept: */*
Content-Length: 95

{
  "name": "text",
  "description": "text",
  "group_category_id": "123e4567-e89b-12d3-a456-426614174000"
}
200

A successful operation

{
  "name": "text",
  "description": "text",
  "group_category_id": "123e4567-e89b-12d3-a456-426614174000",
  "created_at": "2025-08-19T00:27:36.066Z",
  "updated_at": "2025-08-19T00:27:36.066Z",
  "created_by": "123e4567-e89b-12d3-a456-426614174000",
  "updated_by": "123e4567-e89b-12d3-a456-426614174000",
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "company_id": "123e4567-e89b-12d3-a456-426614174000"
}

Get a User Group

Get a user group

get
Path parameters
user_group_idstring · uuidRequired

User Group ID

Responses
200

A successful operation

application/json
Responseall of
and
get
GET /app/v1/user_groups/{user_group_id} HTTP/1.1
Host: api.validere.io
Accept: */*
200

A successful operation

{
  "name": "text",
  "description": "text",
  "group_category_id": "123e4567-e89b-12d3-a456-426614174000",
  "created_at": "2025-08-19T00:27:36.066Z",
  "updated_at": "2025-08-19T00:27:36.066Z",
  "created_by": "123e4567-e89b-12d3-a456-426614174000",
  "updated_by": "123e4567-e89b-12d3-a456-426614174000",
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "company_id": "123e4567-e89b-12d3-a456-426614174000"
}

Search User Groups

Search user groups

post
Body
all ofOptional
and
and
Responses
200

successful operation

application/json
Responseall of
post
POST /app/v1/user_groups/search HTTP/1.1
Host: api.validere.io
Content-Type: application/json
Accept: */*
Content-Length: 476

{
  "page": 0,
  "page_size": 20,
  "sort_by": "name",
  "sort_direction": "desc",
  "filter": {
    "created_at": "2025-08-19T00:27:36.066Z",
    "updated_at": "2025-08-19T00:27:36.066Z",
    "created_by": "123e4567-e89b-12d3-a456-426614174000",
    "updated_by": "123e4567-e89b-12d3-a456-426614174000",
    "id": "123e4567-e89b-12d3-a456-426614174000",
    "name": "text",
    "group_category_id": "123e4567-e89b-12d3-a456-426614174000",
    "user.id": {
      "$in": [
        "c3e9446d-4cc0-4e7b-bb43-43fff9361957",
        "c3e9446d-4cc0-4e7b-bb43-43fff9361957"
      ]
    }
  }
}
200

successful operation

{
  "page_number": 0,
  "page_size": 10,
  "total_entries": 58,
  "total_pages": 6,
  "data": [
    {
      "name": "text",
      "description": "text",
      "group_category_id": "123e4567-e89b-12d3-a456-426614174000",
      "created_at": "2025-08-19T00:27:36.066Z",
      "updated_at": "2025-08-19T00:27:36.066Z",
      "created_by": "123e4567-e89b-12d3-a456-426614174000",
      "updated_by": "123e4567-e89b-12d3-a456-426614174000",
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "company_id": "123e4567-e89b-12d3-a456-426614174000"
    }
  ]
}

Get User Group Members

Show Memberships for a user group

get
Path parameters
user_group_idstring · uuidRequired

User Group ID

Responses
200

A successful operation

application/json
get
GET /app/v1/user_groups/{user_group_id}/members HTTP/1.1
Host: api.validere.io
Accept: */*
200

A successful operation

[
  {
    "created_at": "2025-08-19T00:27:36.066Z",
    "updated_at": "2025-08-19T00:27:36.066Z",
    "created_by": "123e4567-e89b-12d3-a456-426614174000",
    "updated_by": "123e4567-e89b-12d3-a456-426614174000",
    "company_id": "123e4567-e89b-12d3-a456-426614174000",
    "user_group_id": "123e4567-e89b-12d3-a456-426614174000",
    "user_id": "123e4567-e89b-12d3-a456-426614174000"
  },
  {
    "user": {
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "name": "text",
      "email": "[email protected]"
    }
  }
]

Add User to User Group

Add a user to a user group

put
Path parameters
user_group_idstring · uuidRequired

User Group ID

member_idstring · uuidRequired

Member ID

Responses
200

A successful operation

put
PUT /app/v1/user_groups/{user_group_id}/members/{member_id} HTTP/1.1
Host: api.validere.io
Accept: */*
200

A successful operation

No content

Remove User From User Group

Remove a user from a user group

delete
Path parameters
user_group_idstring · uuidRequired

User Group ID

member_idstring · uuidRequired

Member ID

Responses
200

A successful operation

delete
DELETE /app/v1/user_groups/{user_group_id}/members/{member_id} HTTP/1.1
Host: api.validere.io
Accept: */*
200

A successful operation

No content

Create User Group Category

Create a Group Category

post
Body
namestring · max: 100Optional
descriptionstring · max: 256Optional
Responses
200

A successful operation

application/json
Responseall of
and
post
POST /app/v1/group_categories HTTP/1.1
Host: api.validere.io
Content-Type: application/json
Accept: */*
Content-Length: 36

{
  "name": "text",
  "description": "text"
}
200

A successful operation

{
  "name": "text",
  "description": "text",
  "created_at": "2025-08-19T00:27:36.066Z",
  "updated_at": "2025-08-19T00:27:36.066Z",
  "created_by": "123e4567-e89b-12d3-a456-426614174000",
  "updated_by": "123e4567-e89b-12d3-a456-426614174000",
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "company_id": "123e4567-e89b-12d3-a456-426614174000"
}

Get User Group Category

Get a Group Category

get
Path parameters
idstring · uuidRequired

Group Category ID

Responses
200

A successful operation

application/json
Responseall of
and
get
GET /app/v1/group_categories/{id} HTTP/1.1
Host: api.validere.io
Accept: */*
200

A successful operation

{
  "name": "text",
  "description": "text",
  "created_at": "2025-08-19T00:27:36.066Z",
  "updated_at": "2025-08-19T00:27:36.066Z",
  "created_by": "123e4567-e89b-12d3-a456-426614174000",
  "updated_by": "123e4567-e89b-12d3-a456-426614174000",
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "company_id": "123e4567-e89b-12d3-a456-426614174000"
}

Update User Group Category

Update a Group Category

put
Path parameters
idstring · uuidRequired

Group Category ID

Body
namestring · max: 100Optional
descriptionstring · max: 256Optional
Responses
200

A successful operation

application/json
Responseall of
and
put
PUT /app/v1/group_categories/{id} HTTP/1.1
Host: api.validere.io
Content-Type: application/json
Accept: */*
Content-Length: 36

{
  "name": "text",
  "description": "text"
}
200

A successful operation

{
  "name": "text",
  "description": "text",
  "created_at": "2025-08-19T00:27:36.066Z",
  "updated_at": "2025-08-19T00:27:36.066Z",
  "created_by": "123e4567-e89b-12d3-a456-426614174000",
  "updated_by": "123e4567-e89b-12d3-a456-426614174000",
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "company_id": "123e4567-e89b-12d3-a456-426614174000"
}

Delete User Group Category

Delete a Group Category

delete
Path parameters
idstring · uuidRequired

Group Category ID

Responses
200

A successful operation

delete
DELETE /app/v1/group_categories/{id} HTTP/1.1
Host: api.validere.io
Accept: */*
200

A successful operation

No content

Search User Group Categories

Search Group Categories

post
Body
all ofOptional
and
and
Responses
200

Successfully operation

application/json
Responseall of
post
POST /app/v1/group_categories/search HTTP/1.1
Host: api.validere.io
Content-Type: application/json
Accept: */*
Content-Length: 340

{
  "page": 0,
  "page_size": 20,
  "sort_by": "name",
  "sort_direction": "desc",
  "filter": {
    "id": "123e4567-e89b-12d3-a456-426614174000",
    "name": "text",
    "description": "text",
    "created_by": "123e4567-e89b-12d3-a456-426614174000",
    "created_at": "2025-08-19T00:27:36.066Z",
    "updated_by": "123e4567-e89b-12d3-a456-426614174000",
    "updated_at": "2025-08-19T00:27:36.066Z"
  }
}
200

Successfully operation

{
  "page_number": 0,
  "page_size": 10,
  "total_entries": 58,
  "total_pages": 6,
  "data": [
    {
      "name": "text",
      "description": "text",
      "created_at": "2025-08-19T00:27:36.066Z",
      "updated_at": "2025-08-19T00:27:36.066Z",
      "created_by": "123e4567-e89b-12d3-a456-426614174000",
      "updated_by": "123e4567-e89b-12d3-a456-426614174000",
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "company_id": "123e4567-e89b-12d3-a456-426614174000"
    }
  ]
}
PreviousRolesNextData API

Last updated