Yoobic Visits API
Through this endpoint the details and/or the approval of the visit could be set. By default, the visits will be shown as pending until they are approved (`compliant`). Below is an example of a typical way of scheduling a visit:### Fields| Field | Type | Required | Readonly | OrderBy | Description ||--------------------------------|--------------|:--------:|:--------:|:-------:|-----------------||`visit_id` | string | | x | | Unique id of the visit ||`user_id` | string | x | | x | Unique id of the user who will visit the store ||`store_id` | string | x | | x | Unique id of the associated store ||`group_ids` | timestamp | x | | | Group ids that can see this visit ||`user_ids` | array | | | | User ids that can see this visit||`start_time` | string | | | | The scheduled time of the visit. Format is HH:mm ||`end_time` | string | | | | The end time of the visit. Format is HH:mm ||`visit_date` | date | x | | | The scheduled date of the visit. Format is YYYY-MM-DD ||`compliant` | boolean | | | | The compliance of the visit as marked by an area manager: `true` if marked compliant, `false` if marked noncompliant ||`type` | string | | | | Type of the visit chosen among a predefined list ||`description` | string | | | | Description of the visit ||`creator_id` | string | | x | x | Unique id of the visit creator ||`custom_fields` | object | | | | Dynamic properties (optional)||`updated_date` | timestamp | | x | x | Visit's last update date ||`created_date` | timestamp | | x | | Visit's creation date |**Important:**`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)
Yoobic Visits API is one of 41 APIs that Yoobic publishes on the APIs.io network, described by a machine-readable OpenAPI specification.
Tagged areas include Visits. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, an API reference, and a changelog.
This API exposes 7 operations across 6 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 Visits API declares
1 security scheme
for authenticating requests.
It supports OAuth 2.0 (oauth2) using the authorizationCode flow.
Paths & Operations 7
Across 6 paths, the API surfaces 7 operations — 4 GET, 1 PATCH, 2 POST. Each is listed below with its method, path, parameters, and response codes.
Through this endpoint the details and/or the approval of the visit could be set. By default, the visits will be shown as pending until they are approved (compliant). Below is an e…
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.