Getting Started with the Visitly API

Modified on Mon, 20 Apr at 8:42 AM

Overview

The Visitly API lets Enterprise customers integrate Visitly directly into their existing systems and build custom workflows. Whether you’re syncing visitor logs with your internal tools, automating employee check-in/out, or managing deliveries programmatically — the API gives you full control over your Visitly operations.

Full API reference and interactive documentation are available at developer.visitly.io.

What You’ll Need

Requirement	Details
Visitly Enterprise Plan	API access is available exclusively on the Enterprise plan.
Admin Dashboard Access	You must be an Admin in your Visitly organization.
A use case in mind	Know which operations you want to automate (visitors, employees, deliveries, etc.).

Don’t have an Enterprise plan yet? Contact support@visitly.io to upgrade your subscription and enable API access.

Step 1: Request API Access

Send an email to support@visitly.io with the subject line “API Access Request”. Include your organization name and a brief description of how you plan to use the API.

Our team will review your request and enable API access on your account. You’ll receive a confirmation email once it’s activated.

Tip: Mention your specific use case (e.g., “We want to sync visitor pre-registrations from our internal scheduling tool”). This helps us set up your account with the right configuration.

Step 2: Generate Your API Key

Once API access is enabled on your account, follow these steps to create your first API key:

Log in to your Visitly Admin Dashboard.
Navigate to Integrations Hub › API in the left sidebar.
Click Create API Key.
Give your key a descriptive name (e.g., “Concierge App Integration” or “HR System Sync”).
Select the Access Scope appropriate for your use case (see table below given in Step 3).
Click Generate Key. Your API key will be displayed on screen.

Important: Copy your API key immediately and store it securely. The raw key is only shown once at the time of creation and cannot be retrieved later. If you lose it, you’ll need to create a new key.

Tip: You can create up to 10 API keys per organization. Use separate keys for different integrations so you can rotate or revoke them independently.

Step 3: Choose the Right Access Scope

Each API key is assigned an access scope that controls what it can read and write. Choose the most restrictive scope that meets your needs:

Access Scope	What It Allows	Best For
Global Read & Write	Full read and write access across all sites in your organization.	Organization-wide integrations that need to create and manage records across every site.
Global Read	Read-only access across all sites.	Reporting dashboards, analytics, or data-sync tools that only need to pull data.
Site-Level Read & Write	Read and write access limited to a specific site.	Site-specific tools (e.g., a lobby kiosk integration at one location).
Site-Level Read	Read-only access limited to a specific site.	Monitoring or display boards for a single location.

Tip: Follow the principle of least privilege. Give each key only the permissions it actually needs. If your integration only reads visitor logs, a Read-only key is the safest choice

Step 4: Make Your First API Call

All API data endpoints use the base URL below and require your API key in the request header:

Base URL

https://api.visitly.io/developer

Authentication Header

X-API-Key: YOUR_API_KEY

Example: List All Sites

Try this request to confirm your key is working. It returns all sites in your organization:

GET https://api.visitly.io/developer/v2/sites

Header: X-API-Key: YOUR_API_KEY

Response Format

All responses return JSON in a consistent structure:

{ "data": { ... }, "pagination": { "limit": 10, "offset": 0 }, "meta": {} }

You can use the following query parameters to filter, sort, and paginate results:

Parameter	Description	Example
limit	Number of records to return per page.	limit=25
offset	Number of records to skip (for pagination).	offset=50
search	Search keyword to filter results.	search=John
sort / order	Field to sort by and direction (asc/desc).	sort=createdAt&order=desc
fromDate / toDate	Filter results within a date range.	fromDate=2026-01-01
siteId	Filter results to a specific site.	siteId=abc123
status	Filter results by status.	status=active