# Slots

You can use the /v2/slots endpoints to get the free slots of a Vyte user.

WARNING

If the user you are requesting available slots for has no availability in the requested time frame, Vyte’s API will tell you their next availability.

In this case you will have slots: [] if you’ve used /slots or days: {} for /slots/days.

The response will include a nextAvailability object formatted as in the example.

ENDPOINTS

GET /v2/slots

GET /v2/slots/days

# List all free slots

ENDPOINT Authorization apiKey

GET /v2/slots HTTP/1.1

Query parameters

duration number required

Duration of the appointment in minutes.
emails string required you need either emails, user_ids or team

Email(s) of people that already have a Vyte account and with whom you want to book an appointment. If several emails are provided, they must be separated with a comma and and the API returns the slots at which all users are available.
users string required you need either emails, user_ids or team

List of user_id you want to book an appointment with. If several user_id are provided, they must be separated with a comma and and the API returns the slots at which all users are available.
team string required you need either emails, user_ids or team

Id of a team you want to get the available slots for members of. If several team members are available at the same time, only one slot will be returned.
from string required

Date from when you want to get available slots (included) formatted as YYYY-MM-DD.
to string required

Date until when you want to get available slots (included) formatted as YYYY-MM-DD.
timezone string

The timezone expressed according to TZ database name.

Returns

An object with a slots array containing all the free slots.

CODE SAMPLE

curl --request GET 'https://api.vyte.in/v2/slots?duration=30&emails=john.doe@example.com&from=2020-09-01&to=2020-09-02' \
--header 'Authorization: vkjvi2bvfo54ssbybmcts0x42z1sbzm6t0mot8trh8i03reno0' \

RESPONSE SAMPLE

{
  "timezone": "Europe/Paris",
  "from": "2020-09-01",
  "to": "2020-09-02",
  "slots": [
    {
      "start": {
        "dateTime": "2020-09-01T00:00:00+02:00"
      },
      "end": {
        "dateTime": "2020-09-01T00:30:00+02:00"
      }
    },
    {
      "start": {
        "dateTime": "2020-09-01T00:30:00+02:00"
      },
      "end": {
        "dateTime": "2020-09-01T01:00:00+02:00"
      }
    },
    {
      "start": {
        "dateTime": "2020-09-01T01:00:00+02:00"
      },
      "end": {
        "dateTime": "2020-09-01T01:30:00+02:00"
      }
    },
    {
      "start": {
        "dateTime": "2020-09-01T01:30:00+02:00"
      },
      "end": {
        "dateTime": "2020-09-01T02:00:00+02:00"
      }
    },
    {
      "start": {
        "dateTime": "2020-09-01T02:00:00+02:00"
      },
      "end": {
        "dateTime": "2020-09-01T02:30:00+02:00"
      }
    },
    {
      "start": {
        "dateTime": "2020-09-01T02:30:00+02:00"
      },
      "end": {
        "dateTime": "2020-09-01T03:00:00+02:00"
      }
    },
    {
      "start": {
        "dateTime": "2020-09-01T03:00:00+02:00"
      },
      "end": {
        "dateTime": "2020-09-01T03:30:00+02:00"
      }
    },
    {
      "start": {
        "dateTime": "2020-09-01T03:30:00+02:00"
      },
      "end": {
        "dateTime": "2020-09-01T04:00:00+02:00"
      }
    },
    {
      "start": {
        "dateTime": "2020-09-01T04:00:00+02:00"
      },
      "end": {
        "dateTime": "2020-09-01T04:30:00+02:00"
      }
    },
    {
      "start": {
        "dateTime": "2020-09-01T04:30:00+02:00"
      },
      "end": {
        "dateTime": "2020-09-01T05:00:00+02:00"
      }
    },
    {
      "start": {
        "dateTime": "2020-09-01T05:00:00+02:00"
      },
      "end": {
        "dateTime": "2020-09-01T05:30:00+02:00"
      }
    },
    ...
  ]
}

# List all free slots grouped by days

ENDPOINT Authorization apiKey

GET /v2/slots/days HTTP/1.1

Path parameters

No parameters.

Query parameters

duration number required

Duration of the appointment in minutes.
emails string required you need either emails or user_ids

Email(s) of people that already have a Vyte account and with whom you want to book an appointment. If several emails are provided, they must be separated with a comma and and the API returns the slots at which all users are available.
users string required you need either emails or user_ids

List of user_id you want to book an appointment with. If several user_id are provided, they must be separated with a comma and and the API returns the slots at which all users are available.
from string required

Date from when you want to get available slots (included) formatted as YYYY-MM-DD.
to string required

Date until when you want to get available slots (included) formatted as YYYY-MM-DD.
timezone string

The timezone expressed according to TZ database name.

Returns

An object with a slots array containing all the free slots.

CODE SAMPLE

curl --request GET 'https://api.vyte.in/v2/slots/days?duration=30&emails=john.doe@example.com&from=2020-09-01&to=2020-09-02' \
--header 'Authorization: vkjvi2bvfo54ssbybmcts0x42z1sbzm6t0mot8trh8i03reno0' \

RESPONSE SAMPLE

{
  "timezone": "Europe/Paris",
  "from": "2020-09-01",
  "to": "2020-09-02",
  "days": {
    "2020-09-01": {
      "slots": [
        {
          "start": {
            "dateTime": "2020-09-01T00:00:00+02:00"
          },
          "end": {
            "dateTime": "2020-09-01T00:30:00+02:00"
          }
        },
        {
          "start": {
            "dateTime": "2020-09-01T00:30:00+02:00"
          },
          "end": {
            "dateTime": "2020-09-01T01:00:00+02:00"
          }
        },
        {
          "start": {
            "dateTime": "2020-09-01T01:00:00+02:00"
          },
          "end": {
            "dateTime": "2020-09-01T01:30:00+02:00"
          }
        },
        ...
      ]
    },
    "2020-09-02": {
      "slots": [
        {
          "start": {
            "dateTime": "2020-09-02T00:00:00+02:00"
          },
          "end": {
            "dateTime": "2020-09-02T00:30:00+02:00"
          }
        },
        {
          "start": {
            "dateTime": "2020-09-02T00:30:00+02:00"
          },
          "end": {
            "dateTime": "2020-09-02T01:00:00+02:00"
          }
        },
        ...
      ]
    }
  }
}

# Get next availability

ENDPOINT Authorization apiKey

GET /v2/slots/next HTTP/1.1

Query parameters

duration number required

Duration of the appointment in minutes.
emails string required you need either emails, user_ids or team

Email(s) of people that already have a Vyte account and with whom you want to book an appointment. If several emails are provided, they must be separated with a comma and and the API returns the slots at which all users are available.
users string required you need either emails, user_ids or team

List of user_id you want to book an appointment with. If several user_id are provided, they must be separated with a comma and and the API returns the slots at which all users are available.
team string required you need either emails, user_ids or team

Id of a team you want to get the available slots for members of. If several team members are available at the same time, only one slot will be returned.
timezone string

The timezone expressed according to TZ database name.

Returns

An object with a slots array containing all the free slots.

CODE SAMPLE

curl --request GET 'https://api.vyte.in/v2/slots/next?duration=30&emails=john.doe@example.com' \
--header 'Authorization: vkjvi2bvfo54ssbybmcts0x42z1sbzm6t0mot8trh8i03reno0' \

RESPONSE SAMPLE

{
  "timezone": "Europe/Paris",
  "slots": [
    {
      "start": {
        "dateTime": "2020-09-01T00:00:00+02:00"
      },
      "end": {
        "dateTime": "2020-09-01T00:30:00+02:00"
      }
    },
    {
      "start": {
        "dateTime": "2020-09-01T00:30:00+02:00"
      },
      "end": {
        "dateTime": "2020-09-01T01:00:00+02:00"
      }
    },
    {
      "start": {
        "dateTime": "2020-09-01T01:00:00+02:00"
      },
      "end": {
        "dateTime": "2020-09-01T01:30:00+02:00"
      }
    },
    {
      "start": {
        "dateTime": "2020-09-01T01:30:00+02:00"
      },
      "end": {
        "dateTime": "2020-09-01T02:00:00+02:00"
      }
    },
    {
      "start": {
        "dateTime": "2020-09-01T02:00:00+02:00"
      },
      "end": {
        "dateTime": "2020-09-01T02:30:00+02:00"
      }
    },
    {
      "start": {
        "dateTime": "2020-09-01T02:30:00+02:00"
      },
      "end": {
        "dateTime": "2020-09-01T03:00:00+02:00"
      }
    },
    {
      "start": {
        "dateTime": "2020-09-01T03:00:00+02:00"
      },
      "end": {
        "dateTime": "2020-09-01T03:30:00+02:00"
      }
    },
    {
      "start": {
        "dateTime": "2020-09-01T03:30:00+02:00"
      },
      "end": {
        "dateTime": "2020-09-01T04:00:00+02:00"
      }
    },
    {
      "start": {
        "dateTime": "2020-09-01T04:00:00+02:00"
      },
      "end": {
        "dateTime": "2020-09-01T04:30:00+02:00"
      }
    },
    {
      "start": {
        "dateTime": "2020-09-01T04:30:00+02:00"
      },
      "end": {
        "dateTime": "2020-09-01T05:00:00+02:00"
      }
    },
    {
      "start": {
        "dateTime": "2020-09-01T05:00:00+02:00"
      },
      "end": {
        "dateTime": "2020-09-01T05:30:00+02:00"
      }
    },
    ...
  ]
}

← Locators Team admin preferences →

# Slots

# List all free slots

Query parameters

duration number required

emails string required you need either emails, user_ids or team

users string required you need either emails, user_ids or team

team string required you need either emails, user_ids or team

from string required

to string required

timezone string

Returns

# List all free slots grouped by days

Path parameters

Query parameters

duration number required

emails string required you need either emails or user_ids

users string required you need either emails or user_ids

from string required

to string required

timezone string

Returns

# Get next availability

Query parameters

duration number required

emails string required you need either emails, user_ids or team

users string required you need either emails, user_ids or team

team string required you need either emails, user_ids or team

timezone string

Returns