Yoobic

Yoobic Users API

Expose users for your company. Remember: - Users are the people at your company with access to the YOOBIC mobile and/or web apps. - Users can be assigned to one or more groups after they are created - Users can have multiple tags ### Fields | Field | Type | Required | Readonly | OrderBy | Available for all users | Description | |--------------------------|:-------:|:--------:|:--------:|:-------:|:-----------------------:|-----------------| |`user_id` | string | | x | | x | Unique user id | |`username` | string | x | | x | x | Unique username | |`password` | string | x | | | x | Password, required on creation only | |`first_name` | string | x | | | x | First name| |`last_name` | string | x | | | x | Last name| |`client_role` | string | x | | | x | User roles: ROLEFIELD \| ROLEMANAGER \| ROLEEDITOR \| ROLESTOREMANAGER \| ROLESTORE \| ROLEADMIN \| ROLEVIEWER| |`client_role_extension` | string | | | | x | Indicates an extension of a user role. Has to match an existing role extension in the database | |`email` | string | | | | x | Email | |`address` | string | | | | x | User's work address | |`groups` | array | x | | | x | The list of groups the user is in| |`language` | string | | | | x | Preferred language | |`phone` | string | | | | x | Phone number| |`photo` | string | | | | x | Url of the user's picture | |`store_id` | string | | x | x | x | Primary Store. Setting up a store_id on a user will create a geofilter on this user | |`tags` | array | | | | x | Tags allow to specify additional information about the user| |`sso` | boolean| x | | | x | Flag if a user will login through a third party | |`allow_local_login` | boolean| | | | x | Flag if a user will login with password, even if set to third party in tenant (company) configuration | |`last_seen` | date | | x | | x | The date on which the user connected for the last time. | |`terms_of_acceptance_date`| date | | x | | x | The date in which terms were last accepted | |`mobile_version` | string | | x | | x | Version of the App used on mobile by the user. | |`desktop_version` | string | | x | | x | Version of the App used on desktop by the user. | |`created_date` | date | | x | | x | Created Date| |`updated_date` | date | | x | x | x | Updated Date| |`custom_fields` | object | | | | x | Dynamic properties (optional)| |`weekly_schedule` | object | | | | x | Contains data on an employee's working hours for each day of the week.| |`client_ids` | array | | | | x | List of stores that the user can have access to, selected with their client_id. Creates or updates the corresponding user's geofilter if not empty |`store_type_names` | array | | | | x | List of stores' store_types that the user can have access to, selected with their store_type_name. Creates or updates the corresponding user's geofilter if not empty | `position` | string | | | | | Position | | `department` | string | | | | | Department | | `division` | string | | | | | Division | | `company` | string | | | | | Company | | `hiring_date` | date | | | | | Date when the user joined the company | | `skills` | array | | | | | Skills | | `cover` | string | | | | | Cover URL | | `description` | string | | | | | Description | **Important:** - One of either fields is required in case of user creation: - password - sso - `allow_local_login` is required only if in tenant (company) configuration it is specified to allow login using a third party, but would like to enable specific user a login with a password instead. - Combination of `client_role` and `client_role_extension` defines the user's permission. A wrong combination of these two will cause a validation error, specifying an invalid permission. If `client_role_extension` is not passed (optional), `client_role` will refer to the corresponding base permission. - `custom_fields` contains new attributes that can be used to describe more precisely a user. Custom fields provide a new way to customize your user data by allowing you to filter and select the relevant data in the application. You can create your own custom fields in the YOOBIC Web Application in order to enrich your user data. For the full list of supported field types see [campaigns](#group-campaigns-question-types) - The `username` of a user has to be unique across live and archived users and is used to log in to the platform. - If a user already has a `store_id` in their profile, the corresponding store’s `client_id` will be exported in the next export. It can be used instead of the `store_id` - It is possible to add several `client_ids` and/or `store_type_names` for a single user. When updating a user, the list of `client_ids` and `store_type_names` will replace the previous one in the user's geofilter. - It is not possible to filter users on the `client_ids` or `store_type_names` attributes. Please use the geofilter collection to find if a geofilter exist for a user on a specific store or store_type Description of the `weekly_schedule` object: - This object contains data on an employee's working hours for each day of the week. - Each day of the week is represented by a key (e.g. `mon`, `tue`, etc.) and has a corresponding value that contains information about the working periods for that day. ### Fields | Field | Type | Required | Readonly | OrderBy | Description | |---------|:-------:|:--------:|:--------:|:-------:|-----------------| | mon | JSON | no | no | no | Contains data on the working hours for Monday | | tue | JSON | no | no | no | Contains data on the working hours for Tuesday | | wed | JSON | no | no | no | Contains data on the working hours for Wednesday | | thu | JSON | no | no | no | Contains data on the working hours for Thursday | | fri | JSON | no | no | no | Contains data on the working hours for Friday | | sat | JSON | no | no | no | Contains data on the working hours for Saturday | | sun | JSON | no | no | no | Contains data on the working hours for Sunday | For each day of the week, the corresponding value is an object with the following fields: | Field | Type | Required | Readonly | OrderBy | Description | |---------|--------|----------|----------|---------|------------------------------------------------------------------------| | periods | array | no | no | no | Contains an array of objects, each of which represents a working period for the day. | Each object in the `periods` array has the following fields: | Field | Type | Required | Readonly | OrderBy | Description | |-------|--------|----------|----------|---------|------------------------------------------------------------------------| | from | string | no | no | no | The start time of the working period. Format is `hh:mm` in UTC. | | to | string | no | no | no | The end time of the working period. Format is `hh:mm` in UTC. | If a day doesn’t have data in the `weekly_schedule` object, it is considered that the user is not scheduled to work on that day.

GitHub OpenAPI
Business capability
Identity & Access Management BC-620.20

Operations 22

GET /public/api/users/me Get #
GET /public/api/users/{id} Get #
DELETE /public/api/users/{id} Delete #
PATCH /public/api/users/{id} Partial Update #
PATCH /public/api/users/{id}/password-change Change Password #
GET /public/api/users/{id}/password-change?filter={filter} Password History #
POST /public/api/users/{id}/archive Archive #
POST /public/api/users/{id}/unarchive Unarchive #
GET /public/api/users?filter={filter} Get All #
GET /public/api/users/archives?filter={filter} Get all archives #
GET /public/api/users/count?where={where} Count #
POST /public/api/users Create #
POST /public/api/users/reminders Invite users #
GET /public/api/users/weekly-schedule/export?type={type}&filter={filter} Export Weekly Schedule #
PATCH /public/api/users/weekly-schedule/import?type={type} Import Weekly Schedule #
POST /public/api/users/archive/import?type={type} Import Users To Archive #
GET /public/api/users_archived/export?type={type}&filter={filter} Export archived users #
POST /public/api/users/unarchive/import?type={type} Import Users To Un Archive #
GET /public/api/users/export?type={type}&filter={filter} Export #
POST /public/api/users/import?type={type} Import #
GET /public/api/users/managers/export?type={type}&filter={filter} Export manager users #
PATCH /public/api/users/managers/import?type={type} Import manager users #

Documentation

📖
Documentation
https://docs.yoobic.com/api.html
📖
APIReference
https://docs.yoobic.com/api.html

Specifications

⚙
OpenAPI
https://raw.githubusercontent.com/api-evangelist/yoobic/refs/heads/main/openapi/yoobic-users-api-openapi.yml

Other Resources

🔗
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

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-users-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

yoobic-users-api-openapi.yml Raw ↑ 
openapi: 3.2.0
info:
  title: YOOBIC Public Users API
  version: ''
  description: Welcome to the **YOOBIC Public API** documentation.
servers:
- url: https://<base_url>/
tags:


# --- truncated at 32 KB (72 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/yoobic/refs/heads/main/openapi/yoobic-users-api-openapi.yml