# Yoobic Visits API

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

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

<a id="group-visits"></a> 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: <img src="https://res.cloudinary.com/www-yoobic-com/image/upload/v1568034036/ympswsz9y1j0ziaddexu.png" > ### Fields <a id="group-visits-fields"></a> | 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)

## Machine-readable artifacts (11)

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

Visits

---

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