Yoobic Events API
Events can be created and managed through the YOOBIC app and are displayed in the calendar. Events can be public (visible to all users sharing at least one group with it) or private (visible only to users invited to it).### Fields| Field | Type | Required | Readonly | OrderBy | Description ||----------------------|:--------------:|:--------:|:--------:|:-------:|---------------------------||`event_id` | string | | x | | Unique id of the event ||`title` | string | x | | | The title of the event ||`description` | string | x | | | The description of the event. HTML can be used for formatting||`start_date` | date | x | | | Start date of the event in UTC||`end_date` | date | x | | | End date of the event in UTC||`event_type` | string | x | | | `private` or `public` ||`all_day` | boolean | | | | `true` or `false`. if `true`, start_date should equal to end_date||`tags` | array | | | | Event’s list of tags ||`event_category` | string | | | | Category of the event. Categories need to be defined in the database in the `translations` collection||`user_ids` | array | | | | Required for private events only. Ignored for public events. User ids that are invited to this event||`group_ids` | array | | | | Required for public events. Ignored for private events. Group ids of users who should be invited to this event||`images` | array | | | | Links to uploaded images. Used as illustration on the event page. Max 3 images per event||`store_id` | string | | | | Store the event is linked to||`shared` | boolean | | x | | If event shared on feeds (true/false)||`timezone` | string | | | | The Time Zone allows to display the hourly sales data in the store insights in the local time of the store. ||`address` | string | | | | The address of the event ||`virtual_event_link` | string | | | | Any link e.g. video call ||`total_users` | number | | | | Total user count attending ||`created_date` | date | | | | Creation date ||`updated_date` | date | | | x | Last update date |
Yoobic Events API is one of 41 APIs that Yoobic publishes on the APIs.io network, described by a machine-readable OpenAPI specification.
Tagged areas include Events. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, an API reference, and a changelog.
This API exposes 9 operations across 7 paths, and defines 1 schema. It is described by OpenAPI 3.0.0.
Requests are made against a single base URL, https://.
Metadata
The identity and technical contract details declared by the specification.
Authentication & Security 1
Yoobic Events API declares
1 security scheme
for authenticating requests.
It supports OAuth 2.0 (oauth2) using the authorizationCode flow.
Paths & Operations 9
Across 7 paths, the API surfaces 9 operations — 1 DELETE, 5 GET, 1 PATCH, 2 POST. Each is listed below with its method, path, parameters, and response codes.
Events can be created and managed through the YOOBIC app and are displayed in the calendar. Events can be public (visible to all users sharing at least one group with it) or priva…
Schemas 1
The contract defines 1 schema that model the data the API accepts and returns. The most detailed is Default_Header (1 property). Each schema is shown below with its type and property counts.
Specification
The full machine-readable OpenAPI contract behind this narrative.
Source
More from Yoobic 12
Other APIs Yoobic publishes across the network.