Content Management User Groups API
The User Groups API is in phase and is not yet available to users. You can contact the Product-Live team at contact@product-live.com if you want more details and get an early access.
Introduction
A user group is a team grouping multiple users. Those enables you to set different permissions to various groups of useres. You can only retrieve user groups on your company account.
The User Groups API Swagger definition is available on our Product-Live API portal here.
General information
- Rate limit: 50 requests per minute
Get User Group by id
Request URL
Path parameters
| Parameter | Type | Description |
|---|---|---|
| userGroupId | string | A user group id |
Request parameters
None
Request headers
| Header | Type | Value |
|---|---|---|
| accept | string | application/json |
| X-Api-Key | string | Your account API key |
Request Body
None
Request Example
bash
curl -X 'GET' \
'GET https://api.product-live.com/v1/user_-_groups/156' \
-H 'accept: */*' \
-H 'X-Api-Key: <REDACTED>'1
2
3
4
2
3
4
Response example
json
{
"object": "user_group",
"id": "156",
"updatedAt": "2025-06-03T15:15:10.000Z",
"createdAt": "2025-06-03T15:15:10.000Z",
"accountId": "4203",
"title": "Team",
"description": "My Team",
"membersId": [
"9224"
]
}1
2
3
4
5
6
7
8
9
10
11
12
2
3
4
5
6
7
8
9
10
11
12
List User Groups
Request URL
Path parameters
None
Request parameters
| Parameter | Type | Description |
|---|---|---|
| page | integer | Optional The page number to retrieve. Default value if missing : 0 |
| size | integer | Optional The number of items per page. Default value if missing : 10 |
Request headers
| Header | Type | Value |
|---|---|---|
| accept | string | application/json |
| X-Api-Key | string | Your account API key |
Request Body
None
Request Example
bash
curl -X 'GET' \
'https://api.product-live.com/v1/user_groups?size=1&page=0' \
-H 'accept: */*' \
-H 'X-Api-Key: <REDACTED>'1
2
3
4
2
3
4
Response example
json
{
"object": "list",
"data": [
{
"object": "user_group",
"id": "156",
"updatedAt": "2025-06-03T15:15:10.000Z",
"createdAt": "2025-06-03T15:15:10.000Z",
"accountId": "4203",
"title": "Team",
"description": "My Team",
"membersId": [
"9224"
]
}
],
"totalElements": 1
}1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
Find User Groups
Request URL
Path parameters
None
Request parameters
| Parameter | Type | Description |
|---|---|---|
| page | integer | Optional The page number to retrieve. Default value if missing : 0 |
| size | integer | Optional The number of items per page. Default value if missing : 10 |
Request headers
| Header | Type | Value |
|---|---|---|
| accept | string | application/json |
| X-Api-Key | string | Your account API key |
Request Body
See more details on the find request body in the dedicated page Find request.
json
{
"type": "search",
"caseSensitive": false,
"field": "title",
"value": "Team"
}1
2
3
4
5
6
2
3
4
5
6
json
{
"type": "and",
"queries": [
{
"type": "search",
"caseSensitive": false,
"field": "title",
"value": "team"
},
{
"type": "eq",
"caseSensitive": true,
"field": "description",
"value": "My Team"
}
]
}1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
Request Example
bash
curl -X 'POST' \
'https://api.product-live.com/v1/user_groups/find?size=1&page=0' \
-H 'accept: */*' \
-H 'X-Api-Key: <REDACTED>'
-d '{
"type": "and",
"queries": [
{
"type": "search",
"caseSensitive": false,
"field": "title",
"value": "team"
},
{
"type": "eq",
"caseSensitive": true,
"field": "description",
"value": "My Team"
}
]
}'1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
Response example
json
{
"object": "list",
"data": [
{
"object": "user_group",
"id": "156",
"updatedAt": "2025-06-03T15:15:10.000Z",
"createdAt": "2025-06-03T15:15:10.000Z",
"accountId": "4203",
"title": "Team",
"description": "My Team",
"membersId": [
"9224"
]
}
],
"totalElements": 1
}1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
Create a User Group
Request URL
Path parameters
None
Request parameters
None
Request Headers
| Header | Type | Value |
|---|---|---|
| accept | string | */* |
| Content-Type | string | application/json |
| X-Api-Key | string | Your account API key |
Request Body
json
{
"title": "Team",
"description": "My Team"
}1
2
3
4
2
3
4
Request Example
bash
curl -X 'POST' \
'https://api.product-live.com/v1/user_groups' \
-H 'accept: application/json' \
-H 'X-Api-Key: [REDACTED]' \
-H 'Content-Type: application/json' \
-d '{
"title": "Team",
"description": "My Team"
}'1
2
3
4
5
6
7
8
9
2
3
4
5
6
7
8
9
Response Example
json
{
"object": "user_group",
"id": "156",
"updatedAt": "2025-06-03T15:15:10.000Z",
"createdAt": "2025-06-03T15:15:10.000Z",
"accountId": "4203",
"title": "Team",
"description": "My Team",
"membersId": [
"9224"
]
}1
2
3
4
5
6
7
8
9
10
11
12
2
3
4
5
6
7
8
9
10
11
12
Update a User Group
Request URL
Path parameters
| Parameter | Type | Description |
|---|---|---|
| userGroupId | string | A user group id |
Request parameters
None
Request Body
json
{
"title": "Media team"
}1
2
3
2
3
json
{
"description": "The Media Team"
}1
2
3
2
3
json
{
"title": "Media team",
"description": "The Media Team"
}1
2
3
4
2
3
4
Request Example
bash
curl -X 'PATCH' \
'https://api.product-live.com/v1/user_groups/156' \
-H 'accept: */*' \
-H 'X-Api-Key: <REDACTED>'
-d '{
"title": "Media team",
"description": "The Media Team"
}'1
2
3
4
5
6
7
8
2
3
4
5
6
7
8
Response example
json
{
"object": "user_group",
"id": "156",
"updatedAt": "2025-06-04T13:44:14.000Z",
"createdAt": "2025-06-03T15:15:10.000Z",
"accountId": "4203",
"title": "Media team",
"description": "The Media Team"
"membersId": [
"9224"
]
}1
2
3
4
5
6
7
8
9
10
11
12
2
3
4
5
6
7
8
9
10
11
12
Delete a User Group
Request URL
Path parameters
| Parameter | Type | Description |
|---|---|---|
| userGroupId | string | A user group id |
Request parameters
None
Request Headers
| Header | Type | Description |
|---|---|---|
| accept | string | */* |
| X-Api-Key | string | Your account API key |
Request Body
None
Request Example
bash
curl -X 'DELETE' \
'https://api.product-live.com/v1/user_groups/156' \
-H 'accept: */*' \
-H 'X-Api-Key: <REDACTED>'1
2
3
4
2
3
4
Response Example
None. Only the HTTP status code informs of the completion of the request.
Add member to a User Group
Request URL
Path parameters
None
Request parameters
| Parameter | Type | Description |
|---|---|---|
| userGroupId | string | A user group id |
Request headers
| Header | Type | Value |
|---|---|---|
| accept | string | application/json |
| X-Api-Key | string | Your account API key |
Request Body
You must provide valid user ids in the membersId property.
json
{
"membersId": [
"476347"
]
}1
2
3
4
5
2
3
4
5
Response Example
bash
curl -X 'POST' \
'https://api.product-live.com/v1/user_groups/{userGroupId}/add-members' \
-H 'accept: */*' \
-H 'X-Api-Key: <REDACTED>'
-d '{
"membersId": [
"476347"
]
}'1
2
3
4
5
6
7
8
9
2
3
4
5
6
7
8
9
Response example
json
{
"object": "user_group",
"id": "156",
"updatedAt": "2025-06-03T15:15:10.000Z",
"createdAt": "2025-06-03T15:15:10.000Z",
"accountId": "4203",
"title": "Team",
"description": "My Team",
"membersId": [
"9224",
"54677"
]
}1
2
3
4
5
6
7
8
9
10
11
12
13
2
3
4
5
6
7
8
9
10
11
12
13
Remove User from a User group
Request URL
Path parameters
None
Request parameters
None
Request Headers
| Header | Type | Value |
|---|---|---|
| accept | string | */* |
| Content-Type | string | application/json |
| X-Api-Key | string | Your account API key |
Request Body
You must provide valid user ids in the membersId property.
json
{
"membersId": [
"54677"
]
}1
2
3
4
5
2
3
4
5
Request Example
bash
curl -X 'POST' \
'https://api.product-live.com/v1/user_groups/{userGroupId}/remove-members' \
-H 'accept: application/json' \
-H 'X-Api-Key: <REDACTED>' \
-H 'Content-Type: application/json' \
-d '{
"membersId": [
"54677"
]
}'1
2
3
4
5
6
7
8
9
10
2
3
4
5
6
7
8
9
10
Response Example
json
{
"object": "user_group",
"id": "156",
"updatedAt": "2025-06-03T15:15:10.000Z",
"createdAt": "2025-06-03T15:15:10.000Z",
"accountId": "4203",
"title": "Team",
"description": "My Team",
"membersId": [
"9224"
]
}1
2
3
4
5
6
7
8
9
10
11
12
2
3
4
5
6
7
8
9
10
11
12