# Loby Docs

> API documentation for Loby - a ticketing and membership platform for museums and cultural venues.

## Documentation

### REST API

Complete reference for the Loby REST API. Manage tickets, memberships, customers, and events programmatically.

- [Overview](https://loby.io/rest-api/introduction/overview): Get started with the Loby REST API. Learn about authentication, base URLs, rate limits, and how to make your first API request.
- [Pagination](https://loby.io/rest-api/introduction/pagination): Learn how to paginate through large result sets using cursor-based pagination in the Loby API.
- [Querying](https://loby.io/rest-api/introduction/querying): Filter and search API responses using query parameters. Build powerful queries to find exactly the data you need.
- [Images](https://loby.io/rest-api/introduction/images): Work with images in the Loby API. Learn about image URLs, resizing options, and supported formats.
- [Customer](https://loby.io/rest-api/objects/customer): The Customer object represents a visitor or member. Learn about all available fields and relationships.
- [Membership Type](https://loby.io/rest-api/objects/membership-type): Membership Types define the different membership plans available. Understand pricing, benefits, and configuration options.
- [Membership](https://loby.io/rest-api/objects/membership): The Membership object links a customer to a membership type. Track status, validity periods, and member benefits.
- [Order](https://loby.io/rest-api/objects/order): An Order is the purchase record linked to a membership or other sale. Includes sales channel type.
- [Ticket Type](https://loby.io/rest-api/objects/ticket-type): Ticket Types define admission categories and pricing. Configure capacity, time slots, and availability rules.
- [Ticket](https://loby.io/rest-api/objects/ticket): The Ticket object represents a purchased admission. Access ticket details, validity, and check-in status.
- [Ticket Reservation](https://loby.io/rest-api/objects/ticket-reservation): Ticket Reservations temporarily hold capacity before purchase. Manage reservation expiry and conversion to tickets.
- [Location](https://loby.io/rest-api/objects/location): Locations represent physical venues or areas. Configure capacity limits and associate ticket types with locations.
- [Time Slot](https://loby.io/rest-api/objects/time-slot): Time Slots define available entry times. Manage capacity per slot and configure booking windows.
- [Transaction](https://loby.io/rest-api/objects/transaction): The Transaction object records all purchases and refunds. Track payment details, line items, and order history.
- [Event](https://loby.io/rest-api/objects/event): Events represent special exhibitions or programs. Configure dates, capacity, and event-specific ticket types.
- [Event Ticket Type](https://loby.io/rest-api/objects/event-ticket-type): Event Ticket Types define admission options for specific events. Set pricing and capacity per event.
- [Event Ticket](https://loby.io/rest-api/objects/event-ticket): Event Tickets grant admission to specific events. Track attendee information and check-in status.
- [Visit](https://loby.io/rest-api/objects/visit): A Visit represents a single entry to the venue. Visits are either ticket utilizations or customer checkins.
- [List Customers](https://loby.io/rest-api/endpoint-reference/customer/list): Retrieve a paginated list of customers. Filter by email, phone, membership status, and custom fields.
- [Get Customer](https://loby.io/rest-api/endpoint-reference/customer/get): Fetch a single customer by ID. Returns full customer details including memberships and purchase history.
- [Create Customer](https://loby.io/rest-api/endpoint-reference/customer/create): Create a new customer record. Set contact information, custom fields, and optional membership assignment.
- [Update Customer](https://loby.io/rest-api/endpoint-reference/customer/update): Update an existing customer's information. Modify contact details, custom fields, or membership associations.
- [Delete Customer](https://loby.io/rest-api/endpoint-reference/customer/delete): Permanently delete a customer record. This action cannot be undone and removes all associated data.
- [List Membership Types](https://loby.io/rest-api/endpoint-reference/membership-type/list): Retrieve all available membership types. Returns pricing, benefits, and configuration for each plan.
- [List Memberships](https://loby.io/rest-api/endpoint-reference/membership/list): Retrieve a paginated list of memberships. Filter by status, type, customer, or validity period.
- [Get Membership](https://loby.io/rest-api/endpoint-reference/membership/get): Fetch a single membership by ID. Returns full details including customer info and validity dates.
- [Create Membership](https://loby.io/rest-api/endpoint-reference/membership/create): Create a new membership for a customer. Assign membership type, set validity period, and configure benefits.
- [Update Membership](https://loby.io/rest-api/endpoint-reference/membership/update): Update an existing membership. Modify validity dates, status, or associated customer information.
- [Delete Membership](https://loby.io/rest-api/endpoint-reference/membership/delete): Delete a membership record. Consider updating status to cancelled instead of permanent deletion.
- [Send Emails](https://loby.io/rest-api/endpoint-reference/membership/send-emails): Trigger email notifications for memberships. Send welcome emails, renewal reminders, or custom communications.
- [List Ticket Types](https://loby.io/rest-api/endpoint-reference/ticket-type/list): Retrieve all available ticket types. Returns pricing, capacity, and availability for each admission category.
- [List Tickets](https://loby.io/rest-api/endpoint-reference/ticket/list): Retrieve a paginated list of tickets. Filter by date, type, customer, or check-in status.
- [Get Ticket](https://loby.io/rest-api/endpoint-reference/ticket/get): Fetch a single ticket by ID. Returns full ticket details including customer info and validity.
- [Create Ticket](https://loby.io/rest-api/endpoint-reference/ticket/create): Create a new ticket for admission. Assign ticket type, customer, and validity period.
- [Delete Ticket](https://loby.io/rest-api/endpoint-reference/ticket/delete): Delete a ticket record. Use for cancellations or refunds. This action cannot be undone.
- [Create Ticket Reservation](https://loby.io/rest-api/endpoint-reference/ticket-reservation/create): Reserve capacity temporarily before purchase. Set expiry time and convert to ticket upon payment.
- [Delete Ticket Reservation](https://loby.io/rest-api/endpoint-reference/ticket-reservation/delete): Cancel a ticket reservation. Releases held capacity back to availability.
- [List Locations](https://loby.io/rest-api/endpoint-reference/location/list): Retrieve all venue locations. Returns capacity limits, opening hours, and associated ticket types.
- [List Time Slots](https://loby.io/rest-api/endpoint-reference/time-slot/list): Retrieve available time slots. Filter by date, location, and remaining capacity.
- [List Transactions](https://loby.io/rest-api/endpoint-reference/transaction/list): Retrieve a paginated list of transactions. Filter by date, customer, payment method, or status.
- [List Events](https://loby.io/rest-api/endpoint-reference/event/list): Retrieve all events. Filter by date range, status, or location. Returns capacity and ticket availability.
- [Get Event](https://loby.io/rest-api/endpoint-reference/event/get): Fetch a single event by ID. Returns full event details including ticket types and current capacity.
- [List Event Ticket Types](https://loby.io/rest-api/endpoint-reference/event-ticket-type/list): Retrieve ticket types for a specific event. Returns pricing, availability, and capacity per type.
- [List Event Tickets](https://loby.io/rest-api/endpoint-reference/event-ticket/list): Retrieve tickets for a specific event. Filter by ticket type, customer, or check-in status.
- [Get Event Ticket](https://loby.io/rest-api/endpoint-reference/event-ticket/get): Fetch a single event ticket by ID. Returns attendee details, ticket type, and check-in status.
- [List Visits](https://loby.io/rest-api/endpoint-reference/visit/list): Retrieve a paginated list of visits. Filter by date, number of persons, or get all visits.

### Scanner Web Service

Build custom ticket scanning solutions. Receive scan events via webhooks and control scanner responses in real-time.

- [Overview](https://loby.io/scanner-web-service/getting-started/overview): Introduction to the Scanner Web Service. Learn how to build custom validation logic for ticket and membership scanning.
- [Authentication](https://loby.io/scanner-web-service/getting-started/authentication): Secure your scanner webhook endpoint. Verify request signatures to ensure scans come from Loby scanners.
- [Receive Scan](https://loby.io/scanner-web-service/api-reference/receive-scan): Handle incoming scan events from Loby scanners. Parse ticket data, customer info, and scan metadata.
- [Respond to Scan](https://loby.io/scanner-web-service/api-reference/respond-to-scan): Send response to control scanner behavior. Accept, reject, or show custom messages on the scanner display.

### JavaScript SDK

Embed Loby checkout flows in your website. Handle authentication, ticket purchases, and membership signups with our JavaScript SDK.

- [Overview](https://loby.io/javascript-sdk/getting-started/overview): Introduction to the Loby JavaScript SDK. Embed ticket purchases and membership signups directly in your website.
- [Installation](https://loby.io/javascript-sdk/getting-started/installation): Add the Loby SDK via CDN script tag. Includes on-demand loading on first checkout click.
- [Initialization](https://loby.io/javascript-sdk/getting-started/initialization): Configure and initialize the SDK with your client ID. Use waitForCheckoutReady before opening checkout.
- [Sign In](https://loby.io/javascript-sdk/authentication/sign-in): Authenticate users with email or phone. Enable passwordless login and remember returning customers.
- [Sign Out](https://loby.io/javascript-sdk/authentication/sign-out): End the current user session. Clear stored credentials and reset the checkout state.
- [Get User](https://loby.io/javascript-sdk/authentication/get-user): Retrieve the current authenticated user. Access customer details, memberships, and purchase history.
- [Memberships](https://loby.io/javascript-sdk/checkout/memberships): Embed membership signup and renewal flows. Display plans, handle payments, and activate memberships instantly.
- [Tickets](https://loby.io/javascript-sdk/checkout/tickets): Embed ticket purchase flows. Show availability, collect visitor info, and process payments seamlessly.
- [Events](https://loby.io/javascript-sdk/checkout/events): Embed event ticket purchases. Display event details, time slots, and handle event-specific checkout flows.
- [Event Listeners](https://loby.io/javascript-sdk/events/event-listeners): Listen for SDK events in your application. Handle checkout completion, errors, and user actions.
- [Language](https://loby.io/javascript-sdk/utilities/language): Configure SDK language and localization. Support multiple languages and customize text strings.

## API Reference

- Base URL: https://api.loby.io
- Version: v1
- Authentication: API Key via Authorization header

## Contact

For API support, visit https://loby.io