# Yoobic Roles API

**Canonical:** https://apis.io/apis/yoobic/yoobic-roles-api/  
**Provider:** Yoobic — https://apis.io/providers/yoobic/  
**Base URL:** https://api.yoobic.com/public/api  
**Documentation:** https://docs.yoobic.com/api.html

Yoobic Roles API is one of 41 APIs that [Yoobic](https://apis.io/providers/yoobic/) publishes on the [APIs.io](https://apis.io/) network, described by a machine-readable OpenAPI specification. Tagged areas include Roles. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, an API reference, and a changelog.

<a id="group-roles"></a> Get the list of Roles available for the users in your organization. The roles are defined by a combination of `client_role` and `client_role_extension` The `client_role` refers to a YOOBIC specific role name between ROLEFIELD, ROLEMANAGER, ROLEEDITOR, ROLESTOREMANAGER, ROLESTORE, ROLEADMIN, and ROLEVIEWER and has an impact on some default features of the platform. It also determines what license level the user is attached to. The `client_role_extension` refers to a customer-specific designation of a user role, usually based on the job or responsibility of the teams. It is used to differentiate users with the same license level but access to different modules of the platform. Each combination of client_role and `client_role_extension` is given a unique acl_role_id at creation Roles are created during the implementation of the platform and cannot be changed by an administrator either via the public API or from the admin interface. ### Fields | Field | Type | Required | Readonly | OrderBy | Description | |------------------------|:--------------:|:--------:|:--------:|:-------:|---------------------------| |`acl_role_id` | string | x | x | | Unique id of the role object | |`client_role` | string | x | x | | User roles: ROLEFIELD | ROLEMANAGER | ROLEEDITOR | ROLESTOREMANAGER | ROLESTORE | ROLEADMIN | ROLEVIEWER | |`client_role_extension` | string | x | x | | Additional role information | |`created_date` | date | | x | | Creation date | |`updated_date` | date | | x | x | Last update date |

## Machine-readable artifacts (11)

- **OpenAPI** — https://raw.githubusercontent.com/api-evangelist/yoobic/refs/heads/main/openapi/yoobic-roles-api-openapi.yml
- **Documentation** — https://docs.yoobic.com/api.html
- **APIReference** — https://docs.yoobic.com/api.html
- **Postman** — https://assets.yoobic.com/raw/upload/v1767016464/3c85c240-dd03-4981-9814-bc6e5e861fa0.zip
- **ErrorCatalog** — https://raw.githubusercontent.com/api-evangelist/yoobic/refs/heads/main/errors/yoobic-problem-types.yml
- **Conventions** — https://raw.githubusercontent.com/api-evangelist/yoobic/refs/heads/main/conventions/yoobic-conventions.yml
- **ChangeLog** — https://raw.githubusercontent.com/api-evangelist/yoobic/refs/heads/main/changelog/yoobic-changelog.yml
- **Lifecycle** — https://raw.githubusercontent.com/api-evangelist/yoobic/refs/heads/main/lifecycle/yoobic-lifecycle.yml
- **Conformance** — https://raw.githubusercontent.com/api-evangelist/yoobic/refs/heads/main/conformance/yoobic-conformance.yml
- **Sandbox** — https://raw.githubusercontent.com/api-evangelist/yoobic/refs/heads/main/sandbox/yoobic-sandbox.yml
- **Webhooks** — https://raw.githubusercontent.com/api-evangelist/yoobic/refs/heads/main/asyncapi/yoobic-webhooks.yml

## Other Yoobic APIs (12)

- [Yoobic Answers API](https://apis.io/apis/yoobic/yoobic-answers-api/)
- [Yoobic Badges API](https://apis.io/apis/yoobic/yoobic-badges-api/)
- [Yoobic Bot Messages API](https://apis.io/apis/yoobic/yoobic-bot-messages-api/)
- [Yoobic Bots API](https://apis.io/apis/yoobic/yoobic-bots-api/)
- [Yoobic Business KPIs data - salesdata API](https://apis.io/apis/yoobic/yoobic-business-kpis-data-salesdata-api/)
- [Yoobic Campaigns API](https://apis.io/apis/yoobic/yoobic-campaigns-api/)
- [Yoobic Catalogs API](https://apis.io/apis/yoobic/yoobic-catalogs-api/)
- [Yoobic Chats API](https://apis.io/apis/yoobic/yoobic-chats-api/)
- [Yoobic Comments API](https://apis.io/apis/yoobic/yoobic-comments-api/)
- [Yoobic Communities API](https://apis.io/apis/yoobic/yoobic-communities-api/)
- [Yoobic Community Posts API](https://apis.io/apis/yoobic/yoobic-community-posts-api/)
- [Yoobic Competencies API](https://apis.io/apis/yoobic/yoobic-competencies-api/)

## Tags

Roles

---

Profiled by [API Evangelist](https://apievangelist.com) and published on [APIs.io](https://apis.io/apis/yoobic/yoobic-roles-api/). The API's provider profile, Kin Score and agent-readiness rating are at https://apis.io/providers/yoobic/.