# Yoobic Groups API

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

Yoobic Groups 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 Group. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, an API reference, and a changelog.

<a id="group-groups"></a> Groups are used to manage users. This is VERY important as Groups are what make using the application much simpler. By adding Users to Groups, when you need to modify sets of Users, you just change the groups properties and all the Users in the Group inherit these properties (much better than changing each individual user manually). Moreover, Groups allow to restrict visibility when some entities are shared (Missions, News, Documents, ...) ### How do I structure my groups ? Each Group usually corresponds to a population of Users (ex: Admin, HQ, VM Managers, Retail Area Managers, Stores, etc.). <img src="https://user-images.githubusercontent.com/4806944/41535702-fd95441a-730b-11e8-8fbe-603f8a43f51f.png"> ### General Group Usually there is a general group, which has the name of the tenant. This group will contain all of the other Groups and will give the Users access to shared information. Then you will usually find a Group for each type of user. These usually fall into one of these categories: * Admin * Area Managers * HQ * Itinerants * Store Users ### Fields | Field | Type | Required | Readonly | OrderBy | Description | |-----------------------------|:--------:|:--------:|:--------:|:-------:| -------------------------| |`group_id` | string | | x | | The group_id corresponds to the Group title in lowercase letters, with `_` instead of spaces, and without special characters | |`title` | string | x | | | Group Title | |`description` | string | | | | Group Description | |`group_ids` | array | | | x | group ids that belong to this group | |`user_ids` | array | | | x | user ids that belong to this group | |`created_date` | date | | x | | Created Date | |`updated_date` | date | | x | x | Updated Date | |`icon_url` | string | | | | Icon URL | ### Tip To summarise, remember that: * Users are organised in groups * Groups must be created prior to importing any users to the database * A user can belong to multiple groups * There can be sub-groups * Users inherit their level or rights from the group(s) they belong to <img src="https://user-images.githubusercontent.com/4806944/41536506-7949d9d4-730e-11e8-81d8-62c0bc39c9e3.png">

## Machine-readable artifacts (11)

- **OpenAPI** — https://raw.githubusercontent.com/api-evangelist/yoobic/refs/heads/main/openapi/yoobic-groups-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

Group

---

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