Yoobic

Yoobic Roles API

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 |

Documentation GitHub OpenAPI

Business capability

Identity & Access Management BC-620.20

Operations 4

GET /public/api/acl-roles/{id} Get #

GET /public/api/acl-roles?filter={filter} Get All #

GET /public/api/acl-roles/count?where={where} Count #

GET /public/api/acl-roles/export?type={type}&filter={filter} Export #

Work with this as data

Every API here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for apis

7 MCP tools reach this

find_apisBrowse and filter every API in the catalog.
get_api_artifactsOne API's artifacts, grouped by type.
get_openapiThe primary OpenAPI for this API.
find_similar_apisAPIs that look like this one.
apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
resolveTurn a domain, URL or GitHub org into the provider it belongs to.
find_cohortsEvery scored population of providers in the catalog.

All 92 tools →

Call it yourself

curl for this page

This API

curl "https://apis.io/api/v1/apis/yoobic-roles-api"

All apis

curl "https://apis.io/api/v1/apis?limit=25"

Discovery needs no key. Ratings and market analysis are Pro.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have.

OpenAPI Specification

openapi: 3.2.0
info:
  title: YOOBIC Public Roles API
  version: ''
  description: Welcome to the **YOOBIC Public API** documentation.
servers:
- url: https://<base_url>/
tags:
- name: Roles
  description: Get the list of Roles available for the users in your organization.
paths:
  /public/api/acl-roles/{id}:
    get:
      responses:
        '200':
          description: OK
          headers: {}
          content:
            application/json:
              schema:
                type: object
                properties:
                  acl_role_id:
                    type: string
                  client_role:
                    type: string
                  client_role_extension:
                    type: string
                  created_date:
                    type: string
                  updated_date:
                    type: string
                example:
                  acl_role_id: 635fa9a8fffb8783206ea224
                  client_role: ROLESTORE
                  client_role_extension: test
                  created_date: '2022-10-31T10:55:36.857Z'
                  updated_date: '2022-10-31T10:55:36.857Z'
              examples:
                response:
                  value:
                    acl_role_id: 635fa9a8fffb8783206ea224
                    client_role: ROLESTORE
                    client_role_extension: test
                    created_date: '2022-10-31T10:55:36.857Z'
                    updated_date: '2022-10-31T10:55:36.857Z'
      summary: Get
      operationId: Get
      description: Get a role for the given id.
      tags:
      - Roles
      parameters:
      - name: id
        in: path
        description: The id of the role
        required: true
        example: 635fa9a8fffb8783206ea224
        schema:
          type: string
      - name: Accept
        in: header
        description: e.g. application/json
        required: false
        example: application/json
        schema:
          type: string
      security:
      - oauth2: []
  /public/api/acl-roles?filter={filter}:
    get:
      responses:
        '200':
          description: OK
          headers: {}
          content:
            application/json:
              schema:
                type: array
                items:
                  type: object
                  properties:
                    acl_role_id:
                      type: string
                    client_role:
                      type: string
                    client_role_extension:
                      type: string
                    created_date:
                      type: string
                    updated_date:
                      type: string
                  required:
                  - acl_role_id
                  - client_role
                  - created_date
                  - updated_date
                example:
                - acl_role_id: 5f591f87933fa329c5956d7d
                  client_role: ROLESTORE
                  client_role_extension: Tudor
                  created_date: '2020-09-09T18:31:35.542Z'
                  updated_date: '2022-10-31T10:54:27.973Z'
                - acl_role_id: 61538d4de9967a003670703c
                  client_role: ROLEVIEWER
                  created_date: '2021-09-28T21:46:53.325Z'
                  updated_date: '2022-10-28T21:01:37.131Z'
              examples:
                response:
                  value:
                  - acl_role_id: 5f591f87933fa329c5956d7d
                    client_role: ROLESTORE
                    client_role_extension: Tudor
                    created_date: '2020-09-09T18:31:35.542Z'
                    updated_date: '2022-10-31T10:54:27.973Z'
                  - acl_role_id: 61538d4de9967a003670703c
                    client_role: ROLEVIEWER
                    created_date: '2021-09-28T21:46:53.325Z'
                    updated_date: '2022-10-28T21:01:37.131Z'
      summary: Get All
      operationId: Get All
      description: Get all the roles.
      tags:
      - Roles
      parameters:
      - name: filter
        in: query
        description: A valid JSON filter object
        required: false
        example: '{}'
        schema:
          type: string
      - name: Accept
        in: header
        description: e.g. application/json
        required: false
        example: application/json
        schema:
          type: string
      requestBody:
        $ref: '#/components/requestBodies/Get_AllBody'
  /public/api/acl-roles/count?where={where}:
    get:
      responses:
        '200':
          description: OK
          headers: {}
          content:
            application/json:
              schema:
                type: object
                properties:
                  count:
                    type: number
                example:
                  count: 10
              examples:
                response:
                  value:
                    count: 10
      summary: Count
      operationId: Count
      description: Count all the existing entities based on the where filter
      tags:
      - Roles
      parameters:
      - name: where
        in: query
        description: A valid JSON [Where filter](#section-api-requests-filter-where)
        required: false
        example: '{ "property": "value" }'
        schema:
          type: string
      - name: Accept
        in: header
        description: e.g. application/json
        required: false
        example: application/json
        schema:
          type: string
      requestBody:
        $ref: '#/components/requestBodies/Get_AllBody'
  /public/api/acl-roles/export?type={type}&filter={filter}:
    get:
      responses:
        '200':
          description: OK
          headers: {}
          content:
            application/json:
              schema:
                type: object
                properties:
                  name:
                    type: string
                  type:
                    type: string
                  priority:
                    type: number
                  nextRunAt:
                    type: string
                  _id:
                    type: string
                example:
                  name: Export file
                  type: normal
                  priority: 0
                  nextRunAt: '2018-09-11T15:56:05.387Z'
                  _id: 5b97e5954b99568b4b9101af
              examples:
                response:
                  value:
                    name: Export file
                    type: normal
                    priority: 0
                    nextRunAt: '2018-09-11T15:56:05.387Z'
                    _id: 5b97e5954b99568b4b9101af
      summary: Export
      operationId: Export
      description: 'Export all results as a file.

        This action is asynchronous and returns the id of a job. See `jobs` endpoint to query the status of the job. The file will contain the results with all of the fields specified on the resource.'
      tags:
      - Roles
      parameters:
      - name: type
        in: path
        description: The type of file, either `csv` (default value) or `excel`
        required: true
        example: csv
        schema:
          type: string
      - name: filter
        in: query
        description: A valid JSON filter object (does not accept a `fields` filter)
        required: false
        example: '{}'
        schema:
          type: string
      - name: Accept
        in: header
        description: e.g. application/json
        required: false
        example: application/json
        schema:
          type: string
      requestBody:
        $ref: '#/components/requestBodies/Get_AllBody'
components:
  schemas:
    Default_Header:
      type: object
      required:
      - Authorization
      properties:
        Authorization:
          type: string
          example: Bearer JWT
  requestBodies:
    Get_AllBody:
      content:
        application/json:
          schema:
            type: object
            properties:
              Authorization:
                $ref: '#/components/schemas/Default_Header'
  securitySchemes:
    oauth2:
      type: oauth2
      flows:
        authorizationCode:
          authorizationUrl: /
          tokenUrl: /
          scopes: {}