canonical: https://jentic.com/apis/ivvycode.com/ivvy # Ivvycode iVvy API The iVvy API provides programmatic access to iVvy's venue, events, and CRM products used by hotels, conference venues, and event teams to manage enquiries, bookings, and customer relationships. The 1.0.0 spec covers contact and event lookups, venue listings, and invoice retrieval. Authentication uses an X-API-Key header issued from the iVvy partner console. ## For AI agents Look up contacts, events, venues, and invoices in the iVvy hospitality and events platform. ## Scope Does not handle payment capture, room inventory, or property management - use for iVvy contact, event, venue, and invoice lookups only. ## Capabilities - Look up contact records and contact lists from the iVvy CRM - Retrieve event records including bookings, dates, and attached venue details - List venues across the iVvy marketplace and operator portfolio - Pull invoice lists for finance reconciliation against event bookings - Authenticate via the X-API-Key header for server-side integrations ## Use cases ### Hotel Sales CRM Sync Hotel sales teams running iVvy as their venue CRM mirror contacts and event records into a central data warehouse for analysis. The `/contact/getContactList` and `/event/getEventList` endpoints let an integration paginate through current records and feed downstream analytics or marketing automation without manual export. Example prompt: POST `/contact/getContactList` with a date filter and append the returned records to the warehouse contacts table ### Finance Reconciliation Finance teams reconcile event bookings against issued invoices at month end. The `/invoice/getInvoiceList` endpoint returns invoices in the period, which the team matches to `/event/getEvent` records to confirm that every confirmed booking was billed and that revenue is recognised against the correct property. Example prompt: POST `/invoice/getInvoiceList` for the previous month and join the result against `/event/getEvent` records by booking_id ### Venue Marketplace Aggregation Aggregator sites and concierge tools list venues across many iVvy operators. The `/venue/getVenueList` endpoint returns the venues an integration is authorised to surface, so the aggregator can refresh its directory and propagate availability changes back to bookers. Example prompt: POST `/venue/getVenueList` and update the aggregator's directory with the returned venue records ### AI Agent Event Lookup An AI assistant for a venue operator answers internal questions like 'what events are booked at the Sydney property next week?'. Through Jentic the agent searches for 'list iVvy events', loads the POST `/event/getEventList` schema, and executes against the iVvy API with the X-API-Key managed in your Jentic One instance. Example prompt: Search Jentic for 'list events for venue', execute POST `/event/getEventList` with the venue_id, and summarise the upcoming bookings ## Key endpoints | Method | Path | Description | | --- | --- | --- | | POST | `/contact/getContactList` | List contacts in the iVvy CRM | | POST | `/contact/getContact` | Retrieve a single contact by ID | | POST | `/event/getEventList` | List events filtered by date or venue | | POST | `/event/getEvent` | Retrieve a single event record | | POST | `/venue/getVenueList` | List venues accessible to the API key | | POST | `/invoice/getInvoiceList` | List invoices in a given period | ## Key resources - **Contacts** — CRM records for venue and event customers - **Events** — Bookings and event lookups across managed venues - **Venues** — Venue listings across the iVvy marketplace - **Invoices** — Billing records issued against event bookings ## Why Jentic - **Setup:** Wiring the iVvy API by hand means handling its API-key request header and the POST-style list and get operations yourself. Through Jentic you install once, import iVvy from the API Directory, store the key once, and your agent calls it. - **Permission scoping:** iVvy sends its lookup parameters in the request body, so scope by operation: limit the agent to the operations it needs, such as listing events or fetching a venue. You pick the allowed set, so it stays within contact, event, venue, and invoice lookups. - **Credential handling:** Your iVvy API key is stored once, encrypted, by your own Jentic One instance and injected into the request header at execution time. It never enters the agent's prompt, logs, or context. - **Discovery method:** Agents search Jentic by intent such as 'list iVvy events' or 'get a venue invoice', and Jentic returns the matching iVvy operation with its input schema so the agent calls the right endpoint without browsing the reference docs. ## Related APIs - **Calendly API** — Scheduling API for booking individual meetings alongside venue events - **Cloudbeds API** — Hospitality property management with overlapping booking workflows - **Mailchimp API** — Email marketing platform that consumes iVvy contact lists for nurture campaigns ## FAQ ### What authentication does the iVvy API use? iVvy uses an X-API-Key header issued from the partner console. Each key is scoped to a tenant and its accessible venues. Through Jentic the key is stored in the credential vault and added to outbound requests automatically. ### Can I list all events booked at a venue with the iVvy API? Yes. POST `/event/getEventList` accepts venue and date filters and returns the matching bookings. Combine it with POST `/event/getEvent` to fetch the full record for any event of interest. ### What are the rate limits for the iVvy API? iVvy does not publish numeric rate limits in the spec. They ask integrators to keep request volume reasonable, batch list calls, and contact partner support before running large historical syncs. ### How do I retrieve an event through Jentic? Search Jentic for 'get ivvy event', load the POST `/event/getEvent` schema, and execute with the event_id. Jentic injects the X-API-Key header so the agent only supplies the body parameters. ### Why are all iVvy endpoints POST requests? iVvy uses POST with a JSON body for both reads and writes so that filter and pagination parameters can be expressed as structured payloads rather than long query strings. Treat the getContactList, getEventList, and getVenueList calls as read operations even though the HTTP verb is POST. ### Can I limit what my agent is allowed to do with the iVvy API? Yes. Because you run Jentic One yourself, your own rules decide which iVvy operations and credentials the agent may use, so you can allow only the calls it needs. Since iVvy sends its lookup parameters in the request body, you scope by operation: grant just the ones the task requires, such as listing events with POST `/event/getEventList` or fetching a venue with POST `/venue/getVenueList.` You can keep the agent within contact, event, venue, and invoice lookups and withhold the rest, and the API key stays with your instance rather than the agent.