GuestBan Partner API

Build safer hospitality integrations.

Connect approved systems to daily guest arrivals, screening matches, and portfolio usage data through a secure, read only API.

Read the documentation Request API access

Retrieve guest arrivals

# Previous local day for an authorized property
curl "https://api.myguestban.com/api/public/v1/guests?propertyName=Harbor%20View%20Hotel" \
  -H "Accept: application/json" \
  -H "X-API-Key: $GUESTBAN_API_KEY"

{
  "totalCount": 1,
  "propertyName": "Harbor View Hotel",
  "reportedDateLocal": "2026-08-10",
  "items": [ ... ]
}

HTTPS APISecure requests over TLS

JSON responsesConsistent structured data

Scoped accessLimited by key and property

Versioned contractStable version 1 endpoints

Available APIs

The data your integration needs.

Retrieve daily reports for authorized GuestBan properties using focused, read only endpoints.

Guest arrivals

Retrieve guests who checked in during the previous local calendar day, including captured identity and screening fields.

GET /api/public/v1/guests

Screening matches

Retrieve arrivals with criminal record or sex offender screening matches for approved operational workflows.

GET /api/public/v1/criminal-arrivals

Usage metrics

Access daily scan, alert, warning, and ban metrics with totals and a breakdown for every authorized property.

GET /api/public/v1/usage/dashboard

Get started

From access to first request.

GuestBan API access is available to approved customers and integration partners.

Request access

Tell GuestBan which organization, properties, endpoints, and integration use case require access.

Store your key securely

Keep the issued credential in a server side secret manager or protected environment variable.

Make your first call

Send the API key in the X-API-Key header and verify the response before scheduling production requests.

Designed for controlled access

Property data stays within scope.

Every API credential is authorized for specific capabilities and properties. Requests cannot expand beyond the access assigned to the key.

✓

Endpoint permissionsKeys access only approved API capabilities.

✓

Property permissionsResponses include only authorized hotel properties.

✓

Traceable requestsCorrelation IDs support monitoring and troubleshooting.

✓

Read only version 1Current endpoints retrieve reports without modifying GuestBan records.

GuestBan API version 1

Ready to start your integration?

Review the complete endpoint reference or contact GuestBan to request API access for your organization.

View API reference Contact GuestBan

Developers