List User Groups¶
This endpoint returns a paginated list of all the user groups in an account.
Request¶
GET https://v2.api.uberflip.com/user-groups
| Query Parameters | Description |
|---|---|
| name | Filter results by user group name |
| limit | Number of results to return |
| page | Page to show |
| sort | Sort results by one or more of the following fields:
|
Response¶
The response will contain a user groups collection:
| Body Parameters | Type | Description |
|---|---|---|
| data | Array | The collection of user groups |
| meta | Object | See: Pagination |
Each user group in the collection will have properties:
| Body Parameters | Type | Description |
|---|---|---|
| id | Integer | The user group identifier |
| code | String | The user group code |
| name | String | The user group name |
| description | String | The user group description |
| user_count | Integer | The number of users included in the user group |
| lock_delete | Boolean | The user group cannot be deleted if this lock is set |
| lock_grant_revoke_global_permissions | Boolean | |
| lock_grant_revoke_licenses | Boolean | |
| lock_add_remove_users | Boolean | Users cannot be removed from this user group if this lock is set |
| created_at | DateTime | The user group creation time |
| modified_at | DateTime | The user group last updated time |
Examples¶
curl -H "Authorization: Bearer [Token]" \
-i https://v2.api.uberflip.com/user-groups
Sample response:
HTTP/1.1 200 OK
Content-Type: application/json
{
"data": [
{
"id": 546732,
"code": "ALL_USERS",
"name": "All Users",
"description": "All users in your account are automatically added to this group.",
"user_count": 11,
"lock_update": 1,
"lock_delete": 1,
"lock_grant_revoke_global_permissions": 0,
"lock_grant_revoke_licenses": 0,
"lock_add_remove_users": 1,
"created_at": "2017-07-04T12:36:39-0400",
"modified_at": "2017-07-04T12:36:39-0400"
},
{
"id": 546735,
"code": "ACCOUNT_ADMINISTRATORS",
"name": "Account Administrators",
"description": "Users in this group automatically receive all global permissions and licenses.",
"user_count": 2,
"lock_update": 1,
"lock_delete": 1,
"lock_grant_revoke_global_permissions": 1,
"lock_grant_revoke_licenses": 1,
"lock_add_remove_users": 0,
"created_at": "2017-07-04T12:36:39-0400",
"modified_at": "2017-07-04T12:36:39-0400"
},
{
"id": 546738,
"code": "CONTENT_MANAGERS",
"name": "Content Managers",
"description": "Access to all Uberflip functionality, but does not have the ability to add or manage users.",
"user_count": 3,
"lock_update": 1,
"lock_delete": 1,
"lock_grant_revoke_global_permissions": 0,
"lock_grant_revoke_licenses": 0,
"lock_add_remove_users": 0,
"created_at": "2017-07-04T12:36:39-0400",
"modified_at": "2017-07-04T12:36:39-0400"
},
{
"id": 546741,
"code": "AUTHORS",
"name": "Authors",
"description": "Ability to create new drafts in Blog Streams and edit their own content, but without the ability to publish.",
"user_count": 1,
"lock_update": 1,
"lock_delete": 1,
"lock_grant_revoke_global_permissions": 0,
"lock_grant_revoke_licenses": 0,
"lock_add_remove_users": 0,
"created_at": "2017-07-04T12:36:39-0400",
"modified_at": "2017-07-04T12:36:39-0400"
},
{
"id": 546744,
"code": "DEVELOPERS_DESIGNERS",
"name": "Developers / Designers",
"description": "Access to the Appearance section of Hubs, Flipbooks, embed features, and the ability to manage the overall look and feel.",
"user_count": 0,
"lock_update": 1,
"lock_delete": 1,
"lock_grant_revoke_global_permissions": 0,
"lock_grant_revoke_licenses": 0,
"lock_add_remove_users": 0,
"created_at": "2017-07-04T12:36:39-0400",
"modified_at": "2017-07-04T12:36:39-0400"
},
{
"id": 546747,
"code": "DEMAND_GENERATION",
"name": "Demand Generation",
"description": "Access to the lead generation tools including calls-to-action, marketing automation integrations and metrics.",
"user_count": 0,
"lock_update": 1,
"lock_delete": 1,
"lock_grant_revoke_global_permissions": 0,
"lock_grant_revoke_licenses": 0,
"lock_add_remove_users": 0,
"created_at": "2017-07-04T12:36:39-0400",
"modified_at": "2017-07-04T12:36:39-0400"
},
{
"id": 546750,
"code": "ANALYSTS",
"name": "Analysts",
"description": "Access to the Metrics section of your Uberflip account.",
"user_count": 0,
"lock_update": 1,
"lock_delete": 1,
"lock_grant_revoke_global_permissions": 0,
"lock_grant_revoke_licenses": 0,
"lock_add_remove_users": 0,
"created_at": "2017-07-04T12:36:39-0400",
"modified_at": "2017-07-04T12:36:39-0400"
},
{
"id": 546753,
"code": "SALES_REPS",
"name": "Sales Reps",
"description": "Read-only access to the Hubs management section, content score, and the embed features.",
"user_count": 1,
"lock_update": 1,
"lock_delete": 1,
"lock_grant_revoke_global_permissions": 0,
"lock_grant_revoke_licenses": 0,
"lock_add_remove_users": 0,
"created_at": "2017-07-04T12:36:39-0400",
"modified_at": "2017-07-04T12:36:39-0400"
},
{
"id": 682187,
"code": null,
"name": "New Group 1",
"description": null,
"user_count": 1,
"lock_update": 0,
"lock_delete": 0,
"lock_grant_revoke_global_permissions": 0,
"lock_grant_revoke_licenses": 0,
"lock_add_remove_users": 0,
"created_at": "2017-07-30T07:24:27-0400",
"modified_at": "2017-07-30T07:24:27-0400"
},
{
"id": 682189,
"code": null,
"name": "New Group 2",
"description": null,
"user_count": 0,
"lock_update": 0,
"lock_delete": 0,
"lock_grant_revoke_global_permissions": 0,
"lock_grant_revoke_licenses": 0,
"lock_add_remove_users": 0,
"created_at": "2017-07-30T07:24:27-0400",
"modified_at": "2017-07-30T07:24:27-0400"
},
{
"id": 1189337,
"code": null,
"name": "New Group 3",
"description": "",
"user_count": 1,
"lock_update": 0,
"lock_delete": 0,
"lock_grant_revoke_global_permissions": 0,
"lock_grant_revoke_licenses": 0,
"lock_add_remove_users": 0,
"created_at": "2018-10-03T10:35:54-0400",
"modified_at": "2018-10-03T10:35:54-0400"
}
],
"meta": {
"count": 11,
"limit": 25,
"total_pages": 1
}
}