> ## Documentation Index
> Fetch the complete documentation index at: https://docs.onesauce.ai/llms.txt
> Use this file to discover all available pages before exploring further.

# Visits

> Log check-ins and see past visits.

## checkin\_types

Readcheckins:write

Lists your organization's check-in types, such as drop-in or meeting, and the follow-up question each type asks. The assistant calls this before `check_in` when you name a visit type or a type needs a follow-up answer. It asks you for the answer rather than guessing.

Takes no inputs.

**Returns**

**types** `object[]`

**properties**

**key** `string`

The type's key, passed to `check_in` as `check_in_type`.

**label** `string`

The name shown in the app.

**is\_default** `boolean`

Whether this is your organization's default type.

**followup** `object | null`

The follow-up question, whether it's required, and its allowed `options`.

**notes\_enabled** `boolean`

Whether this type takes visit notes.

## check\_in

Writecheckins:write

Records a visit to a restaurant as you. The check-in shows up in your Onesauce activity, closes your due follow-ups for that restaurant, and may sync to your CRM, the same as a check-in made in the app.

> I just stopped by joespizza.com. Log a drop-in.

**entity\_id** `string` *required*

Onesauce ID of the brand or location, e.g. `onesauce_id` from `lookup_by_website`.

**entity\_type** `"brand" | "location"` (default: brand)

Whether `entity_id` is a brand or a single location.

**check\_in\_type** `string`

Your organization's check-in type key, e.g. `drop_in`. Unknown or missing types are recorded as `drop_in`.

**notes** `string`

Visit notes. These may sync to your CRM.

**visit\_date** `datetime`

When the visit happened, for logging a past visit. Omit it for a visit happening now.

**followup\_answer** `string`

Answer to the check-in type's follow-up question. It must be exactly one of the options from `checkin_types`, and it's required when the type has a follow-up.

**Returns**

**success** `boolean`

**check\_in\_id** `string`

Pass it to [`set_reminder`](https://docs.onesauce.ai/tools/notes-reminders#set_reminder) to follow up on the visit.

**url** `string`

Link to the restaurant in the Onesauce app.

> [!NOTE]
>
> Onesauce records which assistant made each check-in, for example Claude or ChatGPT.

## brand\_visits

Readactivity:read

Lists your past check-ins at a brand's locations, newest first.

> When did I last visit Joe's Pizza?

**brand\_id** `string` *required*

Onesauce brand ID.

**Returns**

**visits** `object[]`

Each visit's `check_in_id`, `visited_at`, location ID, name and address, `check_in_type`, and `followup_answer`.


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.